Accounting · E-invoicing
ZATCA API Log
Every request this company sent to ZATCA’s Fatoora platform and what it answered — onboarding, compliance checks, clearance and reporting — with the one-time passwords, the secrets and the authorization header taken out before it was written. Append-only.
/api/accounting/zatca-api-logPublished as /api/v1/zatca-api-logOverview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › ZATCA API Log on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.zatca_api_log · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/zatca-api-logList zatca api log
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kind": "text",
"environment": "text",
"method": "text",
"url": "https://example.com",
"request_headers": {},
"request_body": {},
"http_status": 10,
"response_body": {},
"outcome": "text",
"error": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/zatca-api-log?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/zatca-api-log/{id}Read one zatca api log
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kind": "text",
"environment": "text",
"method": "text",
"url": "https://example.com",
"request_headers": {},
"request_body": {},
"http_status": 10,
"response_body": {},
"outcome": "text",
"error": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/zatca-api-log/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/zatca-api-logPost zatca api log
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/zatca-api-log" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/zatca-api-log/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/zatca-api-log/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/accounting/zatca-api-log/{id}Put zatca api log
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/zatca-api-log/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/zatca-api-log/{id}Delete zatca api log
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/zatca-api-log/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a zatca api log, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
unit_id | uuid | read only | Unit id |
invoice_id | uuid | read only | Invoice id |
kind | text | read only | Kind |
environment | text | read only | Environment |
method | text | read only | Method |
url | text | read only | Url |
request_headers | jsonb | read only | Request headers |
request_body | jsonb | read only | Request body |
http_status | integer | read only | Http status |
response_body | jsonb | read only | Response body |
outcome | text | read only | Outcome |
error | text | read only | Error |
duration_ms | integer | read only | Duration ms |
idempotency_key | text | read only | Idempotency key |
attempt | integer | read only | Attempt |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › ZATCA API Log for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.