Sales Tax API
Core Concepts
Corporations
Calculate
Transactions
Nexus
Registrations
Customers
Exemption Certificates
curl --request GET \
--url https://base_url/api/v1/filings \
--header 'Authorization: Bearer <token>'{
"data": {
"filings": [
{
"id": "<string>",
"corporation_id": "<string>",
"country": "US",
"country_specific_details": {
"legal_name": "Example Inc.",
"state": "CA",
"state_specific_details": {
"payment_interval": "<string>",
"sales_tax_id": "<string>",
"username": "<string>",
"password": "<string>",
"pin": "<string>",
"web_file_number": "<string>",
"tax_types": [
"RSST"
]
}
},
"frequency": "MONTHLY",
"period_start_date": "2023-12-25",
"due_date": "2023-12-25",
"filing_status": "PENDING",
"filed_on": "2023-12-25",
"registration_id": "<string>",
"total_tax_filed": 135.92,
"payment_details": {
"amount_due": 123,
"payment_status": "PENDING",
"failure_details": {
"failed_at": "2023-12-25",
"reason": "<string>"
}
}
}
],
"cursor": "<string>"
},
"message": "Successfully fetched filings."
}List filings
List state and local sales tax filings for a corporation, filtered by query.
curl --request GET \
--url https://base_url/api/v1/filings \
--header 'Authorization: Bearer <token>'{
"data": {
"filings": [
{
"id": "<string>",
"corporation_id": "<string>",
"country": "US",
"country_specific_details": {
"legal_name": "Example Inc.",
"state": "CA",
"state_specific_details": {
"payment_interval": "<string>",
"sales_tax_id": "<string>",
"username": "<string>",
"password": "<string>",
"pin": "<string>",
"web_file_number": "<string>",
"tax_types": [
"RSST"
]
}
},
"frequency": "MONTHLY",
"period_start_date": "2023-12-25",
"due_date": "2023-12-25",
"filing_status": "PENDING",
"filed_on": "2023-12-25",
"registration_id": "<string>",
"total_tax_filed": 135.92,
"payment_details": {
"amount_due": 123,
"payment_status": "PENDING",
"failure_details": {
"failed_at": "2023-12-25",
"reason": "<string>"
}
}
}
],
"cursor": "<string>"
},
"message": "Successfully fetched filings."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The unique identifier of the corporation for which to retrieve data.
Cursor for pagination
Number of items to return per page
1 <= x <= 100Response
Filing info for all states
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The unique identifier for the filing.
The unique identifier for a corporation associated with this filing.
ISO 3166 2-letter country code. Ex: US, IN, GB.
"US"
Show child attributes
Show child attributes
The legal name of the entity being registered.
"Example Inc."
2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.
"CA"
Show child attributes
Show child attributes
Payment interval for sales tax.
Sales tax ID.
Username for tax filing.
Password for tax filing.
PIN for tax filing.
Web file number for tax filing.
Enum representing different types of taxes applicable in various jurisdictions.
RSST, RST, RUT, SSUT, GRT, VUT, RTPT, TPT, DTT, RDF, SUT, GET, ROT, CUT, RSSUT, BAO Filing frequency refers to how often a business is required to submit its sales tax returns, which is typically determined by the state based on the business's sales volume and tax liability.
MONTHLY, QUARTERLY, ANNUALLY, SEMI_ANNUALLY ISO 8601 date string, identifying the start date of the period period for which the sales tax is being filed (e.g., '2024-09-01' for September 2024). For a quarter 1 filing where the fiscal year starts in March, the period_start_date will be 2024-03-01 and frequency will be QUARTERLY.
ISO 8601 date string, identifying the date when by which the filing must be submitted.
Current status of the filing.
PENDING, FILED Date when the taxes were filed with the state, in ISO 8601 format.
The unique identifier for the tax registration associated with this filing.
Total amount of sales tax filed with various jurisdictions for this period. May differ slightly from the total tax collected.
135.92
Show child attributes
Show child attributes
Total amount due for this filing.
Status of the payment.
PENDING, COMPLETED, FAILED This object will be populated if the payment fails for any reason.
Pagination cursor for the next set of results
"Successfully fetched filings."