tax
/tax
/tax
Retrieves tax methods for this account.
SDK Function Name: getTaxProviders
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Update the Avalara tax provider.
SDK Function Name: updateTaxProviderAvalara
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
tax_provider_avalara | TaxProviderAvalara object | body | TaxProviderAvalara | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Returns Avalara Tax companies configured by the merchant
SDK Function Name: getTaxProviderAvalaraCompanies
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
tax_provider_avalara | TaxProviderAvalara object | body | TaxProviderAvalara | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Attempts to connect to Avalara and returns back the response.
SDK Function Name: getTaxProviderAvalaraTest
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Update the Self tax provider.
SDK Function Name: updateTaxProviderSelf
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
tax_provider_self | TaxProviderSelf object | body | TaxProviderSelf | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Deletes a Self tax provider city.
SDK Function Name: deleteTaxProviderSelfCity
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
city | The city being deleted. | path | string | required |
tax_city | tax city to be deleted | body | TaxCity | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Updates a Self tax provider city.
SDK Function Name: updateTaxProviderSelfCity
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
city | The city being updated. | path | string | required |
tax_city | tax city to be updated | body | TaxCity | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Retrieves the Self tax provider countries.
SDK Function Name: getTaxProviderSelfCountries
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Deletes a Self tax provider country.
SDK Function Name: deleteTaxProviderSelfCountry
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Updates a Self tax provider country.
SDK Function Name: updateTaxProviderSelfCountry
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Deletes a Self tax provider county.
SDK Function Name: deleteTaxProviderSelfCounty
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
county | The county being deleted. | path | string | required |
tax_county | tax county to be deleted | body | TaxCounty | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Updates a Self tax provider county.
SDK Function Name: updateTaxProviderSelfCounty
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
county | The county being updated. | path | string | required |
tax_county | tax county to be updated | body | TaxCounty | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Deletes a Self tax provider postalCode.
SDK Function Name: deleteTaxProviderSelfPostalCode
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Updates a Self tax provider postalCode.
SDK Function Name: updateTaxProviderSelfPostalCode
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Retrieves the Self tax provider regions for a given country code.
SDK Function Name: getTaxProviderSelfRegionsByCountryCode
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
countryCode | The country code regions desired. | path | string | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Deletes a Self tax provider state.
SDK Function Name: deleteTaxProviderSelfState
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Updates a Self tax provider state.
SDK Function Name: updateTaxProviderSelfState
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 |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Toggle a tax provider to active.
SDK Function Name: setActiveTaxProvider
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
providerName | The tax provider to set active. | path | string | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Update the Sovos tax provider.
SDK Function Name: updateTaxProviderSovos
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
tax_provider_sovos | TaxProviderSovos object | body | TaxProviderSovos | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Attempts to connect to Sovos and returns back the response.
SDK Function Name: getTaxProviderSovosTest
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Update the TaxJar tax provider.
SDK Function Name: updateTaxProviderTaxJar
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
tax_provider_taxJar | TaxProviderTaxJar object | body | TaxProviderTaxJar | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Attempts to connect to TaxJar and returns back the response.
SDK Function Name: getTaxProviderTaxJarTest
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
Update the UltraCart tax provider.
SDK Function Name: updateTaxProviderUltraCart
Parameter | Description | Location | Data Type | Required |
---|---|---|---|---|
tax_provider_ultracart | TaxProviderUltraCart object | body | TaxProviderUltraCart | required |
// Internal API. Tax API has no value to merchants.
// (Internal API). No sample for this method as a merchant will never need call it.
// Internal API. No sample provided.
<?php
// The TaxRestApi is used internally by UltraCart for our own UI.
// We don't know of a use-case for merchants to use this API in their own automation,
// but it's a public part of our REST API.
//
// We're not including any examples for using the Tax Api, but if you find yourself needing it for some reason,
// contact us and we'll assist. But again, we doubt merchants will ever have a need for this API.
# Internal API - Please see the README.md in this directory for an explanation on why there are no samples here.
# Internal API. No samples are provided as merchants will never need this api method
// Internal API - no sample for this method.
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 |
send_test_orders | boolean | Send test orders through to Avalara. The default is to not transmit test orders to Avalara. |
service_url | string | Avalara service URL |
test_results | string | Test results of the last connection test to Avalara |
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 |
object_id | string | Object id that the error is associated with |
user_message | string | An end-user friendly message suitable for display to the customer |
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 |
warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
Name | Data Type | Description |
---|---|---|
payload_name | string | Payload name |
result_set | ResultSet | Result set |
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. |
Name | Data Type | Description |
---|---|---|
exempt_from_colorado_retail_delivery_fee | boolean | True if the Colorado Retail Delivery Fee should not be collected |
exempt_from_minnesota_retail_delivery_fee | boolean | True if the Minnesota Retail Delivery Fee should not be collected |
tax_billing | boolean | True if sales tax should be collected based on billing address instead of shipping address |
Name | Data Type | Description |
---|---|---|
access_key | string | Sovos access key |
estimate_only | boolean | True if this Sovos configuration is to estimate taxes only and not report placed orders to Sovos |
last_test_dts | (read only) string (dateTime) | Date/time of the connection test to Sovos |
secret_key | string | Sovos secret key |
send_test_orders | boolean | Send test orders through to Sovos. The default is to not transmit test orders to Sovos. |
test_results | string | Test results of the last connection test to Sovos |
uat | boolean | True if this Sovos configuration is currently undergoing user acceptance testing |
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 |
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 |
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 |
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 |
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 |
send_outside_nexus | boolean | Send orders outside your nexus TaxJar. The default is to not transmit outside orders to TaxJar to reduce API calls. However, this will prevent TaxJar from dynamically creating new Nexus when thresholds are exceeded for a state. |
send_test_orders | boolean | Send test orders through to TaxJar. The default is to not transmit test orders to TaxJar. |
skip_channel_orders | boolean | Do not send channel partner orders to TaxJar. Set this to true if your channel partner reports tax on their own. |
use_distribution_center_from | boolean | Use distribution center from address |
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 |
Name | Data Type | Description |
---|---|---|
details | string | |
success | (read only) boolean | True if the connection was successful |
Name | Data Type | Description |
---|---|---|
configuration | AvalaraConfig | Avalara configuration |
description | string | Description |
selected | boolean | Selected |
title | string | Title |
Name | Data Type | Description |
---|---|---|
companies | array of TaxProviderAvalaraCompany | Tax companies configured by the merchant |
Name | Data Type | Description |
---|---|---|
company_code | string | Company code |
company_name | string | Company name |
description | string | Description |
selected | boolean | Selected |
title | string | Title |
Name | Data Type | Description |
---|---|---|
configuration | SelfConfig | Self tax provider configuration |
countries | array of TaxCountry | Countries that collect sales tax |
description | string | Description |
selected | boolean | Selected |
title | string | Title |
Name | Data Type | Description |
---|---|---|
countries | array of TaxCountryCode | countries |
Name | Data Type | Description |
---|---|---|
regions | array of TaxStateCode | regions |
Name | Data Type | Description |
---|---|---|
configuration | SovosConfig | Sovos configuration |
description | string | Description |
selected | boolean | Selected |
title | string | Title |
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 | |
sovos | TaxProviderSovos | |
success | boolean | Indicates if API call was successful |
taxjar | TaxProviderTaxJar | |
ultracart | TaxProviderUltraCart | |
warning | Warning | Warning object if a non-fatal issue or side-effect occurs |
Name | Data Type | Description |
---|---|---|
configuration | TaxJarConfig | TaxJar configuration |
description | string | Description |
selected | boolean | Selected |
title | string | Title |
Name | Data Type | Description |
---|---|---|
details | string | |
success | (read only) boolean | True if the connection was successful |
Name | Data Type | Description |
---|---|---|
configuration | UltraCartConfig | UltraCart configuration |
description | string | Description |
selected | boolean | Selected |
states | array of TaxProviderUltraCartState | States in the union showing their management status |
title | string | Title |
Name | Data Type | Description |
---|---|---|
enabled | boolean | True if this state taxes are managed by UltraCart |
exempt_digital_items | boolean | True if digital items are exempt from sales tax in this state. |
exempt_physical_items | boolean | True if physical items are exempt from sales tax in this state. |
exempt_service_items | boolean | True if service items are exempt from sales tax in this state. |
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. |
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 |
exempt_digital_items | boolean | True if digital items are exempt from sales tax in this state. |
exempt_physical_items | boolean | True if physical items are exempt from sales tax in this state. |
exempt_service_items | boolean | True if service items are exempt from sales tax in 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 |
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 |
Name | Data Type | Description |
---|---|---|
exempt_from_colorado_retail_delivery_fee | boolean | True if the Colorado Retail Delivery Fee should not be collected |
exempt_from_minnesota_retail_delivery_fee | boolean | True if the Minnesota Retail Delivery Fee should not be collected |
tax_billing | boolean | True if sales tax should be collected based on billing address instead of shipping address |
Name | Data Type | Description |
---|---|---|
more_info | string | Additional information often a link to additional documentation |
warning_message | string | A technical message meant to be read by a developer |
Name | Data Type | Description |
---|---|---|
UC-REST-ERROR | string | Contains human readable error message |
Name | Data Type |
---|---|
body | ErrorResponse |
Name | Data Type | Description |
---|---|---|
UC-REST-ERROR | string | Contains human readable error message |
Name | Data Type |
---|---|
body | ErrorResponse |
Name | Data Type | Description |
---|---|---|
UC-REST-ERROR | string | Contains human readable error message |
Name | Data Type |
---|---|
body | ErrorResponse |
Name | Data Type | Description |
---|---|---|
UC-REST-ERROR | string | Contains human readable error message |
Name | Data Type |
---|---|
body | ErrorResponse |
Name | Data Type | Description |
---|---|---|
UC-REST-ERROR | string | Contains human readable error message |
Name | Data Type |
---|---|
body | ErrorResponse |