csharp
java
javascript
php
python
ruby
typescript

tax

/tax

Retrieve tax methods

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers

Retrieves tax methods for this account.

Parameters
Parameter Description Location Data Type Required
_limit The maximum number of records to return on this one API call. (Max 200)
Default: 100
query integer optional
_offset Pagination of the record set. Offset is a zero based index.
Default: 0
query integer optional
_expand The object expansion to perform on the result. See documentation for examples query string optional
Responses
Status Code Reason Response Model
200
Successful response TaxProvidersResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve the Avalara tax provider

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/avalara

Retrieves the Avalara tax provider.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderAvalara
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update the Avalara tax provider

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/avalara

Update the Avalara tax provider.

Parameters
Parameter Description Location Data Type Required
tax_provider_avalara TaxProviderAvalara object body TaxProviderAvalara required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderAvalara
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Returns Avalara Tax companies configured by the merchant

Permissions:
  • tax_read

Produces: application/json
post
/tax/providers/avalara/companies

Returns Avalara Tax companies configured by the merchant

Parameters
Parameter Description Location Data Type Required
tax_provider_avalara TaxProviderAvalara object body TaxProviderAvalara required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderAvalaraCompaniesResult
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Attempts to connect to Avalara and returns back the response

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/avalara/test

Attempts to connect to Avalara and returns back the response.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderTestResult
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve the Self tax provider

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/self

Retrieves the Self tax provider.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderSelf
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update the Self tax provider

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/self

Update the Self tax provider.

Parameters
Parameter Description Location Data Type Required
tax_provider_self TaxProviderSelf object body TaxProviderSelf required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderSelf
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Deletes a Self tax provider city

Permissions:
  • tax_write

Produces: application/json
delete
/tax/providers/self/city/{city}

Deletes a Self tax provider city.

Parameters
Parameter Description Location Data Type Required
city The city being deleted. path string required
tax_city tax city to be deleted body TaxCity required
Responses
Status Code Reason Response Model
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates a Self tax provider city

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/self/city/{city}

Updates a Self tax provider city.

Parameters
Parameter Description Location Data Type Required
city The city being updated. path string required
tax_city tax city to be updated body TaxCity required
Responses
Status Code Reason Response Model
200
Successful response TaxCity
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve the Self tax provider countries

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/self/countries

Retrieves the Self tax provider countries.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderSelfCountriesResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Deletes a Self tax provider country

Permissions:
  • tax_write

Produces: application/json
delete
/tax/providers/self/country/{countryCode}

Deletes a Self tax provider country.

Parameters
Parameter Description Location Data Type Required
countryCode The country code being deleted. path string required
tax_country tax country to be deleted body TaxCountry required
Responses
Status Code Reason Response Model
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates a Self tax provider country

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/self/country/{countryCode}

Updates a Self tax provider country.

Parameters
Parameter Description Location Data Type Required
countryCode The country code being updated. path string required
tax_country tax country to be updated body TaxCountry required
Responses
Status Code Reason Response Model
200
Successful response TaxCountry
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Deletes a Self tax provider county

Permissions:
  • tax_write

Produces: application/json
delete
/tax/providers/self/county/{county}

Deletes a Self tax provider county.

Parameters
Parameter Description Location Data Type Required
county The county being deleted. path string required
tax_county tax county to be deleted body TaxCounty required
Responses
Status Code Reason Response Model
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates a Self tax provider county

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/self/county/{county}

Updates a Self tax provider county.

Parameters
Parameter Description Location Data Type Required
county The county being updated. path string required
tax_county tax county to be updated body TaxCounty required
Responses
Status Code Reason Response Model
200
Successful response TaxCounty
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Deletes a Self tax provider postalCode

Permissions:
  • tax_write

Produces: application/json
delete
/tax/providers/self/postalCode/{postal_code}

Deletes a Self tax provider postalCode.

Parameters
Parameter Description Location Data Type Required
postal_code The postal code being deleted. path string required
tax_postal_code tax postal code to be deleted body TaxPostalCode required
Responses
Status Code Reason Response Model
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates a Self tax provider postalCode

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/self/postalCode/{postal_code}

Updates a Self tax provider postalCode.

Parameters
Parameter Description Location Data Type Required
postal_code The postal code being updated. path string required
tax_postal_code tax postal code to be updated body TaxPostalCode required
Responses
Status Code Reason Response Model
200
Successful response TaxPostalCode
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve the Self tax provider regions for a given country code

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/self/regions/{countryCode}

Retrieves the Self tax provider regions for a given country code.

Parameters
Parameter Description Location Data Type Required
countryCode The country code regions desired. path string required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderSelfRegionsResponse
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Deletes a Self tax provider state

