JSON (VAT IN URL)

If you cannot provide an XML document as input you can provide the required document information via a JSON input. We have constructed a schema which supports the requirements to generate all the document types acceptable by ZATCA. We provide the following to test out JSON schema using the inputs you will be providing.

• Redoc UI to view each parameter of the JSON input in detail

• Swagger UI to test out the payload with the test API

• Postman Collection if you want to run via the postman app

Here are some samples for each document.

• Standard Invoice

• Standard Debit Note

• Standard Credit Note

• Standard Prepayment

• Standard Invoice with Prepayment

• Simplified Invoice

• Simplified Debit Note

• Simplified Credit Note

• Simplified Prepayment

• Simplified Invoice with Prepayment

Request Method

POST

Request Path

{{API_URL}}/api/v2/ksa_einvoice/online_service/<VAT_NUM>/generate_einvoice/

NOTE: VAT_NUM is the vat number of your organization that you have onboarded in our website. For eg if you have onboarded vat number 399975588700003 then the full path would be

{{API_URL}}/api/v2/ksa_einvoice/online_service/399975588700003/generate_einvoice/

Request Headers

Parameter	Value	Description
Productid	einvoicing_global	Keep as is
Service	online_service	Keep as is
Authorization/MiplApiKey	api_key/auth token	Value and header type is mentioned in the Authentication Page

Request Body

Refer to the sample documents for inputs

The response for the API can be found here.