iotoms Docs

Get zero-rated and exempt supplies

GET
/api/v1/reports/tax/middle-east/zero-exempt

Lists zero-rated and VAT-exempt sales in the period for a GCC country. countryCode (AE, SA, BH or OM), from and to are required.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

countryCode*string

GCC country code

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 sale invoice in the period and country.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/middle-east/zero-exempt?countryCode=string&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",      "customerNumber": "string",      "customerVatRegistrationNumber": "string",      "taxJurisdiction": "string",      "supplyType": "string",      "subtotal": 0,      "vatRate": 0,      "vatAmount": 0,      "grandTotal": 0,      "currency": "string",      "zatcaUuid": "7b3ad33b-ce61-4ba9-9624-b0de213c8c61",      "zatcaClearanceStatus": "string"    }  ]}