Get the list of Invoice uuids

Fetches the list of all invoices and their uuids filtered by the search criteria specified.
The search is based on the values passed in the body parameters.


Request URI 

POST https://api.appzen.com/dictionary-data-services/
invoice/search


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


Body Parameters

Name

Type

Description

Required

appzen-invoice-status

String

Audit status assigned to invoice by Appzen.

 

erp-invoice-status

String

Invoice status from your System.

 

invoice-id

String

The invoice Id.

 

invoice-number

String

The invoice number.

 

supplier-id

String

The unique supplier id.

 

from-last-appzen-update-time

String

Start Date Range value for Appzen processing date specified in UTC format.
Example:2020-11-01T11:01:00Z

Yes

to-last-appzen-update-time

String

End Date Range for Appzen processing date specified in UTC format.

Example:2020-11-01T11:01:00Z

Yes


Sample Request

curl -X POST "https://api.appzen.com/dictionary-data-services/invoice/search" 
-H "accept: application/json"
-H "x-api-key: R7wsFxxxx" -H "customer-id: 1004xxxx" -H "customer-key: 15d1xxxx" -H "Content-Type: application/json" -d " { "appzen-invoice-status": "PROCESSED", "erp-invoice-status": "Pending Manager Review", "invoice-id": "string", "invoice-number": "string", "supplier-id": "string", "from-last-appzen-update-time": "2020-11-01T11:01:00Z", "to-last-appzen-update-time": "2020-11-01T11:01:00Z" }"


Sample Response

Success

[
  {
    "erp-invoice-id": "11069-Visit",
    "erp-invoice-status": "Ready for Review",
    "appzen-uuid": "57187384-2f9d-4f82-acac-555a264ba968",
    "appzen-invoice-status": "REJECTED",
    "last-appzen-update-time": "2021-06-16T18:53:38.603Z"
  },
  {
    "erp-invoice-id": "11070",
    "erp-invoice-status": "Ready for Review",
    "appzen-uuid": "cf3a63d3-3d26-4678-95ac-f3ed4cd8d9bf",
    "appzen-invoice-status": "PROCESSED",
    "last-appzen-update-time": "2021-06-16T18:54:00.487Z"
  }
]

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.

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

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.