Permissions:
  • tax_write

Produces: application/json
delete
/tax/providers/self/state/{stateCode}

Deletes a Self tax provider state.

Parameters
Parameter Description Location Data Type Required
stateCode The state code being deleted. path string required
tax_state tax state to be deleted body TaxState required
Responses
Status Code Reason Response Model
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Updates a Self tax provider state

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/self/state/{stateCode}

Updates a Self tax provider state.

Parameters
Parameter Description Location Data Type Required
stateCode The state code being updated. path string required
tax_state tax state to be updated body TaxState required
Responses
Status Code Reason Response Model
200
Successful response TaxState
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Toggle a tax provider to active

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/setActive/{providerName}

Toggle a tax provider to active.

Parameters
Parameter Description Location Data Type Required
providerName The tax provider to set active. path string required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderActivateResult
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve the TaxJar tax provider

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/taxjar

Retrieves the TaxJar tax provider.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderTaxJar
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update the TaxJar tax provider

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/taxjar

Update the TaxJar tax provider.

Parameters
Parameter Description Location Data Type Required
tax_provider_taxJar TaxProviderTaxJar object body TaxProviderTaxJar required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderTaxJar
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Attempts to connect to TaxJar and returns back the response

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/taxjar/test

Attempts to connect to TaxJar and returns back the response.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderTestResult
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Retrieve the UltraCart tax provider

Permissions:
  • tax_read

Produces: application/json
get
/tax/providers/ultracart

Retrieves the UltraCart tax provider.

Responses
Status Code Reason Response Model
200
Successful response TaxProviderUltraCart
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

Update the UltraCart tax provider

Permissions:
  • tax_write

Produces: application/json
post
/tax/providers/ultracart

Update the UltraCart tax provider.

Parameters
Parameter Description Location Data Type Required
tax_provider_ultracart TaxProviderUltraCart object body TaxProviderUltraCart required
Responses
Status Code Reason Response Model
200
Successful response TaxProviderUltraCart
400
Bad Request 400
401
Unauthorized 401
410
Authorized Application Disabled 410
429
Too Many Requests 429
500
Server Side 500

AvalaraConfig

Attributes
Name Data Type Description
account_id string Avalara account ID
active boolean True if Avalara is active for this merchant
avalara_oid integer (int32) Unique identifier for this avalara config object
company_id string Avalara company ID
enable_upc boolean True if this Avalara configuration is set to enable tax valuation by UPC
estimate_only boolean True if this Avalara configuration is to estimate taxes only and not report placed orders to Avalara
guest_customer_code string Optional customer code for customers without profiles, defaults to GuestCustomer
last_test_dts (read only) string (dateTime) Date/time of the connection test to Avalara
license_key string Avalara license key
sandbox boolean True if this Avalara instance is pointed at the Avalara Sandbox
service_url string Avalara service URL
test_results string Test results of the last connection test to Avalara

Error

Attributes
Name Data Type Description
developer_message string A technical message meant to be read by a developer
error_code string HTTP status code
more_info string Additional information often a link to additional documentation
user_message string An end-user friendly message suitable for display to the customer

ErrorResponse

Attributes
Name Data Type Description
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
success boolean Indicates if API call was successful

ResponseMetadata

Attributes
Name Data Type Description
payload_name string Payload name
result_set ResultSet Result set

ResultSet

Attributes
Name Data Type Description
count integer (int32) Number of results in this set
limit integer (int32) Maximum number of results that can be returned in a set
more boolean True if there are more results to query
next_offset integer (int32) The next offset that you should query to retrieve more results
offset integer (int32) Offset of this result set (zero based)
total_records integer (int32) The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.

TaxCity

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
city string City
city_oid (read only) integer (int32) Tax record object identifier used internally by database
county_oid (read only) integer (int32) Tax record object identifier used internally by database
dont_collect_city boolean Flag instructing engine to not collect city tax for this city
dont_collect_postal_code boolean Flag instructing engine to not collect postal code tax for this city
postal_codes array of TaxPostalCode Postal Codes within this city
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted

