WAwafeq
Credit Note

Validate a credit note

Changed on

Validates a single credit note without reporting.

post/zatca/credit-notes/validate/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/zatca/credit-notes/validate/
  • Auth
    API key in header Authorization

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. Keys cannot contain . or start with $.

referencestring

The reference of the document

Response

calculated_payable_amount_grossnumber double required

Calculated payable amount gross.

calculated_payable_amount_netnumber double required

Calculated payable amount net.

calculated_payable_amount_taxnumber double required

Calculated payable amount tax.

calculated_prepaid_amount_grossnumber double required

Calculated prepaid amount gross.

calculated_prepaid_amount_netnumber double required

Calculated prepaid amount net.

calculated_prepaid_amount_taxnumber double required

Calculated prepaid amount tax.

calculated_total_amount_grossnumber double required

Calculated total amount gross.

calculated_total_amount_netnumber double required

Calculated total amount net.

calculated_total_amount_taxnumber double required

Calculated total amount tax.

currencystring required

Currency of the document.

customerstring required

The customer name; an empty string means no name was collected for a simplified document.

document_numberstring required

The document number.

issue_datetimestring date-time required

The issue datetime.

provided_tax_totalnumber double required

Total taxes.

Changes