Fetches the details of a processed invoice by uuid - the unique identifier for this invoice. The Details fetched include the risk level - LOW, MEDIUM, HIGH; state - Approved, Rejected; and so on.
Note the image download links are valid only for 5 minutes.
For calling the API, you will need the uuid.
Request URI
GET https://api.appzen.com/dictionary-data-services/invoice/processed-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 |
Globally unique identifier for an uploaded document |
Yes |
Sample Request
curl -X GET "https://api.appzen.com/dictionary-data-services/invoice/processed-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
{
"audit_results": {
"actions": {
"field_validations": [],
"header_validations": [
{
"action_type": "blocking",
"confidence": 1,
"final_risk": "NONE_RISK",
"post_config_risk": "NONE_RISK",
"post_feedback_risk": "NONE_RISK",
"result_data": {
"duplicate_invoice_ids": []
},
"risk_level": "NONE_RISK",
"risk_reason": "None",
"state": "Approved",
"validation_display_name": "Duplicate Invoices Check",
"validation_id": "duplicate_image_within_invoices",
"validation_name": "duplicate_image_within_invoices"
},
{
"action_type": "blocking",
"confidence": 1,
"final_risk": "NONE_RISK",
"post_config_risk": "NONE_RISK",
"post_feedback_risk": "NONE_RISK",
"result_data": [],
"risk_level": "NONE_RISK",
"risk_reason": "None",
"state": "Approved",
"validation_display_name": "Duplicate Invoice Across Expense",
"validation_id": "duplicate_across_expenses",
"validation_name": "duplicate_across_expenses"
},
{
"action_type": "blocking",
"confidence": 1,
"final_risk": "NONE_RISK",
"post_config_risk": "NONE_RISK",
"post_feedback_risk": "NONE_RISK",
"result_data": [],
"risk_level": "NONE_RISK",
"risk_reason": "None risk found.",
"state": "Approved",
"validation_display_name": "Supplier Check",
"validation_id": "supplier_check",
"validation_name": "supplier_check"
}
],
"line_validations": []
},
"appzen_invoice_id": "...",
"appzen_invoice_state": "Processed",
"customer_id": "..",
"uuid": "..."
},
"processed_invoice": {
"appzen_invoice_id": "015979ba-67a3-4607-a63c-42017af986d7",
"appzen_invoice_state": "Processed",
"customer_id": "..",
"currency": "USD",
"created_at": "2021-07-11T17:02:03Z",
"entity_name": "ERT Division",
"entity_id": "ERTDA-231",
"image_locations": [
{
"image_url": "https://...",
"link_expires_after": "2021-06-15T02:55:40.404Z"
}
],
"invoice_id": "...",
"invoice_date": "2021-07-01T00:00:00Z",
"invoice_lines": [
{
"appzen_line_number": 1,
"line_description": "....",
"line_number": 1,
"line_item_code": "vc-dfs",
"model_number": "...",
"purchase_order_number": "...",
"purchase_order_line_number": 2,
"gl_code": "8720.NA.Company.CD414.1802.NA.R4929.PG999.NA.PN1001.SUP384",
"quantity": 122,
"currency": "USD",
"tax_amount": {
"amount": 1.25,
"currency": "USD"
},
"total_amount": {
"amount": 120,
"currency": "USD"
},
"labels": [
"AB",
"PROTO"
],
"other_fields": {
"custom1": "Line"
},
"po_match_type": "PO_POLICY_THREE_WAY_MATCH",
"pre_paid": false,
"service_start_date": "2020-07-11T17:02:03Z",
"service_end_date": "2023-07-11T17:02:03Z",
"line_vat_amount": {
"amount": 1.5,
"currency": "USD"
},
"line_vat_breakdown": [
{
"code": "GST",
"rate": 20.5,
"vat_amount": {
"amount": 12.5,
"currency": "USD"
}
}
],
"unit_of_measure": "Each",
"unit_price": {
"amount": 1,
"currency": "USD"
},
"spend_category": {
"is_touchless": false,
"segment_index": 10,
"appzen_segment_type": "SPEND_CATEGORY_SEGMENT",
"appzen_segment_name_id": "",
"segment_name_id": "",
"segment_type": "Spend Category",
"appzen_segment_name": "",
"segment_name": "Supplies - Research & Lab work",
"appzen_segment_code": "",
"segment_code": "SUP384"
},
"cost_center": {
"is_touchless": false,
"segment_index": 3,
"appzen_segment_type": "COST_CENTER_SEGMENT",
"appzen_segment_name_id": "",
"segment_name_id": "",
"segment_type": "Cost Center",
"appzen_segment_name": "",
"segment_name": "Basic Sc Testing",
"appzen_segment_code": "",
"segment_code": "CD414"
},
"company": {
"is_touchless": false,
"segment_index": 2,
"appzen_segment_type": "COMPANY_SEGMENT",
"appzen_segment_name_id": "",
"segment_name_id": "",
"segment_type": "Company",
"appzen_segment_name": "",
"segment_name": "001 Georgetown University",
"appzen_segment_code": "",
"segment_code": "Georgetown"
},
"other_segments": [
{
"is_touchless": false,
"segment_index": 0,
"appzen_segment_type": "OTHER_SEGMENT",
"appzen_segment_name_id": "",
"segment_name_id": "",
"segment_type": "Assignee",
"appzen_segment_name": "",
"segment_name": "80720 Ostroumov, Alexey",
"appzen_segment_code": "",
"segment_code": "8720"
},
{
"is_touchless": false,
"segment_index": 1,
"appzen_segment_type": "OTHER_SEGMENT",
"appzen_segment_name_id": "",
"segment_name_id": "",
"segment_type": "Budget Code",
"appzen_segment_name": "",
"segment_name": "NA",
"appzen_segment_code": "",
"segment_code": "NA"
}
]
}
],
"invoice_number": "INC-32434",
"invoice_status": "Approved",
"last_updated_at": "2021-07-12T16:47:56Z",
"payment_term_id": "pt-1045",
"payment_term": {
"code": "NET",
"discounts": [
{
"discount_days": 4,
"discount_percent": 15,
"discount_amount": {
"amount": 10,
"currency": "USD"
}
}
],
"num_days": 30,
"source": "NET 30"
},
"po_policy": {
"po_backed": true,
"po_match_type": "PO_POLICY_THREE_WAY_MATCH"
},
"purchase_order_numbers": [
"12321XP"
],
"shipping_handling_amount": {
"amount": 2.5,
"currency": "USD"
},
"sub_total_amount": {
"amount": 120.65,
"currency": "USD"
},
"submitter": "Admin@mycompany.com",
"invoice_supplier_address": {
"address": {
"address_line1": "246 FENTON DR",
"city": "...",
"country": "US",
"state": "KS",
"zip": "20882"
},
"address_type": "REMIT_TO",
"site_id": "2687310"
},
"supplier_id": "XSR6310",
"supplier_name": "UDS LANDSCAPE",
"supplier_number": "6310",
"tax_amount": {
"amount": 0,
"currency": "USD"
},
"original_total_amount": {
"amount": 43.65,
"currency": "USD"
},
"other_fields": {
"custom_tag": "Sales"
},
"payment_due_date": "2022-07-31T00:00:00Z",
"total_amount": {
"amount": 122,
"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": [
"AX234SD",
"123DXSE_XDC"
],
"total_amount_excluding_vat": {
"amount": 113.25,
"currency": "USD"
}
}
}
Failure
The request fails if you enter an invalid URL.
{
"timestamp": "2019-01-17T16: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. |
| 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
Comments
Article is closed for comments.