Debit Note

Status summary of debit notes

Changed on

Summary of debit notes per status

get/zatca/debit-notes/summary/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/zatca/debit-notes/summary/
  • Auth
    API key in header Authorization

Query parameters

issue_datetime_afterstring date-time

Issue datetime

issue_datetime_beforestring date-time

Issue datetime

keywordstring

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>).

status'ERROR' | 'FAILED' | 'PENDING' | 'PROCESSING' | 'QUEUED' | 'REPORTED' | '__null__'
  • ERROR - ERROR
  • FAILED - FAILED
  • PENDING - PENDING
  • PROCESSING - PROCESSING
  • QUEUED - QUEUED
  • REPORTED - REPORTED
  • __null__ - 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.

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.

X-ZATCA-Environmentstring

The ZATCA environment to use, one of ['production', 'simulation']. A ZATCA API key (starting with zatca_live_ or zatca_sim_) already names its environment, so the header is optional with it and must match it when sent. Other API keys and OAuth tokens need it.

Response

Changes

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the header request parameter X-ZATCA-Environment became optional

    • info

      added to the response property allOf list for the response status