TaxCountry

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
country_code string Country code (2 characters
country_oid (read only) integer (int32) Tax record object identifier used internally by database
states array of TaxState States (or regions or territories) within this country
tax_gift_charge boolean True if taxation within this jurisdiction should charge tax on gift charge
tax_gift_wrap boolean True if taxation within this jurisdiction should charge tax on gift wrap
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted
tax_shipping boolean True if taxation within this jurisdiction should charge tax on shipping

TaxCountryCode

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
country_code string Country code (2 characters
country_name string Country name
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted

TaxCounty

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
cities array of TaxCity Cities within this city
county string County
county_oid (read only) integer (int32) Tax record object identifier used internally by database
dont_collect_city boolean Flag instructing engine to not collect city tax for this county
dont_collect_county boolean Flag instructing engine to not collect county tax for this county
dont_collect_postal_code boolean Flag instructing engine to not collect postal code tax for this county
state_oid (read only) integer (int32) Tax record object identifier used internally by database
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted

TaxJarConfig

Attributes
Name Data Type Description
active boolean True if TaxJar is active for this merchant
api_key string TaxJar API key
estimate_only boolean True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar
use_distribution_center_from boolean Use distribution center from address

TaxPostalCode

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
city_oid (read only) integer (int32) Tax record object identifier used internally by database
dont_collect_postal_code boolean Flag instructing engine to not collect postal code tax for this postal code
postal_code string Postal Code (5 digits)
postal_code_oid (read only) integer (int32) Tax record object identifier used internally by database
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted

TaxProviderActivateResult

Attributes
Name Data Type Description
details string
success (read only) boolean True if the connection was successful

TaxProviderAvalara

Attributes
Name Data Type Description
configuration AvalaraConfig Avalara configuration
description string Description
selected boolean Selected
title string Title

TaxProviderAvalaraCompaniesResult

Attributes
Name Data Type Description
companies array of TaxProviderAvalaraCompany Tax companies configured by the merchant

TaxProviderAvalaraCompany

Attributes
Name Data Type Description
company_code string Company code
company_name string Company name
description string Description
selected boolean Selected
title string Title

TaxProviderSelf

Attributes
Name Data Type Description
countries array of TaxCountry Countries that collect sales tax
description string Description
selected boolean Selected
title string Title

TaxProviderSelfCountriesResponse

Attributes
Name Data Type Description
countries array of TaxCountryCode countries

TaxProviderSelfRegionsResponse

Attributes
Name Data Type Description
regions array of TaxStateCode regions

TaxProvidersResponse

Attributes
Name Data Type Description
avalara TaxProviderAvalara
error Error Error object if unsuccessful
metadata ResponseMetadata Meta-data about the response such as payload or paging information
self TaxProviderSelf
success boolean Indicates if API call was successful
taxjar TaxProviderTaxJar
ultracart TaxProviderUltraCart

TaxProviderTaxJar

Attributes
Name Data Type Description
configuration TaxJarConfig TaxJar configuration
description string Description
selected boolean Selected
title string Title

TaxProviderTestResult

Attributes
Name Data Type Description
details string
success (read only) boolean True if the connection was successful

TaxProviderUltraCart

Attributes
Name Data Type Description
description string Description
selected boolean Selected
states array of TaxProviderUltraCartState States in the union showing their management status
title string Title

TaxProviderUltraCartState

Attributes
Name Data Type Description
enabled boolean True if this state taxes are managed by UltraCart
state_code string State Code (2 digits)
state_name string Fully spelled out state name
tax_gift_charge boolean True if gift charges should be taxed in this state.
tax_gift_wrap boolean True if gift wrap should be taxed in this state.
tax_rate_formatted string State tax rate formatted for display
tax_shipping boolean True if shipping should be taxed in this state.

TaxState

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
counties array of TaxCounty Counties within this state
country_oid (read only) integer (int32) Tax record object identifier used internally by database
dont_collect_city boolean Flag instructing engine to not collect city tax for this state
dont_collect_county boolean Flag instructing engine to not collect county tax for this state
dont_collect_postal_code boolean Flag instructing engine to not collect postal code tax for this state
dont_collect_state boolean Flag instructing engine to not collect state tax for this state
state_code string State code
state_oid (read only) integer (int32) Tax record object identifier used internally by database
tax_gift_charge boolean True if taxation within this jurisdiction should charge tax on gift charge
tax_gift_wrap boolean True if taxation within this jurisdiction should charge tax on gift wrap
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted
tax_shipping boolean True if taxation within this jurisdiction should charge tax on shipping
use_ultracart_managed_rates boolean If true, use UltraCart managed rates for this state

TaxStateCode

Attributes
Name Data Type Description
accounting_code string Accounting code for programs such as QuickBooks
state_code string State code (2 characters
state_name string State name
tax_rate number Tax Rate
tax_rate_formatted string Tax rate formatted

400
Status Code 400: bad request input such as invalid json

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

401
Status Code 401: invalid credentials supplied

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

410
Status Code 410: Your authorized application has been disabled by UltraCart

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

429
Status Code 429: you have exceeded the allowed API call rate limit for your application.

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse

500
Status Code 500: any server side error. the body will contain a generic server error message

Headers
Name Data Type Description
UC-REST-ERROR string Contains human readable error message
Response
Name Data Type
body ErrorResponse