Sign in

v1

latestOpenAPI 3.1.12026-07-269084337.9 KB
Invoice

Bulk validate invoices

Validate multiple invoices without reporting them.

post/zatca/invoices/bulk-validate/

Query parameters

issue_datetime_afterstring date-time

Issue datetime

issue_datetime_beforestring date-time

Issue datetime

keywordstring

A search term (document_number, customer.name, customer.tax_registration_number, reference).

status'ERROR' | 'FAILED' | 'PENDING' | 'PROCESSING' | 'QUEUED' | 'REPORTED' | '__null__'

Status

  • ERROR - Error
  • FAILED - Failed
  • PENDING - Pending
  • PROCESSING - Processing
  • QUEUED - Queued
  • REPORTED - Reported
supply_date_afterstring date

Supply date

supply_date_beforestring date

Supply date

Headers

X-ZATCA-Branchstring

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used as a branch name

X-ZATCA-Connected-Account-Idstring

The unique identifier of the connected account you're operating on behalf of

X-ZATCA-Environmentstring required

The zatca environment to use, available options are ['production', 'simulation']

Request body

language'ar' | 'en'
  • ar - Arabic
  • en - English

Full information for LanguageEnum

metadataobject

The metadata of the document

referencestring

The reference of the document

Response

calculated_payable_amount_grossnumber double required

Calculated payable amount gross.

calculated_payable_amount_netnumber double required

Calculated payable amount net.

calculated_payable_amount_taxnumber double required

Calculated payable amount tax.

calculated_prepaid_amount_grossnumber double required

Calculated prepaid amount gross.

calculated_prepaid_amount_netnumber double required

Calculated prepaid amount net.

calculated_prepaid_amount_taxnumber double required

Calculated prepaid amount tax.

calculated_total_amount_grossnumber double required

Calculated total amount gross.

calculated_total_amount_netnumber double required

Calculated total amount net.

calculated_total_amount_taxnumber double required

Calculated total amount tax.

currencystring required

Currency of the document.

customerstring required

Customer name.

document_numberstring required

The document number.

issue_datetimestring date-time required

The issue datetime.

provided_tax_totalnumber double required

Total taxes.