---
title: "Usage"
method: GET
path: "/zatca/usage/"
tags: ["Usage"]
---

# Usage

`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`

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.

## Response `200`

- ApiZatcaUsageRead: How many ZATCA documents the organization can still report, and its current term allowance.
  - `available` integer, 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](zatcawalletbalanceenum)
  - `debt` integer, required: Documents reported while no credit was left; paid back from the next credits.
  - `enforced` boolean, required: Whether new submissions are refused once no documents are available.
  - `exempt` boolean, required: Whether the organization reports without using document credits.
  - `extras_available` integer, required: Extra documents granted for the current term still unused.
  - `included_available` integer, required: Documents included with the E-invoicing Platform yearly plan still unused.
  - `included_expires_ts` string, date-time, nullable, required: When the unused yearly plan documents expire; null when there are none.
  - `next_term_allowance` integer, nullable, required: Documents allowed in a renewed term that has not started yet; null when there is none.
  - `next_term_starts_ts` string, date-time, nullable, required: When the renewed term starts; null when there is none.
  - `packs_available` integer, required: Documents from purchased packs still unused.
  - `simulation` boolean, required: Whether the organization is set up for ZATCA's simulation environment, where documents are unlimited.
  - `term_allowance` integer, nullable, required: Documents the current contract term allows; null when no term allowance applies.
  - `term_consumed` integer, required: Documents of the current term that ZATCA accepted.
  - `term_ends_ts` string, date-time, nullable, required: When the current contract term ends; null when none applies.
  - `term_reserved` integer, required: Documents of the current term submitted and still waiting for ZATCA.
  - `term_starts_ts` string, date-time, nullable, required: When the current contract term started; null when none applies.

## Changes

- **2026-11-03** `6b4a622bbb4f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/wafeq/apis/wafeq-zatca-api/changes/zatca/usage/get.md)

---

[API](https://skmtc.dev/wafeq/apis/wafeq-zatca-api.md) - [All operations](https://skmtc.dev/wafeq/apis/wafeq-zatca-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wafeq/apis/wafeq-zatca-api/revisions/6b4a622bbb4f?raw)