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
Create registration
Allows customers to inform the system about states where they are already registered for sales tax.
curl --request POST \
--url https://base_url/api/v1/registrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"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>"
}
}
}
},
"registered_at": "2023-12-25"
}'
{
"data": {
"id": "ec6d3db8-fd31-4303-8687-3ff98fb10ebf",
"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>"
}
}
}
},
"registered_at": "2023-12-25",
"validation_status": "PENDING",
"filing_status": "FILING",
"registration_status": "REGISTRATION_IN_PROGRESS",
"business_activity_status": "VALID",
"registration_type": "SALES_TAX_REGISTRATION"
},
"message": "Successfully created registration."
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The unique identifier for a corporation.
"2535af08-a139-4d0c-9827-1651e46dfbcf"
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."
Once a merchant is registered in a state for sales tax, they need to pay the collected tax to the state government. This payment happens at a fixed interval. The interval is generally decided by the state government and differ from state to state as well as for each merchant.
ANNUAL_CALENDAR_YEAR
, QUARTERLY
, MONTHLY
, ANNUAL_FISCAL_YEAR_START_JULY
, SEMI_ANNUALLY
, QUARTERLY_PREPAY_MONTHLY
, ANNUAL_FISCAL_YEAR_MARCH
, BIMONTHLY
The unique identifier assigned to the merchant by the state government during registration.
Merchant's username for the state sales tax portal.
Merchant's password for the state sales tax portal.
Some sales tax state portal require a pin to access them. If the state requires it, this will need to be passed before validating this registration.
Some state like Texas provides a webfile number that is required by Commenda to perform accurate filings.
ISO 8601 date only string, identifying the date when the state registration occurred.
Response
The unique identifier of the corporation associated with this registration.
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."
ISO 8601 date only string, identifying the date when the state registration occurred.
Reflects whether Commenda has validated the seller's registration details.
PENDING
, VALIDATION_IN_PROGRESS
, INVALID
, VALID
Reflects the current stage of the registration process.
REGISTRATION_IN_PROGRESS
, REGISTERED
Reflects whether the registration is active and the business is operating in a given State.
VALID
, INVALID
, PENDING
, VALIDATION_IN_PROGRESS
Type of registration. Request additional types from the Commenda team as required.
SALES_TAX_REGISTRATION
The unique identifier for the registration.
"ec6d3db8-fd31-4303-8687-3ff98fb10ebf"
Indicates whether Commenda is automatically filing taxes for this tax registration.
FILING
, NOT_FILING
"Successfully created registration."
curl --request POST \
--url https://base_url/api/v1/registrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"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>"
}
}
}
},
"registered_at": "2023-12-25"
}'
{
"data": {
"id": "ec6d3db8-fd31-4303-8687-3ff98fb10ebf",
"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>"
}
}
}
},
"registered_at": "2023-12-25",
"validation_status": "PENDING",
"filing_status": "FILING",
"registration_status": "REGISTRATION_IN_PROGRESS",
"business_activity_status": "VALID",
"registration_type": "SALES_TAX_REGISTRATION"
},
"message": "Successfully created registration."
}