Delete a communication record for a company based on its `communicationId`.

company

identifier

Delete a communication record for a given company.

Retrieve a single record for a company based the ID.

Update an existing TTE configuration, communication, job, or onboarding record for a company based on its `tteId`, `communicationId`, `jobId`, or `onboardingId`.

The TTE, communication, job, or onboarding ID to update.

Retrieve a list of items for a specific company.

TTE configurations allow you to configure a combination of tax rates and rules to support what your business sells at each location where you collect and remit tax.
            
Communication records determine who to notifiy when new content is delivered via a job. Specify a unique name and ID for the Communication job, and associate that job with up to 5 email addresses (recipients).
            
Jobs allow you to configure company-specific TTE job settings.
            
Onboarding allows you to specify how complete your company setup is. For each onboarding ID, you can specify whether the following are complete:
* isPOSSetupDone
* isTTESetupDone
* isJobsSetupDone
* isCommunicationSetupDone

Retrieve a list of all TTE configurations available for a specific company. This list can be narrowed further by searching based on the `parentTTEId` and/or the `TTEName`.

parentTTEId

searchTTEName

productType

Delete a specific configuration record for a company based on its `tteId`.

Get Lodging UDF records associated with TTE.

Create company-specific job settings for your TTE jobs.

Create company-specific configuration settings for TTE jobs.

Configuration ID (TTE ID) to filter jobs.

configurationId

Delete a TTE job setup for a specific company.

state

Query filter to apply to result list, ie "Accomodations".

query

Get all lodging Tax Names and Tax Jurisdiction names for a given state. Optional query filter available.

If true, checks if the tax is current and returns an extra field (isCurrent) for each record.

validate

Get all udf ds data for your company by US state.

Check whether you should do a TTE run based on all current Remittance data.
Throws an error if reporting the issue if not ready.

Get all approved ids to be used as udf dataset values in the lodging run.
Seperator is ',', CustomerSourceField's with commmas will have the comma stripped.

Rather than using this api, we recommend doing your own mapping to TaxName or TaxJurisdictionName, this is a convenience api only.

There is no guarantee for accuracy, you are responsible for making sure these estimates are correct.

Example `state`: "ID", `searchTerms`: [
 "Idaho State Sales Tax",
 "Pocatello-Chubbuck Auditorium District Tax"
]

These 2 rows will be added to your data, you may need to correct them.

match item 1: "TaxName": "ID State Sales & Use Tax", "TaxJurisdictionName": "IDAHO"

match item 2: "TaxName": "ID Special Sales & Use Tax", "TaxJurisdictionName": "POCATELLO CHUBBUCK AUDITORIUM DISTRICT SP"
.

optional parameter if you know it. Accepted values: ['StateOrProvince', 'Special', 'CountyOrParish', 'PlaceOrCity'].

jurisdictionLevel

Json list of items you want to match to tax names and tax jurisdiction names.

Try to fuzzy match a list of tax names to Avalara tax and tax jurisdiction names.

UdfKey for all imports in the request, ie "Remittance", this maps to your UDF field name.

udfKey

What to set for approval flag of imported items (default true).  You may want to set this to false if importing from fuzzy match results.

approvalState

Imports multiple UserDefinedFieldDatasetModel.

Create a single UserDefinedFieldDatasetModel record.

List UserDefinedFieldDataset data by company ID.

Update a single UserDefinedFieldDatasetModel item.  You may need to DELETE then POST if the tax details are changing.

Delete a single UserDefinedFieldDatasetModel item by UdfDatasetId.

Get a single UserDefinedFieldDatasetModel.

Bulk add/remove approval to multiple UDF Dataset items.

Deletes multiple UserDefinedFieldDatasetModel item by UdfDatasetId.

Include tax/juris not already in Remittance dataset for template.

includeMissing

Configuration

Jobs

Tax Region Lookup

Email addresses (separated by semicolon).

Product Type default should be treated as Retail

TTE type.
Values: `Default` and `Lodging`.

List of AvataxCode IDs to be included.
            
Values: AvaTax API ItemModel.avataxCodeIds.

Indicate the applicablity of the bracket tax.

Indicate the applicablity of the combined rates.

Indicate the applicablity of the combined rates amount.

TTE CombineRatesMaxTierLevel to be included.
Values : 1 or 2.

Indiacate combineRatesTierTax.
<example>false</example>

Indicate Threshold/Tier Tax for rollout.
<example>false</example>

Restrict ATC international special export (lodging, autorental, etc) to specific countries.  This is required if International is set in the TSA Options.

Filter states by country mapping.  This is used for Canada and the US.

Restrict ATC special export (lodging, autorental, etc) to specific states or provinces (Optional, default is all states if this is not provided).

Generate component files by US state, ie CA, CO, HI-ID, etc.  These will be availble for download after the run is complete.

Inject a companyId for lodging for every row in the output.

Indicate the Custom rule override.
<example>false</example>

Indicate the Custom tax override.
<example>false</example>

Indicate the Jurisdiction override.
<example>false</example>

List of ItemGroupsNames to be included.
            
Values: AvaTax API ItemModel.itemGroupsName.

NumberofPostalCodeDigits for postal code.
            
Values: 1, 3, 6.

List of physical locations to be included.
            
Values: AvaTax API LocationModel.locationCode.

Export Platform Name.
            
Values: "TTE", "Aptos", "XStore".

Rounding method to be applied.
            
Values: `RoundHalfUp`, `RoundHalfEven`, `RoundHalfDown`, `RoundUp`, `RoundDown`, `RoundEven`, `RoundCeiling`

List of jurisdictions to be included where a company has nexus without physical locations.
            
Values: AvaTax API NexusModel.jurisCode.

Taxgroupcodetype to identify selected code type.
            
Values: AvaTax API ItemModel.taxGroupCodeType.

List of TaxGroup IDs to be included.
            
Values: AvaTax API ItemModel.itemCode.

Tax on Tax indicator
<example>true</example>

TTE TaxType IDs to be included.
            
Values: `1` - Sales; `7` - Fees

List of jurisdictions where zero rate defaults should be generated.
            
Values: AvaTax API JurisdicitonModel.id.

Defines a range of dates.
            
Expressed as either a range of absolute dates or relative days from when the job is run.

Date range end as an absolute date.
            
For use only with `StartDate`.

Date range end as a relative date.
            
For use only with `RelativeStartDays`.

Date range start as a relative date.
            
For use only with `RelativeEndDays`.

Date range start as an absolute date.
            
For use only with `EndDate`.

DetailLevel type for country entitlements.

Product Type default should be treated as Retail.

Export Platform Name.
            
Values: `TTE`, `Aptos`, `XStore`.

User defined field column type, ie string, integer, decimal, etc.

User defined field label, the column header of this user defined field in the output.

Indicates whether this is the current active record.
This property is read-only and any attempts to set its value will be ignored.
The value is calculated internally based on the record's state.

UDF table name, must be the default of "lodging-all", "autorental-all", or "special-all".

Response detailing references to an entity.

Collection of referring entities by ID and name.

Authorization

Use this service to configure your ATC jobs and schedules.

Avalara Tax Content - Configuration Service