iotoms Docs

Get US tax-exempt sales report

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

Returns US tax-exempt sales in a from/to date range, newest first, with the customer's exemption certificate number and issuing state. 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<>|

US tax-exempt sales in the date range, newest business date first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/tax/americas/us-exempt?from=2019-08-24&to=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",      "invoiceNumber": "string",      "businessDate": "2019-08-24",      "customerNumber": "string",      "customerName": "string",      "exemptionNumber": "string",      "exemptionState": "string",      "revenue": 0    }  ]}