Fetches the Audit Results of an 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.
For calling the API, you will need the uuid.
Request URI
GET https://api.appzen.com/dictionary-data-services/invoice/{{uuid}}/audit-results
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/75823296-4af2-4475-aafd-461c60c284e7/audit-results"
-H "accept: application/json"
-H "x-api-key: R7wsFxxxx"
-H "customer-id: 1004xxxx"
-H "customer-key: 15d1xxxx"
Sample Response
Success
{
"audit_results": {
"rules": [
{
"rule_code": "duplicate_invoice_amount",
"risk_message": "No duplicate detected",
"risk_results": {
"risk_level": "LOW"
}
}
],
"risk_level": "LOW",
"status": "Approved"
}
}
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.