List invoices

Lists all invoices.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time

Issue datetime

date-time

Issue datetime

string

Search the documents by an exact value: the whole search must equal the document number, customer name, customer tax number, reference or any metadata value, ignoring case (INV-123 finds inv-123, never INV-1234). To match one field only, write document.id:<value>, document.customer.name:<value>, document.customer.tax_registration_number:<value>, reference:<value> or metadata.<key>:<value> (quote a metadata key that contains a colon: metadata."<key>":<value>).

integer

A page number within the paginated result set.

integer

Number of results to return per page.

string
enum

Status

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

Supply date

date

Supply date

Headers
string

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

string

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

Connected accounts should be used only for Platforms and White Label integrations that onboard customers and report documents on their behalf. Omit the X-ZATCA-Connected-Account-Id header when registering devices or reporting documents for your own organization. See the Platforms and White Label guide.

string
required

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

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json