Get Details of an Invoice
Fetches the details of an invoice by uuid - the unique identifier for this invoice .
For calling the API, you will need the uuid.
Request URI
GET https://api.appzen.com/dictionary-data-services/
invoice/{{uuid}}
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 |
|---|---|---|---|
| uuid | String | The unique identifier for an uploaded document. | Yes |
Sample Request
curl -X GET "https://api.appzen.com/dictionary-data-services/invoice/75823296-4af2-4475-aafd-461c60c284e7"
-H "accept: application/json"
-H "x-api-key: R7wsFxxxx"
-H "customer-id: 1004xxxx"
-H "customer-key: 15d1xxxx"
Sample Response
Success
{
"total_amount": {
"amount": 0,
"currency": "string"
},
"invoice_id": "string",
"invoice_status": "string",
"entity_id": "string",
"entity_name": "string",
"purchase_order_numbers": [
"12321XP"
],
"site_id": "string",
"invoice_number": "string",
"invoice_date": "2020-11-01",
"invoice_type": "INVOICE",
"original_invoice_id": "string",
"original_invoice_date": "2020-11-01",
"original_invoice_number": "string",
"payment_term_id": "string",
"remit_to_bank_info": {
"bank_acct_last4": "string",
"routing_number_last4": "string",
"bank_account_name": "string",
"bank_account_type": "string"
},
"requestor": "string",
"documents": [
{
"uuid": "string",
"image_url": "https://download-link.appzen.com/Staged_Documents/0102/5fc03087-d265-11e7-b8c6-83e29cd24f4c/AEMB7W..",
"link_expires_after": "2020-11-01T11:01:00Z"
}
],
"shipping_handling_amount": {
"amount": 1.5,
"currency": "USD"
},
"miscellaneous_charges": {
"amount": 1.5,
"currency": "USD"
},
"submission_date": "2020-11-01",
"submitter": "string",
"supplier_name": "string",
"supplier_number": "string",
"supplier_id": "string",
"tax_amount": {
"amount": 1.5,
"currency": "USD"
},
"vat_amount": {
"amount": 1.5,
"currency": "USD"
},
"vat_breakdown": [
{
"code": "GST",
"rate": 20.5,
"vat_amount": {
"amount": 1.5,
"currency": "USD"
}
}
],
"vat_registration_numbers": [
"string"
],
"total_amount_excluding_vat": {
"amount": 1.5,
"currency": "USD"
},
"supplier_address": {
"address_type": "string",
"address": {
"address_type": "REMIT_TO",
"address": {
"address_line1": "12345 MARKET STREET",
"address_line2": "SUITE 1234",
"address_line3": "",
"area_code": "415",
"city": "SAN FRANCISCO",
"company": "Preferred Supplier Inc.",
"contact": "Jane Doe",
"country": "US",
"country_iso3": "USA",
"email": "janedoe@supplier.com",
"phone": "4042965282",
"province": "",
"state": "CA",
"zip": "94016"
},
"site_id": "913838",
"site_name": "California HQ",
"custom_json": {
"key1": "value1"
},
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z"
}
},
"billing_address": {
"address_type": "string",
"address": {
"address_type": "REMIT_TO",
"address": {
"address_line1": "12345 MARKET STREET",
"address_line2": "SUITE 1234",
"address_line3": "",
"area_code": "415",
"city": "SAN FRANCISCO",
"company": "Preferred Supplier Inc.",
"contact": "Jane Doe",
"country": "US",
"country_iso3": "USA",
"email": "janedoe@supplier.com",
"phone": "4042965282",
"province": "",
"state": "CA",
"zip": "94016"
},
"site_id": "913838",
"site_name": "California HQ",
"custom_json": {
"key1": "value1"
},
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z"
}
},
"shipping_address": {
"address_type": "string",
"address": {
"address_type": "REMIT_TO",
"address": {
"address_line1": "12345 MARKET STREET",
"address_line2": "SUITE 1234",
"address_line3": "",
"area_code": "415",
"city": "SAN FRANCISCO",
"company": "Preferred Supplier Inc.",
"contact": "Jane Doe",
"country": "US",
"country_iso3": "USA",
"email": "janedoe@supplier.com",
"phone": "4042965282",
"province": "",
"state": "CA",
"zip": "94016"
},
"site_id": "913838",
"site_name": "California HQ",
"custom_json": {
"key1": "value1"
},
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z"
}
},
"remit_to_address": {
"address_type": "string",
"address": {
"address_type": "REMIT_TO",
"address": {
"address_line1": "12345 MARKET STREET",
"address_line2": "SUITE 1234",
"address_line3": "",
"area_code": "415",
"city": "SAN FRANCISCO",
"company": "Preferred Supplier Inc.",
"contact": "Jane Doe",
"country": "US",
"country_iso3": "USA",
"email": "janedoe@supplier.com",
"phone": "4042965282",
"province": "",
"state": "CA",
"zip": "94016"
},
"site_id": "913838",
"site_name": "California HQ",
"custom_json": {
"key1": "value1"
},
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z"
}
},
"other_addresses": [
[
null
]
],
"gl_code": "string",
"segments": [
{
"code": "string",
"name": "string",
"segment_type": "string",
"appzen_segment_type": "COST_CENTER_SEGMENT",
"segment_name_id": "string"
}
],
"invoice_description": "string",
"payment_date": "2020-11-01",
"invoice_lines": [
{
"line_number": 0,
"line_description": "string",
"quantity": 0,
"unit_price": {
"amount": 0,
"currency": "string"
},
"total_amount": {
"amount": 0,
"currency": "string"
},
"tax_amount": {
"amount": 0,
"currency": "string"
},
"line_vat_amount": {
"amount": 1.5,
"currency": "USD"
},
"line_vat_breakdown": [
{
"code": "GST",
"rate": 20.5,
"vat_amount": {
"amount": 1.5,
"currency": "USD"
}
}
],
"purchase_order_number": "string",
"purchase_order_line_number": "string",
"po_match_type": "PO_NONE_MATCH_TYPE",
"line_item_code": "string",
"unit_of_measure": "string",
"model_number": "string",
"currency": "string",
"gl_code": "string",
"segments": [
{
"code": "string",
"name": "string",
"segment_type": "string",
"appzen_segment_type": "COST_CENTER_SEGMENT",
"segment_name_id": "string"
}
],
"has_line_allocations": true,
"line_allocations": [
{
"external_allocation_id": "string",
"amount": 25.6,
"tax": 2.56,
"percentage": 35,
"gl_code": "string"
}
],
"custom_json": {}
}
],
"custom_json": {
"approval-code": "KE-382",
"category": "internal-projects"
}
}
Failure
The request fails if you enter invalid credentials.
{
"timestamp": "2019-01-17T16:12:45.977+0000",
"status": 401,
"error": "Unauthorized",
"message": "Error code : 17e3338d - Unable to authenticate credentials"
}
Response Code
| Response Code | Description |
| 200 | The request is successful. |
| 201 | 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. |
| 429 | The request failed as the available quota/limit has been consumed. |
See Also