Skip to content

TaxApi.md

Latest commit

 

History

History
1500 lines (917 loc) · 54.4 KB

TaxApi.md

File metadata and controls

1500 lines (917 loc) · 54.4 KB

com.ultracart.admin.v2.Api.TaxApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
DeleteTaxProviderSelfCity DELETE /tax/providers/self/city/{city} Deletes a Self tax provider city
DeleteTaxProviderSelfCountry DELETE /tax/providers/self/country/{countryCode} Deletes a Self tax provider country
DeleteTaxProviderSelfCounty DELETE /tax/providers/self/county/{county} Deletes a Self tax provider county
DeleteTaxProviderSelfPostalCode DELETE /tax/providers/self/postalCode/{postal_code} Deletes a Self tax provider postalCode
DeleteTaxProviderSelfState DELETE /tax/providers/self/state/{stateCode} Deletes a Self tax provider state
GetTaxProviderAvalara GET /tax/providers/avalara Retrieve the Avalara tax provider
GetTaxProviderAvalaraCompanies POST /tax/providers/avalara/companies Returns Avalara Tax companies configured by the merchant
GetTaxProviderAvalaraTest GET /tax/providers/avalara/test Attempts to connect to Avalara and returns back the response
GetTaxProviderSelf GET /tax/providers/self Retrieve the Self tax provider
GetTaxProviderSelfCountries GET /tax/providers/self/countries Retrieve the Self tax provider countries
GetTaxProviderSelfRegionsByCountryCode GET /tax/providers/self/regions/{countryCode} Retrieve the Self tax provider regions for a given country code
GetTaxProviderSovos GET /tax/providers/sovos Retrieve the Sovos tax provider
GetTaxProviderSovosTest GET /tax/providers/sovos/test Attempts to connect to Sovos and returns back the response
GetTaxProviderTaxJar GET /tax/providers/taxjar Retrieve the TaxJar tax provider
GetTaxProviderTaxJarTest GET /tax/providers/taxjar/test Attempts to connect to TaxJar and returns back the response
GetTaxProviderUltraCart GET /tax/providers/ultracart Retrieve the UltraCart tax provider
GetTaxProviders GET /tax/providers Retrieve tax methods
SetActiveTaxProvider POST /tax/providers/setActive/{providerName} Toggle a tax provider to active
UpdateTaxProviderAvalara POST /tax/providers/avalara Update the Avalara tax provider
UpdateTaxProviderSelf POST /tax/providers/self Update the Self tax provider
UpdateTaxProviderSelfCity POST /tax/providers/self/city/{city} Updates a Self tax provider city
UpdateTaxProviderSelfCountry POST /tax/providers/self/country/{countryCode} Updates a Self tax provider country
UpdateTaxProviderSelfCounty POST /tax/providers/self/county/{county} Updates a Self tax provider county
UpdateTaxProviderSelfPostalCode POST /tax/providers/self/postalCode/{postal_code} Updates a Self tax provider postalCode
UpdateTaxProviderSelfState POST /tax/providers/self/state/{stateCode} Updates a Self tax provider state
UpdateTaxProviderSovos POST /tax/providers/sovos Update the Sovos tax provider
UpdateTaxProviderTaxJar POST /tax/providers/taxjar Update the TaxJar tax provider
UpdateTaxProviderUltraCart POST /tax/providers/ultracart Update the UltraCart tax provider

DeleteTaxProviderSelfCity

void DeleteTaxProviderSelfCity (string city, TaxCity taxCity)

Deletes a Self tax provider city

Deletes a Self tax provider city.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
city string The city being deleted.
taxCity TaxCity tax city to be deleted

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTaxProviderSelfCountry

void DeleteTaxProviderSelfCountry (string countryCode, TaxCountry taxCountry)

Deletes a Self tax provider country

Deletes a Self tax provider country.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
countryCode string The country code being deleted.
taxCountry TaxCountry tax country to be deleted

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTaxProviderSelfCounty

void DeleteTaxProviderSelfCounty (string county, TaxCounty taxCounty)

Deletes a Self tax provider county

Deletes a Self tax provider county.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
county string The county being deleted.
taxCounty TaxCounty tax county to be deleted

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTaxProviderSelfPostalCode

void DeleteTaxProviderSelfPostalCode (string postalCode, TaxPostalCode taxPostalCode)

Deletes a Self tax provider postalCode

Deletes a Self tax provider postalCode.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
postalCode string The postal code being deleted.
taxPostalCode TaxPostalCode tax postal code to be deleted

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTaxProviderSelfState

void DeleteTaxProviderSelfState (string stateCode, TaxState taxState)

Deletes a Self tax provider state

Deletes a Self tax provider state.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
stateCode string The state code being deleted.
taxState TaxState tax state to be deleted

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderAvalara

TaxProviderAvalara GetTaxProviderAvalara ()

Retrieve the Avalara tax provider

Retrieves the Avalara tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderAvalara

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderAvalaraCompanies

TaxProviderAvalaraCompaniesResult GetTaxProviderAvalaraCompanies (TaxProviderAvalara taxProviderAvalara)

Returns Avalara Tax companies configured by the merchant

Returns Avalara Tax companies configured by the merchant

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
taxProviderAvalara TaxProviderAvalara TaxProviderAvalara object

Return type

TaxProviderAvalaraCompaniesResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderAvalaraTest

TaxProviderTestResult GetTaxProviderAvalaraTest ()

Attempts to connect to Avalara and returns back the response

