Jump to Content
API Reference
Developer ConsoleAPI Status Page

Issue credit note

post
https://api.wafeq.com/v1/zatca/simplified-credit-notes/issue/

Issues a simplified credit note and automatically queues reporting to ZATCA.

Uses the same payload and local validation rules as report. Returns 202 Accepted after saving the signed XML and QR code, without waiting for ZATCA. Use the returned document ID with the existing download endpoint (type=xml or type=pdf). PDF rendering runs on demand or in the background; it is not part of issuance latency.

Local validation does not mean ZATCA has accepted the document. Follow reporting using the document retrieval endpoint or webhooks. The signed XML and QR code remain unchanged during retries and stay downloadable if reporting is delayed or rejected. Sending through channels is queued after issuance and does not wait for successful reporting. Delivery retries preserve completed channels.

Available only for simplified documents. The existing report endpoint continues to wait for a ZATCA response.

Body Params

The payload to report a simplified credit note to ZATCA and optionally send it to its recipients.

channelsarray of objectslength ≤ 1

The channels to send the document

documentobjectrequired

The document data

stringenumDefaults to en

The language of the document

View the enum reference

Allowed:
metadataobject

The metadata of the document. Keys cannot contain . or start with $.

string

The reference of the document

templateobject

The template of the document

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.

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.

stringrequired

The zatca environment to use, available options are ['production', 'simulation']

Response

Updated 2 days ago