iotoms Docs

Get VAT return summary

GET
/api/v1/reports/tax/middle-east/vat-return

Returns the VAT return figures for the period in the layout used by the chosen GCC country, such as the UAE VAT 201 form. countryCode (AE, SA, BH or OM), from and to are required, and the merchant must have a VAT registration number. Input tax boxes are currently 0; see Get input VAT on purchases.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

countryCode*string

GCC country code: AE, SA, BH, OM

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?

The VAT return figures for the country and period.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/middle-east/vat-return?countryCode=string&from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "tenantId": "string",    "countryCode": "string",    "currency": "string",    "from": "2019-08-24",    "to": "2019-08-24",    "vatRegistrationNumber": "string",    "box1StandardRatedSupplies": 0,    "box1VatOnStandardRated": 0,    "box2ZeroRatedSupplies": 0,    "box3ExemptSupplies": 0,    "box4OutOfScopeSupplies": 0,    "box5TotalOutputTax": 0,    "box9TaxableExpenses": 0,    "box10InputTaxRecoverable": 0,    "box11NetVatPayable": 0,    "transactionCount": 0  }}