iotoms Docs

Get Canada provincial sales tax report

GET
/api/v1/reports/tax/americas/ca-pst

Returns one row per province for Canada sales in a from/to date range, in CAD: pre-tax sales, the sales tax recorded on them and the province's tax type and rate from the tax catalogue (PST, QST, RST and so on). The tax figure is the total sales tax on those sales; it is not split into federal and provincial parts. 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?array<>|

One row per province with Canadian sales in the date range, sorted by province code.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/americas/ca-pst?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "provinceCode": "string",      "provinceName": "string",      "taxType": "string",      "taxRate": 0,      "taxableRevenue": 0,      "taxCollected": 0,      "transactionCount": 0    }  ]}