Get the Audit Results

AppZen

Updated On: July 13, 2023 11:52

Fetches the Audit Results filtered by the search criteria specified. The results are filtered by the values passed in the body parameters such as supplier-id, invoice-number, invoice-id, uuid.
Note: The supplier-id and invoice-number are always used in tandem : (supplier-id, invoice-number). Otherwise, it will result in HTTP 400 error response.

The Details fetched include the risk level - LOW, MEDIUM, HIGH; state - Approved, Rejected; and so on.

Request URI

GET https://api.appzen.com/dictionary-data-services/invoice/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

Query Parameters

Name	Type	Description
uuid	string	Globally unique identifier for an invoice
invoice-number	string	The supplier’s invoice number
invoice-id	string	The external invoice id
supplier-id	string	The external supplier id

Sample Request

curl -X GET "https://api.appzen.com/dictionary-data-services/invoice/audit-results?uuid=testUUID&supplier-id=11"
-H "accept: application/json" 
-H "x-api-key: R7wsFxxxx" 
-H "customer-id: 1004xxxx" 
-H "customer-key: 15d1xxxx"

Sample Response

Success

[
  {
    "audit_results": {
      "uuid": "08edd8d9-cc1c-45e1-8bbb-29ffb7e3a404",
      "invoice-number": "MHEIN00051739",
      "invoice-id": "77887788",
      "supplier-id": "7082403",
      "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