Attempts to connect to Avalara and returns back the response.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderTestResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderSelf

TaxProviderSelf GetTaxProviderSelf ()

Retrieve the Self tax provider

Retrieves the Self tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderSelf

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderSelfCountries

TaxProviderSelfCountriesResponse GetTaxProviderSelfCountries ()

Retrieve the Self tax provider countries

Retrieves the Self tax provider countries.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderSelfCountriesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderSelfRegionsByCountryCode

TaxProviderSelfRegionsResponse GetTaxProviderSelfRegionsByCountryCode (string countryCode)

Retrieve the Self tax provider regions for a given country code

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

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
countryCode string The country code regions desired.

Return type

TaxProviderSelfRegionsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderSovos

TaxProviderSovos GetTaxProviderSovos ()

Retrieve the Sovos tax provider

Retrieves the Sovos tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderSovos

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderSovosTest

TaxProviderTestResult GetTaxProviderSovosTest ()

Attempts to connect to Sovos and returns back the response

Attempts to connect to Sovos and returns back the response.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderTestResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderTaxJar

TaxProviderTaxJar GetTaxProviderTaxJar ()

Retrieve the TaxJar tax provider

Retrieves the TaxJar tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderTaxJar

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderTaxJarTest

TaxProviderTestResult GetTaxProviderTaxJarTest ()

Attempts to connect to TaxJar and returns back the response

Attempts to connect to TaxJar and returns back the response.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderTestResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviderUltraCart

TaxProviderUltraCart GetTaxProviderUltraCart ()

Retrieve the UltraCart tax provider

Retrieves the UltraCart tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

This endpoint does not need any parameter.

Return type

TaxProviderUltraCart

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaxProviders

TaxProvidersResponse GetTaxProviders (int? limit = null, int? offset = null, string expand = null)

Retrieve tax methods

Retrieves tax methods for this account.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
limit int? The maximum number of records to return on this one API call. (Max 200) [optional] [default to 100]
offset int? Pagination of the record set. Offset is a zero based index. [optional] [default to 0]
expand string The object expansion to perform on the result. See documentation for examples [optional]

Return type

TaxProvidersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetActiveTaxProvider

TaxProviderActivateResult SetActiveTaxProvider (string providerName)

Toggle a tax provider to active

Toggle a tax provider to active.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
providerName string The tax provider to set active.

Return type

TaxProviderActivateResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderAvalara

TaxProviderAvalara UpdateTaxProviderAvalara (TaxProviderAvalara taxProviderAvalara)

Update the Avalara tax provider

Update the Avalara tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
taxProviderAvalara TaxProviderAvalara TaxProviderAvalara object

Return type

TaxProviderAvalara

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSelf

TaxProviderSelf UpdateTaxProviderSelf (TaxProviderSelf taxProviderSelf)

Update the Self tax provider

Update the Self tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
taxProviderSelf TaxProviderSelf TaxProviderSelf object

Return type

TaxProviderSelf

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSelfCity

TaxCity UpdateTaxProviderSelfCity (string city, TaxCity taxCity)

Updates a Self tax provider city

Updates a Self tax provider city.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
city string The city being updated.
taxCity TaxCity tax city to be updated

Return type

TaxCity

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSelfCountry

TaxCountry UpdateTaxProviderSelfCountry (string countryCode, TaxCountry taxCountry)

Updates a Self tax provider country

Updates a Self tax provider country.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
countryCode string The country code being updated.
taxCountry TaxCountry tax country to be updated

Return type

TaxCountry

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSelfCounty

TaxCounty UpdateTaxProviderSelfCounty (string county, TaxCounty taxCounty)

Updates a Self tax provider county

Updates a Self tax provider county.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
county string The county being updated.
taxCounty TaxCounty tax county to be updated

Return type

TaxCounty

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSelfPostalCode

TaxPostalCode UpdateTaxProviderSelfPostalCode (string postalCode, TaxPostalCode taxPostalCode)

Updates a Self tax provider postalCode

Updates a Self tax provider postalCode.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
postalCode string The postal code being updated.
taxPostalCode TaxPostalCode tax postal code to be updated

Return type

TaxPostalCode

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSelfState

TaxState UpdateTaxProviderSelfState (string stateCode, TaxState taxState)

Updates a Self tax provider state

Updates a Self tax provider state.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
stateCode string The state code being updated.
taxState TaxState tax state to be updated

Return type

TaxState

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderSovos

TaxProviderSovos UpdateTaxProviderSovos (TaxProviderSovos taxProviderSovos)

Update the Sovos tax provider

Update the Sovos tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
taxProviderSovos TaxProviderSovos TaxProviderSovos object

Return type

TaxProviderSovos

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderTaxJar

TaxProviderTaxJar UpdateTaxProviderTaxJar (TaxProviderTaxJar taxProviderTaxJar)

Update the TaxJar tax provider

Update the TaxJar tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
taxProviderTaxJar TaxProviderTaxJar TaxProviderTaxJar object

Return type

TaxProviderTaxJar

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTaxProviderUltraCart

TaxProviderUltraCart UpdateTaxProviderUltraCart (TaxProviderUltraCart taxProviderUltracart)

Update the UltraCart tax provider

Update the UltraCart tax provider.

Example

// Internal API.  Tax API has no value to merchants.

Parameters

Name Type Description Notes
taxProviderUltracart TaxProviderUltraCart TaxProviderUltraCart object

Return type

TaxProviderUltraCart

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

[Back to top] [Back to API list] [Back to Model list] [Back to README]