WAwafeq
Debit Note

Send an existing debit note

Changed on

Send the debit note using specified channels.

post/zatca/debit-notes/{id}/send/

Request

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

Path parameters

idstring required

The unique identifier of the document.

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.

Request body

language'ar' | 'en'

The language of a document or response.

View the enum reference

metadataobject

The metadata of the document

referencestring

The reference of the document

Response

created_tsstring date-time required

The datetime in UTC when the document was created.

metadataobject required

The metadata of the document.

qr_code_datastring required

Base64 encoded QR code data.

referencestring required

The reference of the document.

reported_tsstring date-time nullable required

The datetime in UTC when the document was reported/cleared.

responseunknown required
sent_tsstring date-time nullable required

The datetime in UTC when the document was sent.

statusstring required

The status of the document.

Changes

  • 6b4a622bbb4fRevision changes
    • breaking

      added to the // request property allOf list

    • breaking

      added to the // request property allOf list

    • breaking

      added to the //////////// request property allOf list

    • breaking

      added to the //////////// request property allOf list

    • breaking

      removed the enum value email of the request property //

    • breaking

      the // request property type changed from object to no type

    • breaking

      the // request property type changed from string to no type

    • breaking

      the //////////// request property type changed from object to no type

    • breaking

      the //////////// request property type changed from object to no type

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property /////////////

    • warning

      removed the request property /////////////

    • warning

      removed the request property /////////////

    • warning

      removed the request property /////////////

    • info

      the header request parameter X-ZATCA-Environment became optional