iotoms Docs

Get US sales tax report

GET
/api/v1/reports/tax/americas/us-sales-tax

Returns US sales tax collected by state, with a county-level breakdown, for a from/to date range (YYYY-MM-DD, from not after to). Optionally limit to one stateCode. Sales with no state are left out and counted in warningCount. 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
stateCode?string

Optional 2-letter US state code filter

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?

US sales tax totals for the date range with a per-state and per-county breakdown.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/americas/us-sales-tax?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",    "stateFilter": "string",    "totalTaxableRevenue": 0,    "totalExemptRevenue": 0,    "totalTaxCollected": 0,    "transactionCount": 0,    "warningCount": 0,    "stateBreakdown": [      {        "stateCode": "string",        "stateName": "string",        "stateRate": 0,        "taxableRevenue": 0,        "exemptRevenue": 0,        "taxCollected": 0,        "transactionCount": 0,        "localBreakdown": [          {            "countyCode": "string",            "taxRate": 0,            "taxableRevenue": 0,            "taxCollected": 0          }        ]      }    ]  }}