iotoms Docs

Get Canada GST/HST return

GET
/api/v1/reports/tax/americas/ca-gst-hst

Returns the figures for a Canada GST/HST return (lines 101, 103, 105, 108 and 109) for a from/to date range, in CAD, with a provincial breakdown. Input tax credits are not tracked yet, so line 108 is 0. 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?

Canada GST/HST return lines for the date range with a provincial breakdown.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/americas/ca-gst-hst?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",    "line101TotalRevenue": 0,    "line103GstHstCollected": 0,    "line105TotalTaxOnSales": 0,    "line108InputTaxCredits": 0,    "line109NetTaxPayable": 0,    "transactionCount": 0,    "provincialBreakdown": [      {        "provinceCode": "string",        "provinceName": "string",        "taxType": "string",        "taxRate": 0,        "taxableRevenue": 0,        "taxCollected": 0,        "transactionCount": 0      }    ]  }}