Sales Tax API
Core Concepts
Corporations
Calculate
Transactions
Nexus
Registrations
Customers
Exemption Certificates
curl --request GET \
--url https://base_url/api/v1/nexus \
--header 'Authorization: Bearer <token>'{
"data": {
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"states": [
{
"state": "CA",
"nexus_rule": {
"threshold_type": "SALES_OR_TRANSACTIONS",
"evaluation_period_type": "PREV_CALENDAR_YEAR",
"includable_sales_type": "ALL_SALES",
"sales_threshold": 100000,
"transactions_threshold": 200
},
"calculation": {
"sales_exposure_percentage": 0.06,
"transaction_exposure_percentage": 0.1235,
"total_sales": 12345.9,
"total_transactions": 12,
"taxable_sales": 10000,
"taxable_transactions": 10,
"retail_sales": 8000,
"retail_transactions": 8,
"includable_sales_type": "TAXABLE_SALES"
},
"is_nexus_breached": true,
"date_of_breach": "2023-12-25"
}
]
},
"message": "Successfully fetched nexus."
}Get nexus
Get nexus status for one seller for all US states
curl --request GET \
--url https://base_url/api/v1/nexus \
--header 'Authorization: Bearer <token>'{
"data": {
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"states": [
{
"state": "CA",
"nexus_rule": {
"threshold_type": "SALES_OR_TRANSACTIONS",
"evaluation_period_type": "PREV_CALENDAR_YEAR",
"includable_sales_type": "ALL_SALES",
"sales_threshold": 100000,
"transactions_threshold": 200
},
"calculation": {
"sales_exposure_percentage": 0.06,
"transaction_exposure_percentage": 0.1235,
"total_sales": 12345.9,
"total_transactions": 12,
"taxable_sales": 10000,
"taxable_transactions": 10,
"retail_sales": 8000,
"retail_transactions": 8,
"includable_sales_type": "TAXABLE_SALES"
},
"is_nexus_breached": true,
"date_of_breach": "2023-12-25"
}
]
},
"message": "Successfully fetched nexus."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The unique identifier for a corporation. All transactions associated with the specified corporation will be returned.
Response
Nexus data for all states
Show child attributes
Show child attributes
The unique identifier for a corporation associated with this nexus details.
"b6d009b0-d174-463f-b030-94643c28e209"
Show child attributes
Show child attributes
2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.
"CA"
Show child attributes
Show child attributes
Specifies the criteria used by a state to calculate its economic nexus threshold, such as sales revenue or transaction count.
SALES_ONLY, SALES_OR_TRANSACTIONS, SALES_AND_TRANSACTIONS "SALES_OR_TRANSACTIONS"
Defines the time frame over which a state evaluates economic nexus, impacting which transactions count towards the threshold.
PREV_CALENDAR_YEAR, PREV_OR_CURRENT_CALENDAR_YEAR, PRECEDING_12_MONTHS, PRECEDING_FISCAL_YEAR, PRECEDING_12_MONTHS_ENDING_SEPT_30TH Indicates the type of sales included in the nexus calculation, such as all sales, taxable sales, or retail sales.
ALL_SALES, TAXABLE_SALES, RETAIL_SALES The maximum gross sales revenue a business can generate within a state before it must collect and remit sales tax. This threshold is a key determinant in establishing economic nexus.
100000
The maximum number of sales transactions a business can conduct within a state before it must collect and remit sales tax. This threshold helps determine economic nexus.
200
Show child attributes
Show child attributes
The percentage of the state's sales threshold that the business has reached during the current evaluation period for this state. This metric indicates how close a business is to reaching or exceeding the sales threshold for economic nexus in a given state.
0 <= x <= 10.06
The percentage of the state's transaction threshold that the business has reached during the current evaluation period for this state. This metric shows how close a business is to reaching or exceeding the transaction threshold for economic nexus in a given state.
0 <= x <= 10.1235
Total sales made by the customer in a state during the current evaluation period.
12345.9
Total number of transactions reported by the entity in a state during the current evaluation period.
12
Total taxable sales made by the customer in a state during the current evaluation period.
10000
Total number of taxable transactions reported by the entity in a state during the current evaluation period.
10
Total retail sales made by the customer in a state during the current evaluation period.
8000
Total number of retail transactions reported by the entity in a state during the current evaluation period.
8
The type of sales included in the nexus calculation.
"TAXABLE_SALES"
Indicates whether the nexus threshold has been breached.
The date when the nexus threshold was breached, if applicable.
"Successfully fetched nexus."