To synchronize an invoice in your System and well the AppZen System. This updates the invoice in both the systems. For calling the API, you will need the uuid.
Request URI
POST https://api.appzen.com/dictionary-data-services/
invoice/{{uuid}}/status-sync
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-state |
String |
Audit status assigned to the invoice by Appzen. |
No |
|
invoice-status |
String |
Invoice status in your System. |
No |
|
invoice-id |
String |
The invoice id of an invoice. |
No |
Sample Request
curl -X POST "https://api.appzen.com/dictionary-data-services/invoice/75823296-4af2-4475-aafd-461c60c284e7/status-sync"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "x-api-key: R7wsFGLmxZ8Gko8ODwivE3Rmnv1zzuPe4s4ZfQ4R"
-H "customer-id: 100439"
-H "customer-key: 15d165f255eb18dadf7e85085573bbb852e7ef057e8b96f33faec77aa65c2d1f"
-d
"{
"invoice_id": "string",
"invoice_status": "string",
"appzen_invoice_state": "CREATED",
"timestamp": "2020-11-01T11:01:00Z",
"error_data": {
"message": "string",
"status": "string",
"exception": "string"
}
}"
Sample Response
Success
Status Code: 200 [with empty response]/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
Comments
Article is closed for comments.