iotoms Docs

Get Mexico IVA return summary

GET
/api/v1/reports/tax/americas/mx-iva-return

Returns the Mexico IVA return summary for a from/to date range: taxable revenue, IVA collected (taxable revenue x IVA rate), creditable IVA (currently 0) and IVA payable, in MXN. Fails if the merchant has no federal tax ID set.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from*string

Start date (YYYY-MM-DD)

Formatdate
to*string

End date (YYYY-MM-DD)

Formatdate

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

Mexico IVA return figures for the date range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/americas/mx-iva-return?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "tenantId": "string",    "currency": "string",    "from": "2019-08-24",    "to": "2019-08-24",    "federalTaxId": "string",    "ivaRate": 0,    "taxableRevenue": 0,    "ivaCollected": 0,    "ivaCreditable": 0,    "ivaPayable": 0,    "transactionCount": 0  }}