TRANXACT.AI Help

Accounting · E-invoicing

ZATCA Onboarding

Each signing unit taken through ZATCA’s onboarding: choose the environment (the Developer Portal sandbox, simulation, or production), enter the one-time password from the Fatoora portal, run the compliance checks (one sample of each document the unit issues), then request the production certificate. Renew before the certificate expires — a warning is raised 30 days ahead. The keys and ZATCA’s secrets are sealed and never shown. Register the unit itself under ZATCA Signing Units first.

Type REST12 operationsBase path /api/accounting/zatca-onboardingPublished as /api/v1/zatca-onboarding

Download specification (OpenAPI 3.1) Screen: ZATCA Onboarding

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › ZATCA Onboarding 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.
Tableacct.zatca_egs_units · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

12 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/zatca-onboardingList zatca onboarding

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "branch_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "common_name": "Example",
      "egs_serial": "text",
      "organization_unit": "text",
      "invoice_types": "text",
      "location": "text",
      "industry": "text",
      "environment": "text",
      "status": "draft",
      "is_default": true,
      "is_test": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/zatca-onboarding?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/zatca-onboarding/{id}Read one signing unit

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "branch_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "common_name": "Example",
  "egs_serial": "text",
  "organization_unit": "text",
  "invoice_types": "text",
  "location": "text",
  "industry": "text",
  "environment": "text",
  "status": "draft",
  "is_default": true,
  "is_test": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/zatca-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/zatca-onboarding/{id}/startStart

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

environment, otp

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-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"environment":"value","otp":"value"}'
POST/api/accounting/zatca-onboarding/{id}/compliance-checksCompliance checks

Path parameters

NameTypeDescription
idstring (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 POST "https://demo.tranxact.ai/api/accounting/zatca-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/compliance-checks" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/zatca-onboarding/{id}/productionProduction

Path parameters

NameTypeDescription
idstring (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 POST "https://demo.tranxact.ai/api/accounting/zatca-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/production" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/zatca-onboarding/{id}/renewRenew

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

otp

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-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/renew" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"otp":"value"}'
GET/api/accounting/zatca-onboarding/{id}/checksChecks

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/zatca-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/checks" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/zatca-onboarding/{id}/logLog

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/zatca-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/log" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/zatca-onboardingPost zatca onboarding

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-onboarding" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/zatca-onboarding/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (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, withLines

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-onboarding/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-onboarding/{id}Put zatca onboarding

Path parameters

NameTypeDescription
idstring (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-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/zatca-onboarding/{id}Delete zatca onboarding

Path parameters

NameTypeDescription
idstring (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-onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a signing unit, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
branch_unit_iduuidread onlyBranch unit id
codetextread onlyCode
nametextread onlyName
common_nametextread onlyCommon name
egs_serialtextread onlyEgs serial
organization_unittextread onlyOrganization unit
invoice_typestextread onlyInvoice types
locationtextread onlyLocation
industrytextread onlyIndustry
environmenttextread onlyEnvironment
statustextread onlyStatus
is_defaultbooleanread onlyIs default
is_testbooleanread onlyIs test
public_key_derbytearead onlyPublic key der
csrtextread onlyCsr
certificatetextread onlyCertificate
certificate_serialtextread onlyCertificate serial
certificate_issuertextread onlyCertificate issuer
certificate_expires_attimestamp with time zoneread onlyCertificate expires at
compliance_csidtextread onlyCompliance csid
compliance_request_idtextread onlyCompliance request id
production_csidtextread onlyProduction csid
production_csid_expires_attimestamp with time zoneread onlyProduction csid expires at
onboarded_attimestamp with time zoneread onlyOnboarded at
last_icvbigintread onlyLast icv
last_hashtextread onlyLast hash
last_invoice_iduuidread onlyLast invoice id
last_stamped_attimestamp with time zoneread onlyLast stamped at
notestextread onlyNotes
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by
org_unit_iduuidread onlyOrg unit id
onboarding_steptextread onlyOnboarding step
onboarding_step_attimestamp with time zoneread onlyOnboarding step at
onboarding_messagetextread onlyOnboarding message
compliance_passed_attimestamp with time zoneread onlyCompliance passed at
production_request_idtextread onlyProduction request id
pending_public_key_derbytearead onlyPending public key der
pending_csrtextread onlyPending csr
renewed_attimestamp with time zoneread onlyRenewed at
certificate_is_samplebooleanread onlyCertificate is sample
expiry_warned_ondateread onlyExpiry warned on
clearance_off_seen_attimestamp with time zoneread onlyClearance off seen at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › ZATCA Onboarding for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.