iotoms Docs

List Saudi invoices pending ZATCA clearance

GET
/api/v1/reports/tax/middle-east/zatca-outstanding

Returns Saudi invoices in the period whose e-invoice clearance with ZATCA (the Saudi tax authority) is still pending or was rejected. from and to are required.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from*string

Period start (yyyy-MM-dd)

Formatdate
to*string

Period end (yyyy-MM-dd)

Formatdate

Header Parameters

X-TenantID*string

Tenant identifier

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?array<>|

One entry per Saudi sale in the period, whatever its ZATCA clearance status.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/middle-east/zatca-outstanding?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "transactionId": "string",      "invoiceNumber": "string",      "businessDate": "2019-08-24",      "zatcaUuid": "7b3ad33b-ce61-4ba9-9624-b0de213c8c61",      "zatcaClearanceStatus": "string",      "zatcaQrCode": "string",      "grandTotal": 0,      "vatAmount": 0,      "customerNumber": "string"    }  ]}