Validate a credit note

post

https://api.wafeq.com/v1/zatca/credit-notes/validate/

Validates a single credit note without reporting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

channels

array of objects

length ≤ 1

The channels to send the document

channels

document

object

required

The document data

language

string

enum

Defaults to en

The language of the document

View the enum reference

Allowed:

metadata

object

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

reference

string

The reference of the document

template

object

The template of the document

Headers

X-ZATCA-Branch

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

X-ZATCA-Connected-Account-Id

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.

X-ZATCA-Environment

string

required

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

Response

200