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. Free text matches every word in the document number, customer name, customer tax number or reference (in any order, or in part when no document has every word), best matches first. To match one field exactly instead, 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>); values are case-insensitive.

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

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