iotoms Docs

Get US economic nexus status

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

Returns the economic nexus status of each US state with sales in a from/to date range: registered (merchant holds a state tax ID), threshold exceeded, approaching (80% of a threshold) or below threshold. 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 entry per US state that had sales in the date range, sorted by state code.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/americas/us-nexus?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "stateCode": "string",      "stateName": "string",      "revenue": 0,      "transactionCount": 0,      "nexusThresholdAmount": 0,      "nexusThresholdTransactions": 0,      "status": "REGISTERED"    }  ]}