API Reference

Download an credit note

get
https://api.wafeq.com/v1/zatca/simplified-credit-notes//download/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the document.

Query Params
boolean
Defaults to false

If true, the document will be regenerated before download

string
enum
length ≥ 1
Defaults to pdf

The type of the download format

  • pdf - Portable Document Format (PDF) format
  • xml - Extensible Markup Language (XML) format
Allowed:
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

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?