Fetches the details of a Purchase Order by the Purchase Order Number.
For calling the API, you will need the po-number.
Request URI
GET https://api.appzen.com/dictionary-data-services/purchase-order/
purchase-order-number/{{po-number}}
Header Parameters
Name | Type | Description | Required |
---|---|---|---|
x-api-key | String | The x-api-key provided to authorize the request. | Yes |
customer-id | String | The Customer ID provided to authorize the request. | Yes |
customer-key | String | The Customer Key provided to authorize the request. | Yes |
Path Parameters
Name | Type | Description | Required |
---|---|---|---|
po-number |
String |
The purchase order number from your System. |
Yes |
Sample Request
curl -X GET "https://api.appzen.com/dictionary-data-services/purchase-order/purchase-order-number/erpPO1"
-H "accept: application/json"
-H "x-api-key: R7wsFxxxx"
-H "customer-id: 1004xxxx"
-H "customer-key: 15d1xxxx"
Sample Response
Success
{
"purchase_order_number": "193-994K",
"entity_id": "1002",
"entity_name": "Acme Inc",
"supplier_id": "3009293",
"gl_code": "1002.369.922.0000.0000",
"payment_term_id": "8900012",
"comments": "Buying whiteboards for office",
"exchange_rate": {
"conversion_rate": 0,
"from_currency_code": "",
"to_currency_code": ""
},
"start_date": "2020-11-01",
"end_date": "2020-11-01",
"total_amount": {
"amount": 1.5,
"currency": "USD"
},
"amount_limit": {
"amount": 1.5,
"currency": "USD"
},
"min_release_amount": {
"amount": 1.5,
"currency": "USD"
},
"email_address": "john.doe@acme.org",
"purchase_requisition_id": null,
"purchase_order_type": "string",
"purchase_order_status": "Issued",
"appzen_purchase_order_status": "PO_ISSUED",
"ship_to_location": "string",
"ship_to_location_id": "string",
"requester": "string",
"custom_json": {},
"purchase_order_lines": [
{
"po_line_id": "string",
"line_number": 0,
"gl_code": "string",
"line_item_code": "string",
"line_description": "string",
"quantity": 0,
"unit_price": {
"amount": 1.5,
"currency": "USD"
},
"amount": {
"amount": 1.5,
"currency": "USD"
},
"line_vat_amount": {
"amount": 1.5,
"currency": "USD"
},
"line_vat_breakdown": [
{
"code": "GST",
"rate": 20.5,
"vat_amount": {
"amount": 1.5,
"currency": "USD"
}
}
],
"contractor_name": "string",
"contractor_start_date": "2020-11-01",
"closed_flag": true,
"closed_by": "string",
"closed_date": "2020-11-01",
"closed_reason": "string",
"cancel_flag": true,
"cancel_date": "2020-11-01",
"cancel_reason": "string",
"taxable_flag": true,
"tax_code_id": "string",
"tax_name": "string",
"type_1099": "string",
"committed_amount": {
"amount": 1.5,
"currency": "USD"
},
"amount_limit": {
"amount": 1.5,
"currency": "USD"
},
"unit_list_price": {
"amount": 1.5,
"currency": "USD"
},
"base_list_price": {
"amount": 1.5,
"currency": "USD"
},
"uninvoiced_amount": {
"amount": 1.5,
"currency": "USD"
},
"received_amount": {
"amount": 1.5,
"currency": "USD"
},
"progress_payment_rate": 0,
"item_category": "string",
"item_category_id": "string",
"hazard_class_id": "string",
"unit_of_measure": "string",
"committed_quantity": 0,
"ordered_quantity": 0,
"received_quantity": 0,
"service_line_start_date": "2020-11-01",
"service_line_end_date": "2020-11-01",
"match_basis": "NONE_MATCH_BASIS",
"match_type": "PO_NONE_MATCH_TYPE",
"line_type": "NONE_LINE_TYPE",
"purchase_order_line_status": "string",
"appzen_purchase_order_line_status": "string",
"purchase_requisition_id": "string",
"buyer": "string",
"custom_json": {}
}
]
}
Failure
The request fails if you enter an invalid URL.
{
"timestamp": "2023-01-15T16:12:45.977+0000",
"status": 404,
"error": "Not Found",
"message": "Error code : 17e3338d - The resource you specified cannot be not found"
}
Response Code
Response Code | Description |
200 | The request is successful. |
400 |
The request failed due to a malformed request syntax. Check the requested URL, including the parameters. |
401 |
The request failed due to an authorization issue. For example, the Customer Key could be missing or invalid. |
403 |
The request failed due to a permission issue. The x-api key may not have permission to perform the request. |
404 |
The request failed as the resource is not found. Check the requested URL. |
500 |
The request failed due to an AppZen server issue. |
See Also
Comments
Article is closed for comments.