Generate E-Invoice via XML
Last updated
Was this helpful?
Last updated
Was this helpful?
Generate a valid E-Invoice with an XML file and send it to ZATCA for clearance or reporting.
POST
Rate Limit : 1000 API requests per minute
x-cleartax-auth-token
String
Cannot be empty.
vat
String
Cannot be empty
Mandatory. VAT or Group VAT of the entity.
branch
String
Should be a valid branch from the user account.
Optional. Branch name (store name) added in the user account which maps to a VAT or Group VAT of the entity.
accept-language
String
Enum: ar, en
Optional. Language of error message from ZATCA.
ar - Arabic
en - English
Default: en.
device-id
String
MaxLength: 36
There are no path parameters for this API.
There are no query parameters for this API.
file
form-data
NA
Mandatory.
UUID
Optional. Will be generated by ClearTax if not sent in input.
Optional. Will be generated by ClearTax if not sent in input.
ICV
Read Only. Will be ignored if sent in input.
Read Only. Will be ignored if sent in input.
PIH
Read Only. Will be ignored if sent in input.
Read Only. Will be ignored if sent in input.
InvoiceHash
Read Only. Will be ignored if sent in input.
Read Only. Will be ignored if sent in input.
Signature
Read Only. Will be ignored if sent in input.
Read Only. Will be ignored if sent in input.
RawQRCode
Read Only. Will be ignored if sent in input.
Read Only. Will be ignored if sent in input.
InvoiceXml
NA. Not available in the input schema.
NA. Not available in the input schema. The XML received will be enhanced before sending to ZATCA.
The use case where generation CSID (at customer side) and reporting CSID (at ClearTax side) is different, is not supported at the moment.
Standard Tax Invoice XML-
Simplified Tax Invoice XML-
This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.
Each customer is allowed to send a limited number of requests per minute to prevent server overload. If the limit is exceeded, the server will respond with a 429 Too Many Requests status code.
If the auth token is valid, but the user does not have the authorization to generate device ID, then the API will return HTTP Status Code 403. The user, whose auth token is used, should have an Admin role for the particular VAT used in the request.
Mandatory. .
Mandatory. The Device ID registered with ClearTax. Refer to ?
Same as . Refer to the corresponding section.
Same as . Refer to the corresponding section.
Same as . Refer to the corresponding section.
Same as . Refer to the corresponding section.