v1
latestOpenAPI 3.1.12026-07-269084337.9 KBInvoice
Status summary of invoices
Summary of invoices per status
get/zatca/invoices/summary/
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']