Sales Tax API
Core Concepts
Corporations
Calculate
Transactions
- Tax Transactions
- POSTCreate a transaction
- GETGet transaction
- GETList transactions
- DELDelete transaction
- Refund Transactions
- Bulk Transaction Import
Nexus
Registrations
Products
Customers
Exemption Certificates
Get one filing
Retrieve one filing by its id
curl --request GET \
--url https://base_url/api/v1/filings/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"corporation_id": "<string>",
"country": "US",
"country_options": {
"US": {
"state": "CA",
"legal_name": "Example Inc.",
"state_options": {
"CA": {
"payment_interval": "ANNUAL_CALENDAR_YEAR",
"sales_tax_id": "<string>",
"username": "<string>",
"password": "<string>",
"pin": "<string>",
"web_file_number": "<string>"
}
}
}
},
"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,
"sales_details": {
"total_sales": 12345.91,
"taxable_sales": 12345.91,
"sales_tax_collected": 771.62
},
"payment_details": {
"amount_due": 771.62,
"payment_status": "PENDING",
"failure_details": {
"failed_at": "<string>",
"reason": "<string>"
}
}
},
"message": "Successfully fetched filing."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the transaction to fetch.
Response
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"
2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX. This can't be changed once set.
"CA"
The legal name of the entity being registered.
"Example Inc."
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
Total sales amount for the filing period.
12345.91
Total sales amount that was subject to sales tax for the filing period.
12345.91
Total sales tax collected during the period.
771.62
Total amount due for this filing.
771.62
Status of the payment.
PENDING, COMPLETED, FAILED "Successfully fetched filing."
curl --request GET \
--url https://base_url/api/v1/filings/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"corporation_id": "<string>",
"country": "US",
"country_options": {
"US": {
"state": "CA",
"legal_name": "Example Inc.",
"state_options": {
"CA": {
"payment_interval": "ANNUAL_CALENDAR_YEAR",
"sales_tax_id": "<string>",
"username": "<string>",
"password": "<string>",
"pin": "<string>",
"web_file_number": "<string>"
}
}
}
},
"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,
"sales_details": {
"total_sales": 12345.91,
"taxable_sales": 12345.91,
"sales_tax_collected": 771.62
},
"payment_details": {
"amount_due": 771.62,
"payment_status": "PENDING",
"failure_details": {
"failed_at": "<string>",
"reason": "<string>"
}
}
},
"message": "Successfully fetched filing."
}