csharp

java

javascript

php

python

ruby

typescript

tax

/tax




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class Introduction
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void IntroductionCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class Introduction {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve tax methods

Permissions:
Produces: application/json

get

/tax/providers

Retrieves tax methods for this account.

SDK Function Name: getTaxProviders

Parameters

Parameter	Description	Location	Data Type	Required
_limit	The maximum number of records to return on this one API call. (Max 200) Default: 100	query	integer	optional
_offset	Pagination of the record set. Offset is a zero based index. Default: 0	query	integer	optional
_expand	The object expansion to perform on the result. See documentation for examples	query	string	optional

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviders
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProvidersCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviders {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the Avalara tax provider

Permissions:
Produces: application/json

get

/tax/providers/avalara

Retrieves the Avalara tax provider.

SDK Function Name: getTaxProviderAvalara

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderAvalara
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderAvalaraCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderAvalara {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Update the Avalara tax provider

Permissions:
Produces: application/json

post

/tax/providers/avalara

Update the Avalara tax provider.

SDK Function Name: updateTaxProviderAvalara

Parameters

Parameter	Description	Location	Data Type	Required
tax_provider_avalara	TaxProviderAvalara object	body	TaxProviderAvalara	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderAvalara
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderAvalaraCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderAvalara {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Returns Avalara Tax companies configured by the merchant

Permissions:
Produces: application/json

post

/tax/providers/avalara/companies

Returns Avalara Tax companies configured by the merchant

SDK Function Name: getTaxProviderAvalaraCompanies

Parameters

Parameter	Description	Location	Data Type	Required
tax_provider_avalara	TaxProviderAvalara object	body	TaxProviderAvalara	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderAvalaraCompanies
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderAvalaraCompaniesCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderAvalaraCompanies {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Attempts to connect to Avalara and returns back the response

Permissions:
Produces: application/json

get

/tax/providers/avalara/test

Attempts to connect to Avalara and returns back the response.

SDK Function Name: getTaxProviderAvalaraTest

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderAvalaraTest
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderAvalaraTestCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderAvalaraTest {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the Self tax provider

Permissions:
Produces: application/json

get

/tax/providers/self

Retrieves the Self tax provider.

SDK Function Name: getTaxProviderSelf

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderSelf
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderSelfCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderSelf {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Update the Self tax provider

Permissions:
Produces: application/json

post

/tax/providers/self

Update the Self tax provider.

SDK Function Name: updateTaxProviderSelf

Parameters

Parameter	Description	Location	Data Type	Required
tax_provider_self	TaxProviderSelf object	body	TaxProviderSelf	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSelf
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSelfCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSelf {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Deletes a Self tax provider city

Permissions:
Produces: application/json

delete

/tax/providers/self/city/{city}

Deletes a Self tax provider city.

SDK Function Name: deleteTaxProviderSelfCity

Parameters

Parameter	Description	Location	Data Type	Required
city	The city being deleted.	path	string	required
tax_city	tax city to be deleted	body	TaxCity	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class DeleteTaxProviderSelfCity
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void DeleteTaxProviderSelfCityCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class DeleteTaxProviderSelfCity {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Updates a Self tax provider city

Permissions:
Produces: application/json

post

/tax/providers/self/city/{city}

Updates a Self tax provider city.

SDK Function Name: updateTaxProviderSelfCity

Parameters

Parameter	Description	Location	Data Type	Required
city	The city being updated.	path	string	required
tax_city	tax city to be updated	body	TaxCity	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSelfCity
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSelfCityCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSelfCity {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the Self tax provider countries

Permissions:
Produces: application/json

get

/tax/providers/self/countries

Retrieves the Self tax provider countries.

SDK Function Name: getTaxProviderSelfCountries

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderSelfCountries
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderSelfCountriesCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderSelfCountries {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Deletes a Self tax provider country

Permissions:
Produces: application/json

delete

/tax/providers/self/country/{countryCode}

Deletes a Self tax provider country.

SDK Function Name: deleteTaxProviderSelfCountry

Parameters

Parameter	Description	Location	Data Type	Required
countryCode	The country code being deleted.	path	string	required
tax_country	tax country to be deleted	body	TaxCountry	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class DeleteTaxProviderSelfCountry
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void DeleteTaxProviderSelfCountryCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class DeleteTaxProviderSelfCountry {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Updates a Self tax provider country

Permissions:
Produces: application/json

post

/tax/providers/self/country/{countryCode}

Updates a Self tax provider country.

SDK Function Name: updateTaxProviderSelfCountry

Parameters

Parameter	Description	Location	Data Type	Required
countryCode	The country code being updated.	path	string	required
tax_country	tax country to be updated	body	TaxCountry	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSelfCountry
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSelfCountryCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSelfCountry {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Deletes a Self tax provider county

Permissions:
Produces: application/json

delete

/tax/providers/self/county/{county}

Deletes a Self tax provider county.

SDK Function Name: deleteTaxProviderSelfCounty

Parameters

Parameter	Description	Location	Data Type	Required
county	The county being deleted.	path	string	required
tax_county	tax county to be deleted	body	TaxCounty	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class DeleteTaxProviderSelfCounty
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void DeleteTaxProviderSelfCountyCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class DeleteTaxProviderSelfCounty {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Updates a Self tax provider county

Permissions:
Produces: application/json

post

/tax/providers/self/county/{county}

Updates a Self tax provider county.

SDK Function Name: updateTaxProviderSelfCounty

Parameters

Parameter	Description	Location	Data Type	Required
county	The county being updated.	path	string	required
tax_county	tax county to be updated	body	TaxCounty	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSelfCounty
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSelfCountyCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSelfCounty {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Deletes a Self tax provider postalCode

Permissions:
Produces: application/json

delete

/tax/providers/self/postalCode/{postal_code}

Deletes a Self tax provider postalCode.

SDK Function Name: deleteTaxProviderSelfPostalCode

Parameters

Parameter	Description	Location	Data Type	Required
postal_code	The postal code being deleted.	path	string	required
tax_postal_code	tax postal code to be deleted	body	TaxPostalCode	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class DeleteTaxProviderSelfPostalCode
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void DeleteTaxProviderSelfPostalCodeCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class DeleteTaxProviderSelfPostalCode {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Updates a Self tax provider postalCode

Permissions:
Produces: application/json

post

/tax/providers/self/postalCode/{postal_code}

Updates a Self tax provider postalCode.

SDK Function Name: updateTaxProviderSelfPostalCode

Parameters

Parameter	Description	Location	Data Type	Required
postal_code	The postal code being updated.	path	string	required
tax_postal_code	tax postal code to be updated	body	TaxPostalCode	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSelfPostalCode
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSelfPostalCodeCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSelfPostalCode {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the Self tax provider regions for a given country code

Permissions:
Produces: application/json

get

/tax/providers/self/regions/{countryCode}

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

SDK Function Name: getTaxProviderSelfRegionsByCountryCode

Parameters

Parameter	Description	Location	Data Type	Required
countryCode	The country code regions desired.	path	string	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderSelfRegionsByCountryCode
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderSelfRegionsByCountryCodeCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderSelfRegionsByCountryCode {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Deletes a Self tax provider state

Permissions:
Produces: application/json

delete

/tax/providers/self/state/{stateCode}

Deletes a Self tax provider state.

SDK Function Name: deleteTaxProviderSelfState

Parameters

Parameter	Description	Location	Data Type	Required
stateCode	The state code being deleted.	path	string	required
tax_state	tax state to be deleted	body	TaxState	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class DeleteTaxProviderSelfState
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void DeleteTaxProviderSelfStateCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class DeleteTaxProviderSelfState {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Updates a Self tax provider state

Permissions:
Produces: application/json

post

/tax/providers/self/state/{stateCode}

Updates a Self tax provider state.

SDK Function Name: updateTaxProviderSelfState

Parameters

Parameter	Description	Location	Data Type	Required
stateCode	The state code being updated.	path	string	required
tax_state	tax state to be updated	body	TaxState	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSelfState
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSelfStateCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSelfState {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Toggle a tax provider to active

Permissions:
Produces: application/json

post

/tax/providers/setActive/{providerName}

Toggle a tax provider to active.

SDK Function Name: setActiveTaxProvider

Parameters

Parameter	Description	Location	Data Type	Required
providerName	The tax provider to set active.	path	string	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class SetActiveTaxProvider
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void SetActiveTaxProviderCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class SetActiveTaxProvider {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the Sovos tax provider

Permissions:
Produces: application/json

get

/tax/providers/sovos

Retrieves the Sovos tax provider.

SDK Function Name: getTaxProviderSovos

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderSovos
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderSovosCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderSovos {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Update the Sovos tax provider

Permissions:
Produces: application/json

post

/tax/providers/sovos

Update the Sovos tax provider.

SDK Function Name: updateTaxProviderSovos

Parameters

Parameter	Description	Location	Data Type	Required
tax_provider_sovos	TaxProviderSovos object	body	TaxProviderSovos	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderSovos
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderSovosCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderSovos {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Attempts to connect to Sovos and returns back the response

Permissions:
Produces: application/json

get

/tax/providers/sovos/test

Attempts to connect to Sovos and returns back the response.

SDK Function Name: getTaxProviderSovosTest

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderSovosTest
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderSovosTestCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderSovosTest {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the TaxJar tax provider

Permissions:
Produces: application/json

get

/tax/providers/taxjar

Retrieves the TaxJar tax provider.

SDK Function Name: getTaxProviderTaxJar

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderTaxJar
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderTaxJarCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderTaxJar {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Update the TaxJar tax provider

Permissions:
Produces: application/json

post

/tax/providers/taxjar

Update the TaxJar tax provider.

SDK Function Name: updateTaxProviderTaxJar

Parameters

Parameter	Description	Location	Data Type	Required
tax_provider_taxJar	TaxProviderTaxJar object	body	TaxProviderTaxJar	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderTaxJar
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderTaxJarCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderTaxJar {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Attempts to connect to TaxJar and returns back the response

Permissions:
Produces: application/json

get

/tax/providers/taxjar/test

Attempts to connect to TaxJar and returns back the response.

SDK Function Name: getTaxProviderTaxJarTest

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderTaxJarTest
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderTaxJarTestCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderTaxJarTest {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Retrieve the UltraCart tax provider

Permissions:
Produces: application/json

get

/tax/providers/ultracart

Retrieves the UltraCart tax provider.

SDK Function Name: getTaxProviderUltraCart

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class GetTaxProviderUltraCart
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void GetTaxProviderUltraCartCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class GetTaxProviderUltraCart {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

Update the UltraCart tax provider

Permissions:
Produces: application/json

post

/tax/providers/ultracart

Update the UltraCart tax provider.

SDK Function Name: updateTaxProviderUltraCart

Parameters

Parameter	Description	Location	Data Type	Required
tax_provider_ultracart	TaxProviderUltraCart object	body	TaxProviderUltraCart	required

Responses

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




using System;
using com.ultracart.admin.v2.Api;
using com.ultracart.admin.v2.Model;
using NUnit.Framework;

namespace SdkSample.tax
{
    public class UpdateTaxProviderUltraCart
    {

        [Test]
        public void ExecuteTest()
        {
            //TODO-PT
        }

        public static void UpdateTaxProviderUltraCartCall()
        {
            const string simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
            var api = new TaxApi(simpleKey);
        }


    }
}



package tax;

import com.ultracart.admin.v2.TaxApi;
import com.ultracart.admin.v2.models.Coupon;
import com.ultracart.admin.v2.models.CouponResponse;
import com.ultracart.admin.v2.util.ApiException;

public class UpdateTaxProviderUltraCart {

    public static void main(String[] args) throws ApiException {

        // Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
        final String apiKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
        TaxApi taxApi = new TaxApi(apiKey);

        // TODO-PT

    }

}

AvalaraConfig

Attributes

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

Error

Attributes

Name	Data Type	Description
developer_message	string	A technical message meant to be read by a developer
error_code	string	HTTP status code
more_info	string	Additional information often a link to additional documentation
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

ErrorResponse

Attributes

Name	Data Type	Description
error	Error	Error object if unsuccessful
metadata	ResponseMetadata	Meta-data about the response such as payload or paging information
success	boolean	Indicates if API call was successful
warning	Warning	Warning object if a non-fatal issue or side-effect occurs

ResponseMetadata

Attributes

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

ResultSet

Attributes

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

SelfConfig

Attributes

Name	Data Type	Description
tax_billing	boolean	True if sales tax should be collected based on billing address instead of shipping address

SovosConfig

Attributes

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

TaxCity

Attributes

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

TaxCountry

Attributes

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

TaxCountryCode

Attributes

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

TaxCounty

Attributes

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

TaxJarConfig

Attributes

Name	Data Type	Description
active	boolean	True if TaxJar is active for this merchant
api_key	string	TaxJar API key
estimate_only	boolean	True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar
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

TaxPostalCode

Attributes

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

TaxProviderActivateResult

Attributes

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

TaxProviderAvalara

Attributes

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

TaxProviderAvalaraCompaniesResult

Attributes

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

TaxProviderAvalaraCompany

Attributes

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

TaxProviderSelf

Attributes

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

TaxProviderSelfCountriesResponse

Attributes

Name	Data Type	Description
countries	array of TaxCountryCode	countries

TaxProviderSelfRegionsResponse

Attributes

Name	Data Type	Description
regions	array of TaxStateCode	regions

TaxProviderSovos

Attributes

Name	Data Type	Description
configuration	SovosConfig	Sovos configuration
description	string	Description
selected	boolean	Selected
title	string	Title

TaxProvidersResponse

Attributes

Name	Data Type	Description
avalara	TaxProviderAvalara
error	Error	Error object if unsuccessful
metadata	ResponseMetadata	Meta-data about the response such as payload or paging information
self	TaxProviderSelf
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

TaxProviderTaxJar

Attributes

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

TaxProviderTestResult

Attributes

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

TaxProviderUltraCart

Attributes

Name	Data Type	Description
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

TaxProviderUltraCartState

Attributes

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.

TaxState

Attributes

Name	Data Type	Description
accounting_code	string	Accounting code for programs such as QuickBooks
counties	array of TaxCounty	Counties within this state
country_oid	(read only) integer (int32)	Tax record object identifier used internally by database
dont_collect_city	boolean	Flag instructing engine to not collect city tax for this state
dont_collect_county	boolean	Flag instructing engine to not collect county tax for this state
dont_collect_postal_code	boolean	Flag instructing engine to not collect postal code tax for this state
dont_collect_state	boolean	Flag instructing engine to not collect state tax for this state
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

TaxStateCode

Attributes

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

UltraCartConfig

Attributes

Name	Data Type	Description
tax_billing	boolean	True if sales tax should be collected based on billing address instead of shipping address

Warning

Attributes

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

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

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

401
Status Code 401: invalid credentials supplied

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

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

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

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

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse

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

Headers

Name	Data Type	Description
UC-REST-ERROR	string	Contains human readable error message

Response

Name	Data Type
body	ErrorResponse