Generate E-Invoice Async
Generate a valid E-Invoice with JSON payload synchronously and send it to ZATCA for reporting asynchronously.
This API can be used only for Simplified Tax Invoices and related notes (B2C).
Request Method
POST
Request URL
Replace the {{BASE_URL}}
with the one mentioned here based on whether you are using sandbox or production.
Rate Limit : 1000 API requests per minute
Request Headers
x-cleartax-auth-token
String
Cannot be empty
Mandatory. User auth token.
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.
Request Path Params
There are no path parameters for this API.
Request Query Params
There are no query parameters for this API.
Request Body
DeviceId
String
MaxLength: 36
Mandatory. The Device ID registered with ClearTax.
EInvoice
Object
Not null
CustomFields
Object
NA
Optional. Custom Fields object
Custom Fields Object This is a custom object of key-value pairs that can be used to display custom fields in custom output PDF templates or in certain reports. For example:
Requirement of Critical Fields
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 generating CSID (at customer side) and reporting CSID (at ClearTax side) is different, is not supported at the moment.
Sample Request
Response Status Codes
202
For successfully acceptance from CT
400
For any cleartax validation error
400
Validation error from zatca
401
If the user is not authenticated for the operation
403
If the user is not authorized for the operation
429
Too Many Requests
Response Schema
DeviceId
String
MaxLength: 36
Optional. Device ID used to generate invoices.
Status
String
Enum: GENERATED, NOT_GENERATED, GENERATION_FAILED, IN_PROGRESS
Mandatory.
Status of E-Invoice QR Code. This is the same as QrCodeStatus below. Provided only for backward compatibility for Phase I API.
IN_PROGRESS, NOT_GENERATED, GENERATION_FAILED
QrCodeStatus
String
Enum: GENERATED, NOT_GENERATED, GENERATION_FAILED
Mandatory.
Status of E-Invoice QR Code.
GENERATED, NOT_GENERATED, GENERATION_FAILED
InvoiceStatus
String
Enum: PENDING, FAILED.
Mandatory.
Status of submission to ZATCA.
QRCode
String
Optional. Rendered QR Code image in base64 encoded PNG format.
If validations fail, this will be null.
RawQRCode
String
Optional. QR Code payload in base64 encoded TLV format.
InvoiceXml
String
Optional. It is the XML used for reporting.
UUID
String
Optional. UUID sent to ZATCA
ClearTax generates this before sending to ZATCA, if not sent in input.
ICV
String
Optional. Invoice counter value sent to ZATCA ClearTax generates this before sending it to ZATCA.
PIH
String
Optional. Previous hash value, Invoice hash value of previous invoice reported for same deviceId.
InvoiceHash
String
Optional. Current invoice hash.
InvoiceType
String
Enum: INV, CRN, DBN
Mandatory.
Document Type: INV-INVOICE, CRN-CREDIT NOTE, DBN-DEBIT NOTE.
InvoiceNumber
String
Can not be null
Mandatory. Invoice number (ID) as per the input.
IssueDate
String
Can not be null
Mandatory. Issue Date as per the input.
IssueTime
String
Format: HH:mm:ss (24 hr format)
Mandatory. Invoice issue time. The time when the invoice was issued.
GeneratedDate
String
Cannot be null
Mandatory. Date on which the invoice is generated
GeneratedTime
String
Format: HH:mm:ss (24 hr format)
Mandatory. Invoice generation time. The time when the invoice is generated.
SellerVatNumber
String
Can not be null
Mandatory. Seller VAT identification number.
BuyerVatNumber
String
Can not be null
Optional. Buyer VAT identification number.
ErrorList
Array<Error Detail>
Can be empty
Optional. Validation errors.
Error Details Object
ErrorCode
String
Cannot be null
A code to identify the error. Error codes are published above.
ErrorMessage
String
Cannot be null
Human readable error message.
ErrorSource
String
CLEARTAX
Source of the error.
Path
String
-
If it is a validation error of a request data, it will point to the request data field. Example below.
Sample Response
Success for Simplified Document - HTTP Status Code - 200
Error from ClearTax - HTTP Status Code - 400
Error from ZATCA - HTTP Status Code - 200 (Sample Simplified invoice where QR code is generated by ClearTax and then sent to ZATCA for reporting which is not approved by ZATCA).
Note: In case a document is validated by ClearTax but failed at ZATCA, then the HTTP Status Code will be 200 and not 400.
API Validations
API validations will remain the same as in Phase I. In addition, the following new validations are added for Phase II.
Other Seller ID is Mandatory.
Other Buyer ID is Mandatory.
Payment type code is Mandatory.
The document issue date must be less than or equal to the current date.
Buyer name is mandatory for Simplified Tax Invoice and associated credit/debit notes.
DEC-20=[BR-DEC-20] - The allowed maximum number of decimals for the VAT category tax amount (BT-117) is 2.
BR-DEC-13=[BR-DEC-13] - The allowed maximum number of decimals for the Invoice total VAT amount (BT-110) is 2.
BR-DEC-15=[BR-DEC-15] - The allowed maximum number of decimals for the Invoice total VAT amount in accounting currency (BT-111) is 2.
API Constraints
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. If the auth token is valid, but the user does not have the authorization to generate einvoice , then the API will return HTTP Status Code 403.
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.
Async API is for simplified tax invoices only as for standard tax invoices ZATCA generates the QR code and signs it realtime. Error message in case standard tax invoices are sent via this API - "Async API call is only supported for Reporting simplified tax invoices. For standard invoices use the Generate e-Invoice API."
Last updated