WAwafeq
Usage

Usage

Changed on

Endpoint for retrieving how many documents the organization can still report to ZATCA production, and the allowance of its current contract term. Submissions beyond the available documents are refused with 402.

get/zatca/usage/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/zatca/usage/
  • Auth
    API key in header Authorization

Response

availableinteger required

Documents the organization can still submit to ZATCA now.

balance'LOW' | 'OK' | 'OUT' required

How close the organization is to running out of ZATCA documents.

View the enum reference

debtinteger required

Documents reported while no credit was left; paid back from the next credits.

enforcedboolean required

Whether new submissions are refused once no documents are available.

exemptboolean required

Whether the organization reports without using document credits.

extras_availableinteger required

Extra documents granted for the current term still unused.

included_availableinteger required

Documents included with the E-invoicing Platform yearly plan still unused.

included_expires_tsstring date-time nullable required

When the unused yearly plan documents expire; null when there are none.

next_term_allowanceinteger nullable required

Documents allowed in a renewed term that has not started yet; null when there is none.

next_term_starts_tsstring date-time nullable required

When the renewed term starts; null when there is none.

packs_availableinteger required

Documents from purchased packs still unused.

simulationboolean required

Whether the organization is set up for ZATCA's simulation environment, where documents are unlimited.

term_allowanceinteger nullable required

Documents the current contract term allows; null when no term allowance applies.

term_consumedinteger required

Documents of the current term that ZATCA accepted.

term_ends_tsstring date-time nullable required

When the current contract term ends; null when none applies.

term_reservedinteger required

Documents of the current term submitted and still waiting for ZATCA.

term_starts_tsstring date-time nullable required

When the current contract term started; null when none applies.

Changes