WAwafeq
Simplified Credit Note

Download an credit note

Changed on

Downloads a single credit note.

Simplified documents created with issue or bulk-issue can be downloaded before reporting completes. The XML and the XML embedded in the PDF are the original signed document, and the PDF uses its QR code. PDFs are generated on demand when necessary. Other documents must be reported or cleared before downloading.

get/zatca/simplified-credit-notes/{id}/download/

Request

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

Path parameters

idstring required

The unique identifier of the document.

Query parameters

regenerateboolean

If true, the document will be regenerated before download

type'pdf' | 'xml'
  • pdf - pdf
  • xml - xml

The type of the download format

  • pdf - Portable Document Format (PDF) format
  • xml - Extensible Markup Language (XML) format

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

string binary required

Changes