Simplified Credit Note

Bulk validate credit notes

Changed on Nov 3, 2026

Validate multiple credit notes without reporting them.

post/zatca/simplified-credit-notes/bulk-validate/

Request

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

Query parameters

issue_datetime_afterstring date-time

Issue datetime

issue_datetime_beforestring date-time

Issue datetime

keywordstring

Search the documents by an exact value: the whole search must equal the document number, customer name, customer tax number, reference or any metadata value, ignoring case (INV-123 finds inv-123, never INV-1234). To match one field only, write document.id:<value>, document.customer.name:<value>, document.customer.tax_registration_number:<value>, reference:<value> or metadata.<key>:<value> (quote a metadata key that contains a colon: metadata."<key>":<value>).

ERROR - ERROR
FAILED - FAILED
PENDING - PENDING
PROCESSING - PROCESSING
QUEUED - QUEUED
REPORTED - REPORTED
__null__ - null

Status

ERROR - Error
FAILED - Failed
PENDING - Pending
PROCESSING - Processing
QUEUED - Queued
REPORTED - Reported

supply_date_afterstring date

Supply date

supply_date_beforestring date

Supply date

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

Nov 3, 20266b4a622bbb4f Revision changes
- breaking
  added to the //////// request property allOf list
- breaking
  added to the ////////// request property allOf list
- breaking
  added to the //////////////// request property allOf list
- breaking
  added to the //////// request property allOf list
- breaking
  added to the ////////// request property allOf list
- breaking
  added to the /// request property allOf list
- breaking
  added to the /////////// request property allOf list
- breaking
  added to the //////////////// request property allOf list
- breaking
  added to the ///////////// request property allOf list
- breaking
  added to the ///////////// request property allOf list
- breaking
  added to the ///////////// request property allOf list
- breaking
  added to the ///////////// request property allOf list
- breaking
  added to the /// request property allOf list
- breaking
  added to the /////////// request property allOf list
- breaking
  added to the /////////// request property allOf list
- breaking
  added to the ///////////// request property allOf list
- breaking
  added to the ///////////// request property allOf list
- breaking
  removed the enum value email of the request property ///
- breaking
  the /// request property type changed from object to no type
- breaking
  the /// request property type changed from string to no type
- breaking
  the ///////////// request property type changed from object to no type
- breaking
  the ///////////// request property type changed from object to no type
- warning
  removed from the //////////////// request property allOf list
- warning
  removed from the //////////////// request property allOf list
- warning
  removed from the ///////////// request property allOf list
- warning
  removed from the ///////////// request property allOf list
- warning
  removed from the ///////////// request property allOf list
- warning
  removed from the ///////////// request property allOf list
- warning
  removed from the /////////// request property allOf list
- warning
  removed from the //////// request property allOf list
- warning
  removed from the ////////// request property allOf list
- warning
  removed from the //////// request property allOf list
- warning
  removed from the ////////// request property allOf list
- warning
  removed from the /////////// request property allOf list
- warning
  removed from the /////////// request property allOf list
- warning
  the /////////// request property's maxLength was set to 1000
- warning
  the ////// request property's maxLength was set to 127
- warning
  the //////// request property's maxLength was set to 1000
- warning
  the //////// request property's maxLength was set to 127
- warning
  the ////// request property's maxLength was set to 1000
- warning
  the /////////// request property's maxLength was set to 127
- warning
  the /////////// request property's maxLength was set to 1000
- warning
  the /////////// request property's maxLength was set to 1000
- warning
  the /////////// request property's maxLength was set to 1000
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property ////
- warning
  removed the request property //////////////
- warning
  removed the request property //////////////
- warning
  removed the request property //////////////
- warning
  removed the request property //////////////
- info
  added the new optional request property ////////
- info
  added the new optional request property /////////////
- info
  added the new optional request property //////
- info
  added the new optional request property /////////////
- info
  added the new optional request property //////
- info
  added the new optional request property //////////
- info
  added the new optional request property ////////
- info
  added the new optional request property /////////////
- info
  added the new optional request property /////////////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  the header request parameter X-ZATCA-Environment became optional
- info
  the request property /////////// became optional
- info
  the request property default value was added
- info
  the request property default value changed from 0 to 0E-10
- info
  added the new VATEX-SA-32(bis) enum value to the request property /////////////////
- info
  added the new VATEX-SA-32(bis) enum value to the request property /////////////////
- info
  added the new VATEX-SA-32(bis) enum value to the request property /////////////////
- info
  added the new VATEX-SA-32(bis) enum value to the request property /////////////////
- info
  added the new VATEX-SA-DIPLOMAT enum value to the request property /////////////////
- info
  added the new VATEX-SA-DIPLOMAT enum value to the request property /////////////////
- info
  added the new VATEX-SA-DIPLOMAT enum value to the request property /////////////////
- info
  added the new VATEX-SA-DIPLOMAT enum value to the request property /////////////////
- info
  added the new VATEX-SA-DUTYFREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-DUTYFREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-DUTYFREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-DUTYFREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-ROYALDECREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-ROYALDECREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-ROYALDECREE enum value to the request property /////////////////
- info
  added the new VATEX-SA-ROYALDECREE enum value to the request property /////////////////
- info
  the ////// request property's maxLength was increased from 100 to 5000

Operation history