ultracart\v2\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

deleteTaxProviderSelfCity($city, $tax_city)

Deletes a Self tax provider city

Deletes a Self tax provider city.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$city = "city_example"; // string | The city being deleted.
$tax_city = new \ultracart\v2\models\TaxCity(); // \ultracart\v2\models\TaxCity | tax city to be deleted

try {
    $apiInstance->deleteTaxProviderSelfCity($city, $tax_city);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->deleteTaxProviderSelfCity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
city	string	The city being deleted.
tax_city	\ultracart\v2\models\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

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

deleteTaxProviderSelfCountry

deleteTaxProviderSelfCountry($country_code, $tax_country)

Deletes a Self tax provider country

Deletes a Self tax provider country.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$country_code = "country_code_example"; // string | The country code being deleted.
$tax_country = new \ultracart\v2\models\TaxCountry(); // \ultracart\v2\models\TaxCountry | tax country to be deleted

try {
    $apiInstance->deleteTaxProviderSelfCountry($country_code, $tax_country);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->deleteTaxProviderSelfCountry: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
country_code	string	The country code being deleted.
tax_country	\ultracart\v2\models\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

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

deleteTaxProviderSelfCounty

deleteTaxProviderSelfCounty($county, $tax_county)

Deletes a Self tax provider county

Deletes a Self tax provider county.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$county = "county_example"; // string | The county being deleted.
$tax_county = new \ultracart\v2\models\TaxCounty(); // \ultracart\v2\models\TaxCounty | tax county to be deleted

try {
    $apiInstance->deleteTaxProviderSelfCounty($county, $tax_county);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->deleteTaxProviderSelfCounty: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
county	string	The county being deleted.
tax_county	\ultracart\v2\models\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

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

deleteTaxProviderSelfPostalCode

deleteTaxProviderSelfPostalCode($postal_code, $tax_postal_code)

Deletes a Self tax provider postalCode

Deletes a Self tax provider postalCode.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$postal_code = "postal_code_example"; // string | The postal code being deleted.
$tax_postal_code = new \ultracart\v2\models\TaxPostalCode(); // \ultracart\v2\models\TaxPostalCode | tax postal code to be deleted

try {
    $apiInstance->deleteTaxProviderSelfPostalCode($postal_code, $tax_postal_code);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->deleteTaxProviderSelfPostalCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
postal_code	string	The postal code being deleted.
tax_postal_code	\ultracart\v2\models\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

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

deleteTaxProviderSelfState

deleteTaxProviderSelfState($state_code, $tax_state)

Deletes a Self tax provider state

Deletes a Self tax provider state.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$state_code = "state_code_example"; // string | The state code being deleted.
$tax_state = new \ultracart\v2\models\TaxState(); // \ultracart\v2\models\TaxState | tax state to be deleted

try {
    $apiInstance->deleteTaxProviderSelfState($state_code, $tax_state);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->deleteTaxProviderSelfState: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
state_code	string	The state code being deleted.
tax_state	\ultracart\v2\models\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

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

getTaxProviderAvalara

\ultracart\v2\models\TaxProviderAvalara getTaxProviderAvalara()

Retrieve the Avalara tax provider

Retrieves the Avalara tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderAvalara();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderAvalara: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderAvalara

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderAvalaraCompanies

\ultracart\v2\models\TaxProviderAvalaraCompaniesResult getTaxProviderAvalaraCompanies($tax_provider_avalara)

Returns Avalara Tax companies configured by the merchant

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$tax_provider_avalara = new \ultracart\v2\models\TaxProviderAvalara(); // \ultracart\v2\models\TaxProviderAvalara | TaxProviderAvalara object

try {
    $result = $apiInstance->getTaxProviderAvalaraCompanies($tax_provider_avalara);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderAvalaraCompanies: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tax_provider_avalara	\ultracart\v2\models\TaxProviderAvalara	TaxProviderAvalara object

Return type

\ultracart\v2\models\TaxProviderAvalaraCompaniesResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderAvalaraTest

\ultracart\v2\models\TaxProviderTestResult getTaxProviderAvalaraTest()

Attempts to connect to Avalara and returns back the response

Attempts to connect to Avalara and returns back the response.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderAvalaraTest();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderAvalaraTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderTestResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderSelf

\ultracart\v2\models\TaxProviderSelf getTaxProviderSelf()

Retrieve the Self tax provider

Retrieves the Self tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderSelf();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderSelf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderSelf

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderSelfCountries

\ultracart\v2\models\TaxProviderSelfCountriesResponse getTaxProviderSelfCountries()

Retrieve the Self tax provider countries

Retrieves the Self tax provider countries.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderSelfCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderSelfCountries: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderSelfCountriesResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderSelfRegionsByCountryCode

\ultracart\v2\models\TaxProviderSelfRegionsResponse getTaxProviderSelfRegionsByCountryCode($country_code)

Retrieve the Self tax provider regions for a given country code

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$country_code = "country_code_example"; // string | The country code regions desired.

try {
    $result = $apiInstance->getTaxProviderSelfRegionsByCountryCode($country_code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderSelfRegionsByCountryCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\ultracart\v2\models\TaxProviderSelfRegionsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderSovos

\ultracart\v2\models\TaxProviderSovos getTaxProviderSovos()

Retrieve the Sovos tax provider

Retrieves the Sovos tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderSovos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderSovos: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderSovos

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderSovosTest

\ultracart\v2\models\TaxProviderTestResult getTaxProviderSovosTest()

Attempts to connect to Sovos and returns back the response

Attempts to connect to Sovos and returns back the response.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderSovosTest();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderSovosTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderTestResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderTaxJar

\ultracart\v2\models\TaxProviderTaxJar getTaxProviderTaxJar()

Retrieve the TaxJar tax provider

Retrieves the TaxJar tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderTaxJar();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderTaxJar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderTaxJar

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderTaxJarTest

\ultracart\v2\models\TaxProviderTestResult getTaxProviderTaxJarTest()

Attempts to connect to TaxJar and returns back the response

Attempts to connect to TaxJar and returns back the response.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderTaxJarTest();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderTaxJarTest: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderTestResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviderUltraCart

\ultracart\v2\models\TaxProviderUltraCart getTaxProviderUltraCart()

Retrieve the UltraCart tax provider

Retrieves the UltraCart tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);


try {
    $result = $apiInstance->getTaxProviderUltraCart();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviderUltraCart: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\ultracart\v2\models\TaxProviderUltraCart

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

getTaxProviders

\ultracart\v2\models\TaxProvidersResponse getTaxProviders($_limit, $_offset, $_expand)

Retrieve tax methods

Retrieves tax methods for this account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$_limit = 100; // int | The maximum number of records to return on this one API call. (Max 200)
$_offset = 0; // int | Pagination of the record set.  Offset is a zero based index.
$_expand = "_expand_example"; // string | The object expansion to perform on the result.  See documentation for examples

try {
    $result = $apiInstance->getTaxProviders($_limit, $_offset, $_expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->getTaxProviders: ', $e->getMessage(), PHP_EOL;
}
?>

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

\ultracart\v2\models\TaxProvidersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

setActiveTaxProvider

\ultracart\v2\models\TaxProviderActivateResult setActiveTaxProvider($provider_name)

Toggle a tax provider to active

Toggle a tax provider to active.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$provider_name = "provider_name_example"; // string | The tax provider to set active.

try {
    $result = $apiInstance->setActiveTaxProvider($provider_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->setActiveTaxProvider: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\ultracart\v2\models\TaxProviderActivateResult

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderAvalara

\ultracart\v2\models\TaxProviderAvalara updateTaxProviderAvalara($tax_provider_avalara)

Update the Avalara tax provider

Update the Avalara tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$tax_provider_avalara = new \ultracart\v2\models\TaxProviderAvalara(); // \ultracart\v2\models\TaxProviderAvalara | TaxProviderAvalara object

try {
    $result = $apiInstance->updateTaxProviderAvalara($tax_provider_avalara);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderAvalara: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tax_provider_avalara	\ultracart\v2\models\TaxProviderAvalara	TaxProviderAvalara object

Return type

\ultracart\v2\models\TaxProviderAvalara

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSelf

\ultracart\v2\models\TaxProviderSelf updateTaxProviderSelf($tax_provider_self)

Update the Self tax provider

Update the Self tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$tax_provider_self = new \ultracart\v2\models\TaxProviderSelf(); // \ultracart\v2\models\TaxProviderSelf | TaxProviderSelf object

try {
    $result = $apiInstance->updateTaxProviderSelf($tax_provider_self);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSelf: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tax_provider_self	\ultracart\v2\models\TaxProviderSelf	TaxProviderSelf object

Return type

\ultracart\v2\models\TaxProviderSelf

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSelfCity

\ultracart\v2\models\TaxCity updateTaxProviderSelfCity($city, $tax_city)

Updates a Self tax provider city

Updates a Self tax provider city.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$city = "city_example"; // string | The city being updated.
$tax_city = new \ultracart\v2\models\TaxCity(); // \ultracart\v2\models\TaxCity | tax city to be updated

try {
    $result = $apiInstance->updateTaxProviderSelfCity($city, $tax_city);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSelfCity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
city	string	The city being updated.
tax_city	\ultracart\v2\models\TaxCity	tax city to be updated

Return type

\ultracart\v2\models\TaxCity

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSelfCountry

\ultracart\v2\models\TaxCountry updateTaxProviderSelfCountry($country_code, $tax_country)

Updates a Self tax provider country

Updates a Self tax provider country.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$country_code = "country_code_example"; // string | The country code being updated.
$tax_country = new \ultracart\v2\models\TaxCountry(); // \ultracart\v2\models\TaxCountry | tax country to be updated

try {
    $result = $apiInstance->updateTaxProviderSelfCountry($country_code, $tax_country);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSelfCountry: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
country_code	string	The country code being updated.
tax_country	\ultracart\v2\models\TaxCountry	tax country to be updated

Return type

\ultracart\v2\models\TaxCountry

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSelfCounty

\ultracart\v2\models\TaxCounty updateTaxProviderSelfCounty($county, $tax_county)

Updates a Self tax provider county

Updates a Self tax provider county.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$county = "county_example"; // string | The county being updated.
$tax_county = new \ultracart\v2\models\TaxCounty(); // \ultracart\v2\models\TaxCounty | tax county to be updated

try {
    $result = $apiInstance->updateTaxProviderSelfCounty($county, $tax_county);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSelfCounty: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
county	string	The county being updated.
tax_county	\ultracart\v2\models\TaxCounty	tax county to be updated

Return type

\ultracart\v2\models\TaxCounty

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSelfPostalCode

\ultracart\v2\models\TaxPostalCode updateTaxProviderSelfPostalCode($postal_code, $tax_postal_code)

Updates a Self tax provider postalCode

Updates a Self tax provider postalCode.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$postal_code = "postal_code_example"; // string | The postal code being updated.
$tax_postal_code = new \ultracart\v2\models\TaxPostalCode(); // \ultracart\v2\models\TaxPostalCode | tax postal code to be updated

try {
    $result = $apiInstance->updateTaxProviderSelfPostalCode($postal_code, $tax_postal_code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSelfPostalCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
postal_code	string	The postal code being updated.
tax_postal_code	\ultracart\v2\models\TaxPostalCode	tax postal code to be updated

Return type

\ultracart\v2\models\TaxPostalCode

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSelfState

\ultracart\v2\models\TaxState updateTaxProviderSelfState($state_code, $tax_state)

Updates a Self tax provider state

Updates a Self tax provider state.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$state_code = "state_code_example"; // string | The state code being updated.
$tax_state = new \ultracart\v2\models\TaxState(); // \ultracart\v2\models\TaxState | tax state to be updated

try {
    $result = $apiInstance->updateTaxProviderSelfState($state_code, $tax_state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSelfState: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
state_code	string	The state code being updated.
tax_state	\ultracart\v2\models\TaxState	tax state to be updated

Return type

\ultracart\v2\models\TaxState

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderSovos

\ultracart\v2\models\TaxProviderSovos updateTaxProviderSovos($tax_provider_sovos)

Update the Sovos tax provider

Update the Sovos tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$tax_provider_sovos = new \ultracart\v2\models\TaxProviderSovos(); // \ultracart\v2\models\TaxProviderSovos | TaxProviderSovos object

try {
    $result = $apiInstance->updateTaxProviderSovos($tax_provider_sovos);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderSovos: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tax_provider_sovos	\ultracart\v2\models\TaxProviderSovos	TaxProviderSovos object

Return type

\ultracart\v2\models\TaxProviderSovos

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderTaxJar

\ultracart\v2\models\TaxProviderTaxJar updateTaxProviderTaxJar($tax_provider_tax_jar)

Update the TaxJar tax provider

Update the TaxJar tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$tax_provider_tax_jar = new \ultracart\v2\models\TaxProviderTaxJar(); // \ultracart\v2\models\TaxProviderTaxJar | TaxProviderTaxJar object

try {
    $result = $apiInstance->updateTaxProviderTaxJar($tax_provider_tax_jar);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderTaxJar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tax_provider_tax_jar	\ultracart\v2\models\TaxProviderTaxJar	TaxProviderTaxJar object

Return type

\ultracart\v2\models\TaxProviderTaxJar

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

updateTaxProviderUltraCart

\ultracart\v2\models\TaxProviderUltraCart updateTaxProviderUltraCart($tax_provider_ultracart)

Update the UltraCart tax provider

Update the UltraCart tax provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
$simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00';
$api_instance = ultracart\v2\api\TaxApi::usingApiKey($simple_key);

$tax_provider_ultracart = new \ultracart\v2\models\TaxProviderUltraCart(); // \ultracart\v2\models\TaxProviderUltraCart | TaxProviderUltraCart object

try {
    $result = $apiInstance->updateTaxProviderUltraCart($tax_provider_ultracart);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxApi->updateTaxProviderUltraCart: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
tax_provider_ultracart	\ultracart\v2\models\TaxProviderUltraCart	TaxProviderUltraCart object

Return type

\ultracart\v2\models\TaxProviderUltraCart

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

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

Files

TaxApi.md

Latest commit

History

TaxApi.md

File metadata and controls

ultracart\v2\TaxApi

deleteTaxProviderSelfCity

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTaxProviderSelfCountry

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTaxProviderSelfCounty

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTaxProviderSelfPostalCode

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTaxProviderSelfState

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderAvalara

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderAvalaraCompanies

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderAvalaraTest

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderSelf

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderSelfCountries

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderSelfRegionsByCountryCode

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderSovos

Example

Parameters

Return type

Authorization

HTTP request headers

getTaxProviderSovosTest