post
https://apistaging.taxizer.com/v1/Invoices/GenerateInvoiceFromXml
Send a Standard valid signed E-Invoice XML file to ZATCA for clearance or reporting
Request Body Params
| Parameter | Data Type | Field Validations | Description |
|---|---|---|---|
| uuid | string | Mandatory, should be uniqe | A unique identifier for the invoice. |
| deviceId | string | Mandatory | The deviceID registered with in our servers. |
| invoiceNumber | string | Mandatory | -. |
| signedXmlInvoice | string | Mandatory | encoded base64 of the xml invoice |
Example Request
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"deviceId": "8f14e45f-e10c-4fc9-8f0b-e10e8b1e8e7f",
"invoiceNumber": "INV-10001",
"signedXmlInvoice": "PHhtbD48aW52b2ljZT5FeGFtcGxlIEludm9pY2UgQ29udGVudDwvaW52b2ljZT48L3htbD4="
}
Response Example
{
"status": "completed",
"warningMessages": [],
"errorMessages": [],
"qrCode": "{qrCode}",
"signedInvoice": "",
"invoiceHash": "",
"invoiceCounter": 2
}
Response Params
| Parameter | Data Type | Description |
|---|---|---|
| status | string | status of the invoice reporting process. either "failed" or "completed" |
| warningMessages | list of warningMessage | when the invoice receives an "Accepted with Warnings" status from ZATCA, a list of warnings will be provided detailing the issues identified |
| errorMessages | list of errorMessage. | when the invoice status "failed" you will get list of errorMessages. |
| qrCode | string. | Rendered QR code image in base64 encoded PNG format. |
| signedInvoice | string. | Encoded XML invoice submitted to ZATCA. |
| invoiceHash | string. | unique hash that indicates the specific sequence of that invoice within the device's transaction log |
| invoiceCounter | integer. | The total number of invoices generated from that specific device |
warningMessage and ErrorMessage Object
| Parameter | Data Type | Description |
|---|---|---|
| type | string | The type of issue encountered |
| code | string | A code identifying the specific issue |
| category | string | The general category of the issue |
| message | string | A brief explanation of the issue |
| status | string | The current status of the issue |