Module avatax
ballerinax/avatax Ballerina library
1.3.2
Overview
The Avalara AvaTax API v2 connector(https://developer.avalara.com/api-reference/avatax/rest/v2/) OpenAPI specification. Avalara AvaTax is sales tax software that automates tax calculations and the tax filing process.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an Avalara account.
- Obtain tokens - Follow this guide.
Clients
avatax: Client
Isolated
This is a generated connector for Avalara AvaTax API v2 OpenAPI specification. Avalara AvaTax is sales tax software that automates tax calculations and the tax filing process.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create an Avalara account and obtain tokens following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
queryAccounts
Isolated FunctionRemote Function
function queryAccounts(string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns AccountModelFetchResult|errorRetrieve all accounts
Parameters
- include string? (default ()) - A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: subscriptions, users
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountModelFetchResult|error - Success
createAccount
Isolated FunctionRemote Function
function createAccount(AccountModel payload, string xAvalaraClient) returns AccountModel[]|errorCreate a new account
Parameters
- payload AccountModel - The account you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountModel[]|error - Success
getAccount
Isolated FunctionRemote Function
function getAccount(int id, string? include, string xAvalaraClient) returns AccountModel|errorRetrieve a single account
Parameters
- id int - The ID of the account to retrieve
- include string? (default ()) - A comma separated list of special fetch options
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountModel|error - Success
updateAccount
Isolated FunctionRemote Function
function updateAccount(int id, AccountModel payload, string xAvalaraClient) returns AccountModel|errorUpdate a single account
Parameters
- id int - The ID of the account you wish to update.
- payload AccountModel - The account object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountModel|error - Success
deleteAccount
Isolated FunctionRemote Function
function deleteAccount(int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single account
Parameters
- id int - The ID of the account you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
activateAccount
Isolated FunctionRemote Function
function activateAccount(int id, ActivateAccountModel payload, string xAvalaraClient) returns AccountModel|errorActivate an account by accepting terms and conditions
Parameters
- id int - The ID of the account to activate
- payload ActivateAccountModel - The activation request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountModel|error - Success
auditAccount
Isolated FunctionRemote Function
function auditAccount(int id, string? 'start, string? end, int top, int skip, string xAvalaraClient) returns AuditModelFetchResult|errorRetrieve audit history for an account.
Parameters
- id int - The ID of the account you wish to audit.
- 'start string? (default ()) - The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
- end string? (default ()) - The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
- top int (default 10) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int (default 0) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AuditModelFetchResult|error - Success
getAccountConfiguration
Isolated FunctionRemote Function
function getAccountConfiguration(int id, string xAvalaraClient) returns AccountConfigurationModel[]|errorGet configuration settings for this account
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountConfigurationModel[]|error - Success
setAccountConfiguration
Isolated FunctionRemote Function
function setAccountConfiguration(int id, AccountConfigurationModel[] payload, string xAvalaraClient) returns AccountConfigurationModel[]|errorChange configuration settings for this account
Parameters
- id int -
- payload AccountConfigurationModel[] -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountConfigurationModel[]|error - Success
createLicenseKey
Isolated FunctionRemote Function
function createLicenseKey(int id, AccountLicenseKeyModel payload, string xAvalaraClient) returns LicenseKeyModel|errorCreate license key for this account
Parameters
- id int - The ID of the account you wish to update.
- payload AccountLicenseKeyModel -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LicenseKeyModel|error - Success
getLicenseKey
Isolated FunctionRemote Function
function getLicenseKey(int id, string licensekeyname, string xAvalaraClient) returns AccountLicenseKeyModel|errorRetrieve license key by license key name
Parameters
- id int - The ID of the account to retrieve
- licensekeyname string - The ID of the account to retrieve
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountLicenseKeyModel|error - Success
deleteLicenseKey
Isolated FunctionRemote Function
function deleteLicenseKey(int id, string licensekeyname, string xAvalaraClient) returns ErrorDetail[]|errorDelete license key for this account by license key name
Parameters
- id int - The ID of the account you wish to update.
- licensekeyname string - The license key name you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getLicenseKeys
Isolated FunctionRemote Function
function getLicenseKeys(int id, string xAvalaraClient) returns AccountLicenseKeyModel[]|errorRetrieve all license keys for this account
Parameters
- id int - The ID of the account to retrieve
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountLicenseKeyModel[]|error - Success
accountResetLicenseKey
Isolated FunctionRemote Function
function accountResetLicenseKey(int id, ResetLicenseKeyModel payload, string xAvalaraClient) returns LicenseKeyModel|errorReset this account's license key
Parameters
- id int - The ID of the account you wish to update.
- payload ResetLicenseKeyModel - A request confirming that you wish to reset the license key of this account.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LicenseKeyModel|error - Success
resolveAddress
Isolated FunctionRemote Function
function resolveAddress(string? line1, string? line2, string? line3, string? city, string? region, string? postalCode, string? country, string? textCase, string xAvalaraClient) returns AddressResolutionModel|errorRetrieve geolocation information for a specified address
Parameters
- line1 string? (default ()) - Line 1
- line2 string? (default ()) - Line 2
- line3 string? (default ()) - Line 3
- city string? (default ()) - City
- region string? (default ()) - State / Province / Region
- postalCode string? (default ()) - Postal Code / Zip Code
- country string? (default ()) - Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
- textCase string? (default ()) - selectable text case for address validation
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AddressResolutionModel|error - Success
resolveAddressPost
Isolated FunctionRemote Function
function resolveAddressPost(AddressValidationInfo payload, string xAvalaraClient) returns AddressResolutionModel|errorRetrieve geolocation information for a specified address
Parameters
- payload AddressValidationInfo - The address to resolve
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AddressResolutionModel|error - Success
getCompanyLookupFiles
Isolated FunctionRemote Function
function getCompanyLookupFiles(int accountId, int companyId, string xAvalaraClient) returns AdvancedRuleLookupFileModelFetchResult|errorGet the lookup files for a company
Parameters
- accountId int - The account ID for the company
- companyId int - The ID of the company for which to retrieve lookup files
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AdvancedRuleLookupFileModelFetchResult|error - Success
createCompanyLookupFile
Isolated FunctionRemote Function
function createCompanyLookupFile(int accountId, int companyId, AdvancedRuleLookupFileModel payload, string xAvalaraClient) returns AdvancedRuleLookupFileModel|errorCreate a lookup file for a company
Parameters
- accountId int - The ID of the account for the company
- companyId int - The ID of the company for which the lookup file is to be created
- payload AdvancedRuleLookupFileModel - The lookup file you wish to create
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AdvancedRuleLookupFileModel|error - Success
getLookupFile
Isolated FunctionRemote Function
function getLookupFile(int accountId, string id, string xAvalaraClient) returns AdvancedRuleLookupFileModel|errorGet a lookup file for an accountId and companyLookupFileId
Parameters
- accountId int - The ID of the account for the lookup file
- id string - The unique ID/GUID of the company lookup file to return
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AdvancedRuleLookupFileModel|error - Success
updateLookupFile
Isolated FunctionRemote Function
function updateLookupFile(int accountId, string id, AdvancedRuleLookupFileModel payload, string xAvalaraClient) returns AdvancedRuleLookupFileModel|errorUpdate a lookup file
Parameters
- accountId int - The ID of the account for the company the lookup file is for
- id string - The unique ID/GUID of the company lookup file to be updated
- payload AdvancedRuleLookupFileModel - The new values to update the lookup file
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AdvancedRuleLookupFileModel|error - Success
deleteLookupFile
Isolated FunctionRemote Function
function deleteLookupFile(int accountId, string id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a lookup file
Parameters
- accountId int - The ID of the account for the company the lookup file is for
- id string - The unique ID/GUID for the company lookup file to be deleted
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryAvaFileForms
Isolated FunctionRemote Function
function queryAvaFileForms(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns AvaFileFormModelFetchResult|errorRetrieve all AvaFileForms
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: outletTypeId
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AvaFileFormModelFetchResult|error - Success
createAvaFileForms
Isolated FunctionRemote Function
function createAvaFileForms(AvaFileFormModel[] payload, string xAvalaraClient) returns AvaFileFormModel[]|errorCreate a new AvaFileForm
Parameters
- payload AvaFileFormModel[] - The AvaFileForm you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AvaFileFormModel[]|error - Success
getAvaFileForm
Isolated FunctionRemote Function
function getAvaFileForm(int id, string xAvalaraClient) returns AvaFileFormModel|errorRetrieve a single AvaFileForm
Parameters
- id int - The primary key of this AvaFileForm
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AvaFileFormModel|error - Success
updateAvaFileForm
Isolated FunctionRemote Function
function updateAvaFileForm(int id, AvaFileFormModel payload, string xAvalaraClient) returns AvaFileFormModel|errorUpdate a AvaFileForm
Parameters
- id int - The ID of the AvaFileForm you wish to update
- payload AvaFileFormModel - The AvaFileForm model you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AvaFileFormModel|error - Success
deleteAvaFileForm
Isolated FunctionRemote Function
function deleteAvaFileForm(int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single AvaFileForm
Parameters
- id int - The ID of the AvaFileForm you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryBatches
Isolated FunctionRemote Function
function queryBatches(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns BatchModelFetchResult|errorRetrieve all batches
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: files
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- BatchModelFetchResult|error - Success
listBatchesByCompany
Isolated FunctionRemote Function
function listBatchesByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns BatchModelFetchResult|errorRetrieve all batches for this company
Parameters
- companyId int - The ID of the company that owns these batches
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: files
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- BatchModelFetchResult|error - Success
createBatches
Isolated FunctionRemote Function
function createBatches(int companyId, BatchModel[] payload, string xAvalaraClient) returns BatchModel[]|errorCreate a new batch
Parameters
- companyId int - The ID of the company that owns this batch.
- payload BatchModel[] - The batch you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- BatchModel[]|error - Success
downloadBatch
Isolated FunctionRemote Function
function downloadBatch(int companyId, int batchId, int id, string xAvalaraClient) returns string|errorDownload a single batch file
Parameters
- companyId int - The ID of the company that owns this batch
- batchId int - The ID of the batch object
- id int - The primary key of this batch file object
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
getBatch
Isolated FunctionRemote Function
function getBatch(int companyId, int id, string xAvalaraClient) returns BatchModel|errorRetrieve a single batch
Parameters
- companyId int - The ID of the company that owns this batch
- id int - The primary key of this batch
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- BatchModel|error - Success
deleteBatch
Isolated FunctionRemote Function
function deleteBatch(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single batch
Parameters
- companyId int - The ID of the company that owns this batch.
- id int - The ID of the batch to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
cancelBatch
Isolated FunctionRemote Function
function cancelBatch(int companyId, int id, string xAvalaraClient) returns BatchModel|errorCancel an in progress batch
Parameters
- companyId int - The ID of the company that owns this batch.
- id int - The ID of the batch to cancel.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- BatchModel|error - Success
createTransactionBatch
Isolated FunctionRemote Function
function createTransactionBatch(int companyId, CreateTransactionBatchRequestModel payload, string xAvalaraClient) returns CreateTransactionBatchResponseModel|errorCreate a new transaction batch
Parameters
- companyId int - The ID of the company that owns this batch.
- payload CreateTransactionBatchRequestModel - The transaction batch you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CreateTransactionBatchResponseModel|error - Success
listCertExpressInvitations
Isolated FunctionRemote Function
function listCertExpressInvitations(int companyId, string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CertExpressInvitationModelFetchResult|errorList CertExpress invitations
Parameters
- companyId int - The unique ID number of the company that issued this invitation
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertExpressInvitationModelFetchResult|error - Success
createCertExpressInvitation
Isolated FunctionRemote Function
function createCertExpressInvitation(int companyId, string customerCode, CreateCertExpressInvitationModel[] payload, string xAvalaraClient) returns CertExpressInvitationStatusModel[]|errorCreate a CertExpress invitation
Parameters
- companyId int - The unique ID number of the company that will record certificates
- customerCode string - The number of the customer where the request is sent to
- payload CreateCertExpressInvitationModel[] - the requests to send out to customers
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertExpressInvitationStatusModel[]|error - Success
getCertExpressInvitation
Isolated FunctionRemote Function
function getCertExpressInvitation(int companyId, string customerCode, int id, string? include, string xAvalaraClient) returns CertExpressInvitationModel|errorRetrieve a single CertExpress invitation
Parameters
- companyId int - The unique ID number of the company that issued this invitation
- customerCode string - The number of the customer where the request is sent to
- id int - The unique ID number of this CertExpress invitation
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertExpressInvitationModel|error - Success
queryCertificates
Isolated FunctionRemote Function
function queryCertificates(int companyId, string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CertificateModelFetchResult|errorList all certificates for a company
Parameters
- companyId int - The ID number of the company to search
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: customers - Retrieves the list of customers linked to the certificate. po_numbers - Retrieves all PO numbers tied to the certificate. attributes - Retrieves all attributes applied to the certificate.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModelFetchResult|error - Success
createCertificates
Isolated FunctionRemote Function
function createCertificates(int companyId, CertificateModel[] payload, boolean? prevalidatedexemptionreason, string xAvalaraClient) returns CertificateModel[]|errorCreate certificates for this company
Parameters
- companyId int - The ID number of the company recording this certificate
- payload CertificateModel[] - Certificates to be created
- prevalidatedexemptionreason boolean? (default ()) - If set to true, the certificate will bypass the human verification process.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModel[]|error - Success
getCertificate
Isolated FunctionRemote Function
function getCertificate(int companyId, int id, string? include, string xAvalaraClient) returns CertificateModel|errorRetrieve a single certificate
Parameters
- companyId int - The ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: customers - Retrieves the list of customers linked to the certificate. po_numbers - Retrieves all PO numbers tied to the certificate. attributes - Retrieves all attributes applied to the certificate.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModel|error - Success
updateCertificate
Isolated FunctionRemote Function
function updateCertificate(int companyId, int id, CertificateModel payload, string xAvalaraClient) returns CertificateModel|errorUpdate a single certificate
Parameters
- companyId int - The ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- payload CertificateModel - The new certificate object that will replace the existing one
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModel|error - Success
deleteCertificate
Isolated FunctionRemote Function
function deleteCertificate(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorRevoke and delete a certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
downloadCertificateImage
Isolated FunctionRemote Function
function downloadCertificateImage(int companyId, int id, int? page, string 'type, string xAvalaraClient) returns string|errorDownload an image for this certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- page int? (default ()) - If you choose
$type=Jpeg, you must specify which page number to retrieve.
- 'type string (default "Pdf") - The data format in which to retrieve the certificate image
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
uploadCertificateImage
Isolated FunctionRemote Function
function uploadCertificateImage(int companyId, int id, IdAttachmentBody payload, string xAvalaraClient) returns string|errorUpload an image or PDF attachment for this certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- payload IdAttachmentBody -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
listAttributesForCertificate
Isolated FunctionRemote Function
function listAttributesForCertificate(int companyId, int id, string xAvalaraClient) returns CertificateAttributeModelFetchResult|errorList all attributes applied to this certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateAttributeModelFetchResult|error - Success
linkAttributesToCertificate
Isolated FunctionRemote Function
function linkAttributesToCertificate(int companyId, int id, CertificateAttributeModel[] payload, string xAvalaraClient) returns CertificateAttributeModelFetchResult|errorLink attributes to a certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- payload CertificateAttributeModel[] - The list of attributes to link to this certificate.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateAttributeModelFetchResult|error - Success
unlinkAttributesFromCertificate
Isolated FunctionRemote Function
function unlinkAttributesFromCertificate(int companyId, int id, CertificateAttributeModel[] payload, string xAvalaraClient) returns CertificateAttributeModelFetchResult|errorUnlink attributes from a certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- payload CertificateAttributeModel[] - The list of attributes to unlink from this certificate.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateAttributeModelFetchResult|error - Success
listCustomersForCertificate
Isolated FunctionRemote Function
function listCustomersForCertificate(int companyId, int id, string? include, string xAvalaraClient) returns CustomerModelFetchResult|errorList customers linked to this certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModelFetchResult|error - Success
linkCustomersToCertificate
Isolated FunctionRemote Function
function linkCustomersToCertificate(int companyId, int id, LinkCustomersModel payload, string xAvalaraClient) returns CustomerModelFetchResult|errorLink customers to a certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- payload LinkCustomersModel - The list of customers needed be added to the Certificate for exemption
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModelFetchResult|error - Success
unlinkCustomersFromCertificate
Isolated FunctionRemote Function
function unlinkCustomersFromCertificate(int companyId, int id, LinkCustomersModel payload, string xAvalaraClient) returns CustomerModelFetchResult|errorUnlink customers from a certificate
Parameters
- companyId int - The unique ID number of the company that recorded this certificate
- id int - The unique ID number of this certificate
- payload LinkCustomersModel - The list of customers to unlink from this certificate
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModelFetchResult|error - Success
getCertificateSetup
Isolated FunctionRemote Function
function getCertificateSetup(int companyId, string xAvalaraClient) returns ProvisionStatusModel|errorCheck a company's exemption certificate status.
Parameters
- companyId int - The company ID to check
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ProvisionStatusModel|error - Success
requestCertificateSetup
Isolated FunctionRemote Function
function requestCertificateSetup(int companyId, string xAvalaraClient) returns ProvisionStatusModel|errorRequest setup of exemption certificates for this company.
Parameters
- companyId int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ProvisionStatusModel|error - Success
queryCompanies
Isolated FunctionRemote Function
function queryCompanies(string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CompanyModelFetchResult|errorRetrieve all companies
Parameters
- include string? (default ()) - A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyModelFetchResult|error - Success
createCompanies
Isolated FunctionRemote Function
function createCompanies(CompanyModel[] payload, string xAvalaraClient) returns CompanyModel[]|errorCreate new companies
Parameters
- payload CompanyModel[] - Either a single company object or an array of companies to create
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyModel[]|error - Success
fundingConfigurationByCompany
Isolated FunctionRemote Function
function fundingConfigurationByCompany(int companyId, string xAvalaraClient) returns FundingConfigurationModel|errorCheck the funding configuration of a company
Parameters
- companyId int - The unique identifier of the company
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FundingConfigurationModel|error - Success
fundingConfigurationsByCompanyAndCurrency
Isolated FunctionRemote Function
function fundingConfigurationsByCompanyAndCurrency(int companyId, string? currency, string xAvalaraClient) returns FundingConfigurationModel[]|errorCheck the funding configuration of a company
Parameters
- companyId int - The unique identifier of the company
- currency string? (default ()) - The currency of the funding. USD and CAD are the only valid currencies
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FundingConfigurationModel[]|error - Success
listCompanyParameterDetails
Isolated FunctionRemote Function
function listCompanyParameterDetails(int companyId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CompanyParameterDetailModelFetchResult|errorRetrieve parameters for a company
Parameters
- companyId int - The company id
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: name, unit
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyParameterDetailModelFetchResult|error - Success
createCompanyParameters
Isolated FunctionRemote Function
function createCompanyParameters(int companyId, CompanyParameterDetailModel[] payload, string xAvalaraClient) returns CompanyParameterDetailModel[]|errorAdd parameters to a company.
Parameters
- companyId int - The ID of the company that owns this company parameter.
- payload CompanyParameterDetailModel[] - The company parameters you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyParameterDetailModel[]|error - Success
getCompanyParameterDetail
Isolated FunctionRemote Function
function getCompanyParameterDetail(int companyId, int id, string xAvalaraClient) returns CompanyParameterDetailModel|errorRetrieve a single company parameter
Parameters
- companyId int -
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyParameterDetailModel|error - Success
updateCompanyParameterDetail
Isolated FunctionRemote Function
function updateCompanyParameterDetail(int companyId, int id, CompanyParameterDetailModel payload, string xAvalaraClient) returns CompanyParameterDetailModel|errorUpdate a company parameter
Parameters
- companyId int - The company id.
- id int - The company parameter id
- payload CompanyParameterDetailModel - The company parameter object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyParameterDetailModel|error - Success
deleteCompanyParameter
Isolated FunctionRemote Function
function deleteCompanyParameter(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single company parameter
Parameters
- companyId int - The company id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getCompany
Isolated FunctionRemote Function
function getCompany(int id, string? include, string xAvalaraClient) returns CompanyModel|errorRetrieve a single company
Parameters
- id int - The ID of the company to retrieve.
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyModel|error - Success
updateCompany
Isolated FunctionRemote Function
function updateCompany(int id, CompanyModel payload, string xAvalaraClient) returns CompanyModel|errorUpdate a single company
Parameters
- id int - The ID of the company you wish to update.
- payload CompanyModel - The company object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyModel|error - Success
deleteCompany
Isolated FunctionRemote Function
function deleteCompany(int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single company
Parameters
- id int - The ID of the company you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
certifyIntegration
Isolated FunctionRemote Function
Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
Parameters
- id int - The ID of the company to check if its integration is certified.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
getCompanyConfiguration
Isolated FunctionRemote Function
function getCompanyConfiguration(int id, string xAvalaraClient) returns CompanyConfigurationModel[]|errorGet configuration settings for this company
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyConfigurationModel[]|error - Success
setCompanyConfiguration
Isolated FunctionRemote Function
function setCompanyConfiguration(int id, CompanyConfigurationModel[] payload, string xAvalaraClient) returns CompanyConfigurationModel[]|errorChange configuration settings for this company
Parameters
- id int -
- payload CompanyConfigurationModel[] -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyConfigurationModel[]|error - Success
getFilingStatus
Isolated FunctionRemote Function
Get this company's filing status
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
changeFilingStatus
Isolated FunctionRemote Function
function changeFilingStatus(int id, FilingStatusChangeModel payload, string xAvalaraClient) returns string|errorChange the filing status of this company
Parameters
- id int -
- payload FilingStatusChangeModel -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
listFundingRequestsByCompany
Isolated FunctionRemote Function
function listFundingRequestsByCompany(int id, string xAvalaraClient) returns FundingStatusModel[]|errorCheck managed returns funding status for a company
Parameters
- id int - The unique identifier of the company
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FundingStatusModel[]|error - Success
createFundingRequest
Isolated FunctionRemote Function
function createFundingRequest(int id, FundingInitiateModel payload, string xAvalaraClient) returns FundingStatusModel|errorRequest managed returns funding setup for a company
Parameters
- id int - The unique identifier of the company
- payload FundingInitiateModel - The funding initialization request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FundingStatusModel|error - Success
companyInitialize
Isolated FunctionRemote Function
function companyInitialize(CompanyInitializationModel payload, string xAvalaraClient) returns CompanyModel|errorQuick setup for a company with a single physical address
Parameters
- payload CompanyInitializationModel - Information about the company you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyModel|error - Success
listMrsCompanies
Isolated FunctionRemote Function
function listMrsCompanies(string xAvalaraClient) returns MrsCompanyModelFetchResult|errorRetrieve a list of MRS Companies with account
Parameters
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MrsCompanyModelFetchResult|error - Success
queryTaxAuthorityJurisdictionRates
Isolated FunctionRemote Function
function queryTaxAuthorityJurisdictionRates(int? taxAuthorityId, string? effectiveDate, string? endDate, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns ComplianceJurisdictionRateModel|errorRetrieve jurisdiction rate information for tax authority
Parameters
- taxAuthorityId int? (default ()) - Used to limit the jurisdictions returned.
- effectiveDate string? (default ()) - Used to limit the jurisdictions returned.
- endDate string? (default ()) - Used to limit the jurisdictions returned.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of objects to fetch underneath this jurisdiction.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ComplianceJurisdictionRateModel|error - Success
listContactsByCompany
Isolated FunctionRemote Function
function listContactsByCompany(int companyId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ContactModelFetchResult|errorRetrieve contacts for this company
Parameters
- companyId int - The ID of the company that owns these contacts
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ContactModelFetchResult|error - Success
createContacts
Isolated FunctionRemote Function
function createContacts(int companyId, ContactModel[] payload, string xAvalaraClient) returns ContactModel[]|errorCreate a new contact
Parameters
- companyId int - The ID of the company that owns this contact.
- payload ContactModel[] - The contacts you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ContactModel[]|error - Success
getContact
Isolated FunctionRemote Function
function getContact(int companyId, int id, string xAvalaraClient) returns ContactModel|errorRetrieve a single contact
Parameters
- companyId int - The ID of the company for this contact
- id int - The primary key of this contact
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ContactModel|error - Success
updateContact
Isolated FunctionRemote Function
function updateContact(int companyId, int id, ContactModel payload, string xAvalaraClient) returns ContactModel|errorUpdate a single contact
Parameters
- companyId int - The ID of the company that this contact belongs to.
- id int - The ID of the contact you wish to update
- payload ContactModel - The contact you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ContactModel|error - Success
deleteContact
Isolated FunctionRemote Function
function deleteContact(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single contact
Parameters
- companyId int - The ID of the company that owns this contact.
- id int - The ID of the contact you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryContacts
Isolated FunctionRemote Function
function queryContacts(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ContactModelFetchResult|errorRetrieve all contacts
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ContactModelFetchResult|error - Success
queryCustomers
Isolated FunctionRemote Function
function queryCustomers(int companyId, string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CustomerModelFetchResult|errorList all customers for this company
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- include string? (default ()) - OPTIONAL - You can specify the value
certificatesto fetch information about certificates linked to the customer.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: shipTos
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModelFetchResult|error - Success
createCustomers
Isolated FunctionRemote Function
function createCustomers(int companyId, CustomerModel[] payload, string xAvalaraClient) returns CustomerModel[]|errorCreate customers for this company
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- payload CustomerModel[] - The list of customer objects to be created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModel[]|error - Success
getCustomer
Isolated FunctionRemote Function
function getCustomer(int companyId, string customerCode, string? include, string xAvalaraClient) returns CustomerModel|errorRetrieve a single customer
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- include string? (default ()) - Specify optional additional objects to include in this fetch request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModel|error - Success
updateCustomer
Isolated FunctionRemote Function
function updateCustomer(int companyId, string customerCode, CustomerModel payload, string xAvalaraClient) returns CustomerModel|errorUpdate a single customer
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- payload CustomerModel - The new customer model that will replace the existing record at this URL
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModel|error - Success
deleteCustomer
Isolated FunctionRemote Function
function deleteCustomer(int companyId, string customerCode, string xAvalaraClient) returns CustomerModel|errorDelete a customer record
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModel|error - Success
listAttributesForCustomer
Isolated FunctionRemote Function
function listAttributesForCustomer(int companyId, string customerCode, string xAvalaraClient) returns CustomerAttributeModelFetchResult|errorRetrieve a customer's attributes
Parameters
- companyId int - The unique ID number of the company that recorded the provided customer
- customerCode string - The unique code representing the current customer
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerAttributeModelFetchResult|error - Success
linkAttributesToCustomer
Isolated FunctionRemote Function
function linkAttributesToCustomer(int companyId, string customerCode, CustomerAttributeModel[] payload, string xAvalaraClient) returns CustomerAttributeModelFetchResult|errorLink attributes to a customer
Parameters
- companyId int - The unique ID number of the company that recorded the provided customer
- customerCode string - The unique code representing the current customer
- payload CustomerAttributeModel[] - The list of attributes to link to the customer.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerAttributeModelFetchResult|error - Success
unlinkAttributesFromCustomer
Isolated FunctionRemote Function
function unlinkAttributesFromCustomer(int companyId, string customerCode, CustomerAttributeModel[] payload, string xAvalaraClient) returns CustomerAttributeModelFetchResult|errorUnlink attributes from a customer
Parameters
- companyId int - The unique ID number of the company that recorded the customer
- customerCode string - The unique code representing the current customer
- payload CustomerAttributeModel[] - The list of attributes to unlink from the customer.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerAttributeModelFetchResult|error - Success
listCertificatesForCustomer
Isolated FunctionRemote Function
function listCertificatesForCustomer(int companyId, string customerCode, string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CertificateModelFetchResult|errorList certificates linked to a customer
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- include string? (default ()) - OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: customers - Retrieves the list of customers linked to the certificate. po_numbers - Retrieves all PO numbers tied to the certificate. attributes - Retrieves all attributes applied to the certificate.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModelFetchResult|error - Success
listValidCertificatesForCustomer
Isolated FunctionRemote Function
function listValidCertificatesForCustomer(int companyId, string customerCode, string country, string region, string xAvalaraClient) returns ExemptionStatusModel|errorList valid certificates for a location
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- country string - Search for certificates matching this country. Uses the ISO 3166 two character country code.
- region string - Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ExemptionStatusModel|error - Success
linkCertificatesToCustomer
Isolated FunctionRemote Function
function linkCertificatesToCustomer(int companyId, string customerCode, LinkCertificatesModel payload, string xAvalaraClient) returns CertificateModelFetchResult|errorLink certificates to a customer
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- payload LinkCertificatesModel - The list of certificates to link to this customer
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModelFetchResult|error - Success
unlinkCertificatesFromCustomer
Isolated FunctionRemote Function
function unlinkCertificatesFromCustomer(int companyId, string customerCode, LinkCertificatesModel payload, string xAvalaraClient) returns CertificateModelFetchResult|errorUnlink certificates from a customer
Parameters
- companyId int - The unique ID number of the company that recorded this customer
- customerCode string - The unique code representing this customer
- payload LinkCertificatesModel - The list of certificates to link to this customer
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateModelFetchResult|error - Success
linkShipToCustomersToBillCustomer
Isolated FunctionRemote Function
function linkShipToCustomersToBillCustomer(int companyId, string code, LinkCustomersModel payload, string xAvalaraClient) returns CustomerModel|errorLink two customer records together
Parameters
- companyId int - The unique ID number of the company defining customers.
- code string - The code of the bill-to customer to link.
- payload LinkCustomersModel - A list of information about ship-to customers to link to this bill-to customer.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CustomerModel|error - Success
listDataSources
Isolated FunctionRemote Function
function listDataSources(int companyId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns DataSourceModelFetchResult|errorRetrieve all datasources for this company
Parameters
- companyId int - The id of the company you wish to retrieve the datasources.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: isEnabled, isSynced, isAuthorized, name, externalState
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- DataSourceModelFetchResult|error - Success
createDataSources
Isolated FunctionRemote Function
function createDataSources(int companyId, DataSourceModel[] payload, string xAvalaraClient) returns DataSourceModel[]|errorCreate and store new datasources for the respective companies.
Parameters
- companyId int - The id of the company you which to create the datasources
- payload DataSourceModel[] -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- DataSourceModel[]|error - Success
getDataSourceById
Isolated FunctionRemote Function
function getDataSourceById(int companyId, int id, string xAvalaraClient) returns DataSourceModel|errorGet data source by data source id
Parameters
- companyId int -
- id int - data source id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- DataSourceModel|error - Success
updateDataSource
Isolated FunctionRemote Function
function updateDataSource(int companyId, int id, DataSourceModel payload, string xAvalaraClient) returns DataSourceModel|errorUpdate a datasource identified by id for a company
Parameters
- companyId int - The id of the company the datasource belongs to.
- id int - The id of the datasource you wish to delete.
- payload DataSourceModel -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- DataSourceModel|error - Success
deleteDataSource
Isolated FunctionRemote Function
function deleteDataSource(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a datasource by datasource id for a company.
Parameters
- companyId int - The id of the company the datasource belongs to.
- id int - The id of the datasource you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryDataSources
Isolated FunctionRemote Function
function queryDataSources(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns DataSourceModelFetchResult|errorRetrieve all datasources
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: isEnabled, isSynced, isAuthorized, name, externalState
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- DataSourceModelFetchResult|error - Success
listAvaFileForms
Isolated FunctionRemote Function
function listAvaFileForms(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns AvaFileFormModelFetchResult|errorRetrieve the full list of the AvaFile Forms available
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: outletTypeId
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AvaFileFormModelFetchResult|error - Success
listCertificateAttributes
Isolated FunctionRemote Function
function listCertificateAttributes(int? companyid, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CertificateAttributeModelFetchResult|errorList certificate attributes used by a company
Parameters
- companyid int? (default ()) - Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CertificateAttributeModelFetchResult|error - Success
listCertificateExemptReasons
Isolated FunctionRemote Function
function listCertificateExemptReasons(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ExemptionReasonModelFetchResult|errorList the certificate exempt reasons defined by a company
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ExemptionReasonModelFetchResult|error - Success
listCertificateExposureZones
Isolated FunctionRemote Function
function listCertificateExposureZones(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ExposureZoneModelFetchResult|errorList certificate exposure zones used by a company
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: id, companyId, name, tag, description, created, modified, region, country
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ExposureZoneModelFetchResult|error - Success
listClassificationParametersUsage
Isolated FunctionRemote Function
function listClassificationParametersUsage(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ClassificationParameterUsageMapModelFetchResult|errorRetrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: values
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
listCommunicationsTransactionTypes
Isolated FunctionRemote Function
function listCommunicationsTransactionTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CommunicationsTransactionTypeModelFetchResult|errorRetrieve the full list of communications transactiontypes
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
listCommunicationsServiceTypes
Isolated FunctionRemote Function
function listCommunicationsServiceTypes(int id, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CommunicationsTSPairModelFetchResult|errorRetrieve the full list of communications service types
Parameters
- id int - The transaction type ID to examine
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: requiredParameters
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CommunicationsTSPairModelFetchResult|error - Success
listCommunicationsTSPairs
Isolated FunctionRemote Function
function listCommunicationsTSPairs(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CommunicationsTSPairModelFetchResult|errorRetrieve the full list of communications transaction/service type pairs
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: requiredParameters
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CommunicationsTSPairModelFetchResult|error - Success
listCountries
Isolated FunctionRemote Function
function listCountries(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns IsoCountryModelFetchResult|errorList all ISO 3166 countries
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- IsoCountryModelFetchResult|error - Success
listRateTypesByCountry
Isolated FunctionRemote Function
function listRateTypesByCountry(string country, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns RateTypeModelFetchResult|errorRetrieve the full list of rate types for each country
Parameters
- country string - The country to examine for rate types
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- RateTypeModelFetchResult|error - Success
listRegionsByCountry
Isolated FunctionRemote Function
function listRegionsByCountry(string country, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns IsoRegionModelFetchResult|errorList all ISO 3166 regions for a country
Parameters
- country string - The country of which you want to fetch ISO 3166 regions
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: localizedNames
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- IsoRegionModelFetchResult|error - Success
listRateTypesByCountryTaxTypeTaxSubType
Isolated FunctionRemote Function
function listRateTypesByCountryTaxTypeTaxSubType(string country, string taxTypeId, string taxSubTypeId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns RateTypesModelFetchResult|errorRetrieve the list of rate types by country, TaxType and by TaxSubType
Parameters
- country string - The country to examine for rate types
- taxTypeId string - The taxType for the country to examine for rate types
- taxSubTypeId string - The taxSubType for the country and taxType to examine for rate types
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: id, rateType, description
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- RateTypesModelFetchResult|error - Success
listCoverLetters
Isolated FunctionRemote Function
function listCoverLetters(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CoverLetterModelFetchResult|errorList certificate exposure zones used by a company
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CoverLetterModelFetchResult|error - Success
listCrossBorderCodes
Isolated FunctionRemote Function
function listCrossBorderCodes(string country, string hsCode, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns HsCodeModelFetchResult|errorLists the next level of HS Codes given a destination country and HS Code prefix.
Parameters
- country string - The name or code of the destination country.
- hsCode string - The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- HsCodeModelFetchResult|error - Success
getCrossBorderCode
Isolated FunctionRemote Function
function getCrossBorderCode(string country, string hsCode, string xAvalaraClient) returns HsCodeModelFetchResult|errorLists all parents of an HS Code.
Parameters
- country string - The name or code of the destination country.
- hsCode string - The partial or full HS Code for which you would like to view all of the parents.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- HsCodeModelFetchResult|error - Success
listCrossBorderSections
Isolated FunctionRemote Function
function listCrossBorderSections(string xAvalaraClient) returns HsCodeModelFetchResult|errorList top level HS Code Sections.
Parameters
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- HsCodeModelFetchResult|error - Success
listCurrencies
Isolated FunctionRemote Function
function listCurrencies(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns CurrencyModelFetchResult|errorList all ISO 4217 currencies supported by AvaTax.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CurrencyModelFetchResult|error - Success
listEntityUseCodes
Isolated FunctionRemote Function
function listEntityUseCodes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns EntityUseCodeModelFetchResult|errorRetrieve the full list of Avalara-supported entity use codes
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: validCountries
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- EntityUseCodeModelFetchResult|error - Success
listLoginVerifiers
Isolated FunctionRemote Function
function listLoginVerifiers(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns SkyscraperStatusModelFetchResult|errorList all forms where logins can be verified automatically
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SkyscraperStatusModelFetchResult|error - Success
getLoginVerifierByForm
Isolated FunctionRemote Function
function getLoginVerifierByForm(string form, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns SkyscraperStatusModelFetchResult|errorTest whether a form supports online login verification
Parameters
- form string - The name of the form you would like to verify. This is the tax form code
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SkyscraperStatusModelFetchResult|error - Success
listFilingFrequencies
Isolated FunctionRemote Function
function listFilingFrequencies(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns FilingFrequencyModelFetchResult|errorRetrieve the full list of Avalara-supported filing frequencies.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FilingFrequencyModelFetchResult|error - Success
listJurisdictions
Isolated FunctionRemote Function
function listJurisdictions(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns JurisdictionModelFetchResult|errorList jurisdictions based on the filter provided
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: rate, salesRate, signatureCode, useRate
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionModelFetchResult|error - Success
listJurisdictionsByRateTypeTaxTypeMapping
Isolated FunctionRemote Function
function listJurisdictionsByRateTypeTaxTypeMapping(string country, string region, string taxTypeId, string taxSubTypeId, string rateTypeId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns JurisdictionRateTypeTaxTypeMappingModelFetchResult|errorList jurisdictions based on the TaxType, TaxSubType and RateType provided
Parameters
- country string - The country for which you want to retrieve the jurisdiction information
- region string - The region for which you want to retrieve the jurisdiction information
- taxTypeId string - The taxtype for which you want to retrieve the jurisdiction information
- taxSubTypeId string - The taxsubtype for which you want to retrieve the jurisdiction information
- rateTypeId string - The ratetype for which you want to retrieve the jurisdiction information
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
listJurisdictionsByAddress
Isolated FunctionRemote Function
function listJurisdictionsByAddress(string country, string? line1, string? line2, string? line3, string? city, string? region, string? postalCode, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns JurisdictionOverrideModelFetchResult|errorList jurisdictions near a specific address
Parameters
- country string - The two-character ISO-3166 code of the country portion of this address.
- line1 string? (default ()) - The first address line portion of this address.
- line2 string? (default ()) - The second address line portion of this address.
- line3 string? (default ()) - The third address line portion of this address.
- city string? (default ()) - The city portion of this address.
- region string? (default ()) - The region, state, or province code portion of this address.
- postalCode string? (default ()) - The postal code or zip code portion of this address.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: country, Jurisdictions
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionOverrideModelFetchResult|error - Success
listAllMarketplaceLocations
Isolated FunctionRemote Function
function listAllMarketplaceLocations(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns MarketplaceModelFetchResult|errorList all market place locations.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MarketplaceModelFetchResult|error - Success
listLocationQuestionsByAddress
Isolated FunctionRemote Function
function listLocationQuestionsByAddress(string? line1, string? line2, string? line3, string? city, string? region, string? postalCode, string? country, decimal? latitude, decimal? longitude, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns LocationQuestionModelFetchResult|errorRetrieve the list of questions that are required for a tax location
Parameters
- line1 string? (default ()) - The first line of this location's address.
- line2 string? (default ()) - The second line of this location's address.
- line3 string? (default ()) - The third line of this location's address.
- city string? (default ()) - The city part of this location's address.
- region string? (default ()) - The region, state, or province part of this location's address.
- postalCode string? (default ()) - The postal code of this location's address.
- country string? (default ()) - The country part of this location's address.
- latitude decimal? (default ()) - Optionally identify the location via latitude/longitude instead of via address.
- longitude decimal? (default ()) - Optionally identify the location via latitude/longitude instead of via address.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationQuestionModelFetchResult|error - Success
listMarketplaceLocations
Isolated FunctionRemote Function
function listMarketplaceLocations(string marketplaceId, int? top, int? skip, string? orderby, string xAvalaraClient) returns MarketplaceLocationModelFetchResult|errorRetrieve the list of locations for a marketplace.
Parameters
- marketplaceId string - MarketplaceId of a marketplace
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MarketplaceLocationModelFetchResult|error - Success
listNexus
Isolated FunctionRemote Function
function listNexus(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve the full list of Avalara-supported nexus for all countries and regions.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
listNexusByCountry
Isolated FunctionRemote Function
function listNexusByCountry(string country, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve the full list of Avalara-supported nexus for a country.
Parameters
- country string - The country in which you want to fetch the system nexus
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
listNexusByCountryAndRegion
Isolated FunctionRemote Function
function listNexusByCountryAndRegion(string country, string region, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve the full list of Avalara-supported nexus for a country and region.
Parameters
- country string - The two-character ISO-3166 code for the country.
- region string - The two or three character region code for the region.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
listNexusByAddress
Isolated FunctionRemote Function
function listNexusByAddress(string region, string country, string? line1, string? line2, string? line3, string? city, string? postalCode, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorList all nexus that apply to a specific address.
Parameters
- region string - Name or ISO 3166 code identifying the region portion of the address. This field supports many different region identifiers: * Two and three character ISO 3166 region codes. Fully spelled out names of the region in ISO supported languages. Common alternative spellings for many regions. For a full list of all supported codes and names, please see the Definitions API
ListRegions.
- country string - Name or ISO 3166 code identifying the country portion of this address. This field supports many different country identifiers: Two character ISO 3166 codes. Three character ISO 3166 codes. Fully spelled out names of the country in ISO supported languages. Common alternative spellings for many countries. For a full list of all supported codes and names, please see the Definitions API
ListCountries.
- line1 string? (default ()) - The first address line portion of this address.
- line2 string? (default ()) - The first address line portion of this address.
- line3 string? (default ()) - The first address line portion of this address.
- city string? (default ()) - The city portion of this address.
- postalCode string? (default ()) - The postal code or zip code portion of this address.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
listNexusByFormCode
Isolated FunctionRemote Function
function listNexusByFormCode(string formCode, string xAvalaraClient) returns NexusByTaxFormModel|errorList nexus related to a tax form
Parameters
- formCode string - The form code that we are looking up the nexus for
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusByTaxFormModel|error - Success
listNexusByTaxTypeGroup
Isolated FunctionRemote Function
function listNexusByTaxTypeGroup(string taxTypeGroup, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve the full list of Avalara-supported nexus for a tax type group.
Parameters
- taxTypeGroup string - The tax type group to fetch the supporting system nexus for.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
listNexusTaxTypeGroups
Isolated FunctionRemote Function
function listNexusTaxTypeGroups(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusTaxTypeGroupModelFetchResult|errorRetrieve the full list of nexus tax type groups
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: subscriptionTypeId, subscriptionDescription, tabName, showColumn
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusTaxTypeGroupModelFetchResult|error - Success
listNoticeCustomerFundingOptions
Isolated FunctionRemote Function
function listNoticeCustomerFundingOptions(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeCustomerFundingOptionModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice customer funding options.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: activeFlag, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
listNoticeCustomerTypes
Isolated FunctionRemote Function
function listNoticeCustomerTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeCustomerTypeModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice customer types.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: activeFlag, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeCustomerTypeModelFetchResult|error - Success
listNoticeFilingtypes
Isolated FunctionRemote Function
function listNoticeFilingtypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeFilingTypeModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice filing types.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: description, activeFlag, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeFilingTypeModelFetchResult|error - Success
listNoticePriorities
Isolated FunctionRemote Function
function listNoticePriorities(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticePriorityModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice priorities.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: activeFlag, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticePriorityModelFetchResult|error - Success
listNoticeReasons
Isolated FunctionRemote Function
function listNoticeReasons(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeReasonModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice reasons.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: description, activeFlag, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeReasonModelFetchResult|error - Success
listNoticeResponsibilities
Isolated FunctionRemote Function
function listNoticeResponsibilities(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeResponsibilityModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice responsibility ids
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeResponsibilityModelFetchResult|error - Success
listNoticeRootCauses
Isolated FunctionRemote Function
function listNoticeRootCauses(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeRootCauseModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice root causes
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeRootCauseModelFetchResult|error - Success
listNoticeStatuses
Isolated FunctionRemote Function
function listNoticeStatuses(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeStatusModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice statuses.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: isOpen, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeStatusModelFetchResult|error - Success
listNoticeTypes
Isolated FunctionRemote Function
function listNoticeTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NoticeTypeModelFetchResult|errorRetrieve the full list of Avalara-supported tax notice types.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: activeFlag, sortOrder
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeTypeModelFetchResult|error - Success
listParameters
Isolated FunctionRemote Function
function listParameters(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ParameterModelFetchResult|errorRetrieve the full list of Avalara-supported extra parameters for creating transactions.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: serviceTypes, regularExpression, values
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ParameterModelFetchResult|error - Success
listParametersByItem
Isolated FunctionRemote Function
function listParametersByItem(string companyCode, string itemCode, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ParameterModelFetchResult|errorRetrieve the parameters by companyCode and itemCode.
Parameters
- companyCode string - Company code.
- itemCode string - Item code.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: serviceTypes, regularExpression, values
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ParameterModelFetchResult|error - Success
listParametersUsage
Isolated FunctionRemote Function
function listParametersUsage(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ParameterUsageModelFetchResult|errorRetrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: values
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ParameterUsageModelFetchResult|error - Success
listPermissions
Isolated FunctionRemote Function
function listPermissions(int? top, int? skip, string xAvalaraClient) returns StringFetchResult|errorRetrieve the full list of Avalara-supported permissions
Parameters
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- StringFetchResult|error - Success
listPostalCodes
Isolated FunctionRemote Function
function listPostalCodes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns PostalCodeModelFetchResult|errorRetrieve the full list of Avalara-supported postal codes.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- PostalCodeModelFetchResult|error - Success
listPreferredPrograms
Isolated FunctionRemote Function
function listPreferredPrograms(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns PreferredProgramModelFetchResult|errorList all customs duty programs recognized by AvaTax
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: effectiveDate, endDate
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- PreferredProgramModelFetchResult|error - Success
listProductClassificationSystems
Isolated FunctionRemote Function
function listProductClassificationSystems(string? filter, int? top, int? skip, string? orderby, string? countrycode, string xAvalaraClient) returns ProductClassificationSystemModelFetchResult|errorList all available product classification systems.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: countries
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- countrycode string? (default ()) - If not null, return all records with this code.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
listProductClassificationSystemsByCompany
Isolated FunctionRemote Function
function listProductClassificationSystemsByCompany(string companyCode, string? filter, int? top, int? skip, string? orderby, string? countrycode, string xAvalaraClient) returns ProductClassificationSystemModelFetchResult|errorList all product classification systems available to a company based on its nexus.
Parameters
- companyCode string - The company code.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: countries
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- countrycode string? (default ()) - If not null, return all records with this code.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
listRegions
Isolated FunctionRemote Function
function listRegions(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns IsoRegionModelFetchResult|errorList all ISO 3166 regions
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: localizedNames
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- IsoRegionModelFetchResult|error - Success
listResourceFileTypes
Isolated FunctionRemote Function
function listResourceFileTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ResourceFileTypeModelFetchResult|errorRetrieve the full list of Avalara-supported resource file types
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ResourceFileTypeModelFetchResult|error - Success
listReturnsParametersUsage
Isolated FunctionRemote Function
function listReturnsParametersUsage(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ReturnsParameterUsageModelFetchResult|errorRetrieve the full list of Avalara-supported usage of parameters used for returns.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: values
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ReturnsParameterUsageModelFetchResult|error - Success
listSecurityRoles
Isolated FunctionRemote Function
function listSecurityRoles(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns SecurityRoleModelFetchResult|errorRetrieve the full list of Avalara-supported permissions
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SecurityRoleModelFetchResult|error - Success
listSubscriptionTypes
Isolated FunctionRemote Function
function listSubscriptionTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns SubscriptionTypeModelFetchResult|errorRetrieve the full list of Avalara-supported subscription types
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionTypeModelFetchResult|error - Success
listTags
Isolated FunctionRemote Function
function listTags(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TagsModelFetchResult|errorRetrieve the list all tags supported by avalara
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TagsModelFetchResult|error - Success
listTaxAuthorities
Isolated FunctionRemote Function
function listTaxAuthorities(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxAuthorityModelFetchResult|errorRetrieve the full list of Avalara-supported tax authorities.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxAuthorityModelFetchResult|error - Success
listTaxAuthorityForms
Isolated FunctionRemote Function
function listTaxAuthorityForms(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxAuthorityFormModelFetchResult|errorRetrieve the full list of Avalara-supported forms for each tax authority.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxAuthorityFormModelFetchResult|error - Success
listTaxAuthorityTypes
Isolated FunctionRemote Function
function listTaxAuthorityTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxAuthorityTypeModelFetchResult|errorRetrieve the full list of Avalara-supported tax authority types.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxAuthorityTypeModelFetchResult|error - Success
listTaxCodes
Isolated FunctionRemote Function
function listTaxCodes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxCodeModelFetchResult|errorRetrieve the full list of Avalara-supported tax codes.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeModelFetchResult|error - Success
listTaxCodeTypes
Isolated FunctionRemote Function
function listTaxCodeTypes(int? top, int? skip, string xAvalaraClient) returns TaxCodeTypesModel|errorRetrieve the full list of Avalara-supported tax code types.
Parameters
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeTypesModel|error - Success
listTaxForms
Isolated FunctionRemote Function
function listTaxForms(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns FormMasterModelFetchResult|errorRetrieve the full list of the Tax Forms available
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FormMasterModelFetchResult|error - Success
listTaxSubTypes
Isolated FunctionRemote Function
function listTaxSubTypes(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxSubTypeModelFetchResult|errorRetrieve the full list of tax sub types
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxSubTypeModelFetchResult|error - Success
listTaxSubTypesByJurisdictionAndRegion
Isolated FunctionRemote Function
function listTaxSubTypesByJurisdictionAndRegion(string jurisdictionCode, string region, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxSubTypeModelFetchResult|errorRetrieve the full list of tax sub types by jurisdiction code and region
Parameters
- jurisdictionCode string - The jurisdiction code of the tax sub type.
- region string - The region of the tax sub type.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxSubTypeModelFetchResult|error - Success
listTaxSubTypesByCountryAndTaxType
Isolated FunctionRemote Function
function listTaxSubTypesByCountryAndTaxType(string country, string taxTypeId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxSubTypeModelFetchResult|errorRetrieve the full list of tax sub types by Country and TaxType
Parameters
- country string - The country to examine for taxsubtype
- taxTypeId string - The taxType for the country to examine for taxsubtype
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxSubTypeModelFetchResult|error - Success
listTaxTypeGroups
Isolated FunctionRemote Function
function listTaxTypeGroups(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxTypeGroupModelFetchResult|errorRetrieve the full list of tax type groups
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxTypeGroupModelFetchResult|error - Success
listTaxTypesByNexusAndCountry
Isolated FunctionRemote Function
function listTaxTypesByNexusAndCountry(string country, int companyId, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxTypeModelFetchResult|errorRetrieve the list of applicable TaxTypes
Parameters
- country string - The country for which you want to retrieve the unitofbasis information
- companyId int - Your companyId to retrieve the applicable taxtypes
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxTypeModelFetchResult|error - Success
listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType
Isolated FunctionRemote Function
function listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType(string country, string taxTypeId, string taxSubTypeId, string rateTypeId, int? top, int? skip, string? orderby, string xAvalaraClient) returns UnitOfBasisModelFetchResult|errorRetrieve the list of applicable UnitOfBasis
Parameters
- country string - The country for which you want to retrieve the unitofbasis information
- taxTypeId string - The taxtype for which you want to retrieve the unitofbasis information
- taxSubTypeId string - The taxsubtype for which you want to retrieve the unitofbasis information
- rateTypeId string - The ratetype for which you want to retrieve the unitofbasis information
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UnitOfBasisModelFetchResult|error - Success
listUnitOfMeasurement
Isolated FunctionRemote Function
function listUnitOfMeasurement(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns UomModelFetchResult|errorList all defined units of measurement
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: id
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UomModelFetchResult|error - Success
listDistanceThresholds
Isolated FunctionRemote Function
function listDistanceThresholds(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns CompanyDistanceThresholdModelFetchResult|errorRetrieve all DistanceThresholds for this company.
Parameters
- companyId int - The ID of the company whose DistanceThreshold objects you wish to list.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
createDistanceThreshold
Isolated FunctionRemote Function
function createDistanceThreshold(int companyId, CompanyDistanceThresholdModel[] payload, string xAvalaraClient) returns CompanyDistanceThresholdModel[]|errorCreate one or more DistanceThreshold objects
Parameters
- companyId int - The unique ID number of the company that owns this DistanceThreshold
- payload CompanyDistanceThresholdModel[] - The DistanceThreshold object or objects you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyDistanceThresholdModel[]|error - Success
getDistanceThreshold
Isolated FunctionRemote Function
function getDistanceThreshold(int companyId, int id, string xAvalaraClient) returns CompanyDistanceThresholdModel|errorRetrieve a single DistanceThreshold
Parameters
- companyId int - The ID of the company that owns this DistanceThreshold object
- id int - The unique ID number referring to this DistanceThreshold object
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyDistanceThresholdModel|error - Success
updateDistanceThreshold
Isolated FunctionRemote Function
function updateDistanceThreshold(int companyId, int id, CompanyDistanceThresholdModel payload, string xAvalaraClient) returns CompanyDistanceThresholdModel|errorUpdate a DistanceThreshold object
Parameters
- companyId int - The unique ID number of the company that owns this DistanceThreshold object.
- id int - The unique ID number of the DistanceThreshold object to replace.
- payload CompanyDistanceThresholdModel - The new DistanceThreshold object to store.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyDistanceThresholdModel|error - Success
deleteDistanceThreshold
Isolated FunctionRemote Function
function deleteDistanceThreshold(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single DistanceThreshold object
Parameters
- companyId int - The unique ID number of the company that owns this DistanceThreshold
- id int - The unique ID number of the DistanceThreshold object you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryDistanceThresholds
Isolated FunctionRemote Function
function queryDistanceThresholds(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns CompanyDistanceThresholdModelFetchResult|errorRetrieve all DistanceThreshold objects
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
refreshECommerceToken
Isolated FunctionRemote Function
function refreshECommerceToken(int companyId, RefreshECommerceTokenInputModel payload, string xAvalaraClient) returns ECommerceTokenOutputModelFetchResult|errorRefresh an eCommerce token.
Parameters
- companyId int - The company ID that the refreshed certificate belongs to.
- payload RefreshECommerceTokenInputModel -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ECommerceTokenOutputModelFetchResult|error - Success
createECommerceToken
Isolated FunctionRemote Function
function createECommerceToken(int companyId, CreateECommerceTokenInputModel payload, string xAvalaraClient) returns ECommerceTokenOutputModel|errorCreate a new eCommerce token.
Parameters
- companyId int - The company ID that will be issued this certificate.
- payload CreateECommerceTokenInputModel -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ECommerceTokenOutputModel|error - Success
deleteCompanyReturnSettings
Isolated FunctionRemote Function
function deleteCompanyReturnSettings(int companyId, int filingCalendarId, int companyReturnSettingId, string xAvalaraClient) returns CompanyReturnSettingModel[]|errorDelete a company return setting
Parameters
- companyId int - The unique ID of the company
- filingCalendarId int - The unique ID of the filing calendar that will remove setting
- companyReturnSettingId int - The unique ID of the company return setting that will be deleted from the filing calendar
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyReturnSettingModel[]|error - Success
cycleSafeOptions
Isolated FunctionRemote Function
function cycleSafeOptions(int companyId, CycleSafeEditRequestModel payload, string xAvalaraClient) returns CycleSafeOptionResultModel|errorAdd or Edit options
Parameters
- companyId int - The unique ID of the company that owns the filing calendar object
- payload CycleSafeEditRequestModel - Cycle Safe Options Request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CycleSafeOptionResultModel|error - Success
legacyFilingCalendars
Isolated FunctionRemote Function
function legacyFilingCalendars(int companyId, string? filter, int? top, int? skip, string? orderby, string? returnCountry, string? returnRegion, string xAvalaraClient) returns FilingCalendarModelFetchResult|errorRetrieve all legacy filing calendars for this company
Parameters
- companyId int - The ID of the company that owns these batches
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxTypes, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- returnCountry string? (default ()) - A comma separated list of countries
- returnRegion string? (default ()) - A comma separated list of regions
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FilingCalendarModelFetchResult|error - Success
getAccrualFilings
Isolated FunctionRemote Function
function getAccrualFilings(int companyId, int filingReturnId, string xAvalaraClient) returns MultiTaxFilingModelFetchResult|errorRetrieve a filing containing the return and all its accrual returns.
Parameters
- companyId int - The ID of the company that owns these returns
- filingReturnId int - The ID of the filing return
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiTaxFilingModelFetchResult|error - Success
getFiledReturns
Isolated FunctionRemote Function
function getFiledReturns(int companyId, int? endPeriodMonth, int? endPeriodYear, string? frequency, string? status, string? country, string? region, int? filingCalendarId, string? taxformCode, string xAvalaraClient) returns FiledReturnModelFetchResult|errorRetrieve a list of filed returns for the specified company in the year and month of a given filing period.
Parameters
- companyId int - The ID of the company that owns these batches
- endPeriodMonth int? (default ()) - The month of the period you are trying to retrieve
- endPeriodYear int? (default ()) - The year of the period you are trying to retrieve
- frequency string? (default ()) - The frequency of the return you are trying to retrieve
- status string? (default ()) - The status of the return(s) you are trying to retrieve
- country string? (default ()) - The country of the return(s) you are trying to retrieve
- region string? (default ()) - The region of the return(s) you are trying to retrieve
- filingCalendarId int? (default ()) - The filing calendar id of the return you are trying to retrieve
- taxformCode string? (default ()) - The unique tax form code of the form.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FiledReturnModelFetchResult|error - Success
listFirmClientLinkage
Isolated FunctionRemote Function
function listFirmClientLinkage(string? filter, string xAvalaraClient) returns FirmClientLinkageOutputModelFetchResult|errorList client linkages for a firm or client
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: firmAccountName, clientAccountName
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModelFetchResult|error - Success
createFirmClientLinkage
Isolated FunctionRemote Function
function createFirmClientLinkage(FirmClientLinkageInputModel payload, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorLinks a firm account with the client account
Parameters
- payload FirmClientLinkageInputModel - FirmClientLinkageInputModel
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
getFirmClientLinkage
Isolated FunctionRemote Function
function getFirmClientLinkage(int id, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorGet linkage between a firm and client by id
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
deleteFirmClientLinkage
Isolated FunctionRemote Function
function deleteFirmClientLinkage(int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a linkage
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
approveFirmClientLinkage
Isolated FunctionRemote Function
function approveFirmClientLinkage(int id, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorApproves linkage to a firm for a client account
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
rejectFirmClientLinkage
Isolated FunctionRemote Function
function rejectFirmClientLinkage(int id, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorRejects linkage to a firm for a client account
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
resetFirmClientLinkage
Isolated FunctionRemote Function
function resetFirmClientLinkage(int id, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorReset linkage status between a client and firm back to requested
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
revokeFirmClientLinkage
Isolated FunctionRemote Function
function revokeFirmClientLinkage(int id, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorRevokes previously approved linkage to a firm for a client account
Parameters
- id int -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
createAndLinkNewFirmClientAccount
Isolated FunctionRemote Function
function createAndLinkNewFirmClientAccount(NewFirmClientAccountRequestModel payload, string xAvalaraClient) returns FirmClientLinkageOutputModel|errorRequest a new FirmClient account and create an approved linkage to it
Parameters
- payload NewFirmClientAccountRequestModel - Information about the account you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FirmClientLinkageOutputModel|error - Success
requestFreeTrial
Isolated FunctionRemote Function
function requestFreeTrial(FreeTrialRequestModel payload) returns NewAccountModel|errorFREE API - Request a free trial of AvaTax
Parameters
- payload FreeTrialRequestModel - Required information to provision a free trial account.
Return Type
- NewAccountModel|error - Success
fundingRequestStatus
Isolated FunctionRemote Function
function fundingRequestStatus(int id, string xAvalaraClient) returns FundingStatusModel|errorRetrieve status about a funding setup request
Parameters
- id int - The unique ID number of this funding request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FundingStatusModel|error - Success
activateFundingRequest
Isolated FunctionRemote Function
function activateFundingRequest(int id, string xAvalaraClient) returns FundingStatusModel|errorRequest the javascript for a funding setup widget
Parameters
- id int - The unique ID number of this funding request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- FundingStatusModel|error - Success
listItemsByCompany
Isolated FunctionRemote Function
function listItemsByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string? tagName, string xAvalaraClient) returns ItemModelFetchResult|errorRetrieve items for this company
Parameters
- companyId int - The ID of the company that defined these items
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxCode, classifications, parameters, tags
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- tagName string? (default ()) - Tag Name on the basis of which you want to filter Items
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemModelFetchResult|error - Success
createItems
Isolated FunctionRemote Function
function createItems(int companyId, ItemModel[] payload, string xAvalaraClient) returns ItemModel[]|errorCreate a new item
Parameters
- companyId int - The ID of the company that owns this item.
- payload ItemModel[] - The item you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
getItem
Isolated FunctionRemote Function
function getItem(int companyId, int id, string? include, string xAvalaraClient) returns ItemModel|errorRetrieve a single item
Parameters
- companyId int - The ID of the company that owns this item object
- id int - The primary key of this item
- include string? (default ()) - A comma separated list of additional data to retrieve.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
updateItem
Isolated FunctionRemote Function
function updateItem(int companyId, int id, ItemModel payload, string xAvalaraClient) returns ItemModel|errorUpdate a single item
Parameters
- companyId int - The ID of the company that this item belongs to.
- id int - The ID of the item you wish to update
- payload ItemModel - The item object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
deleteItem
Isolated FunctionRemote Function
function deleteItem(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single item
Parameters
- companyId int - The ID of the company that owns this item.
- id int - The ID of the item you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
listItemClassifications
Isolated FunctionRemote Function
function listItemClassifications(int companyId, int itemId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ItemClassificationOutputModelFetchResult|errorRetrieve classifications for an item.
Parameters
- companyId int - The company id.
- itemId int - The item id.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: productCode, systemCode
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
createItemClassifications
Isolated FunctionRemote Function
function createItemClassifications(int companyId, int itemId, ItemClassificationInputModel[] payload, string xAvalaraClient) returns ItemClassificationOutputModel[]|errorAdd classifications to an item.
Parameters
- companyId int - The company id.
- itemId int - The item id.
- payload ItemClassificationInputModel[] - The item classifications you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemClassificationOutputModel[]|error - Success
batchDeleteItemClassifications
Isolated FunctionRemote Function
function batchDeleteItemClassifications(int companyId, int itemId, string xAvalaraClient) returns ErrorDetail[]|errorDelete all classifications for an item
Parameters
- companyId int - The ID of the company that owns this item.
- itemId int - The ID of the item you wish to delete the classifications.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getItemClassification
Isolated FunctionRemote Function
function getItemClassification(int companyId, int itemId, int id, string xAvalaraClient) returns ItemClassificationOutputModel|errorRetrieve a single item classification.
Parameters
- companyId int - The company id.
- itemId int - The item id.
- id int - The item classification id.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemClassificationOutputModel|error - Success
updateItemClassification
Isolated FunctionRemote Function
function updateItemClassification(int companyId, int itemId, int id, ItemClassificationInputModel payload, string xAvalaraClient) returns ItemClassificationOutputModel|errorUpdate an item classification.
Parameters
- companyId int - The company id.
- itemId int - The item id.
- id int - The item classification id.
- payload ItemClassificationInputModel - The item object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemClassificationOutputModel|error - Success
deleteItemClassification
Isolated FunctionRemote Function
function deleteItemClassification(int companyId, int itemId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single item classification.
Parameters
- companyId int - The company id.
- itemId int - The item id.
- id int - The item classification id.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
listItemParameters
Isolated FunctionRemote Function
function listItemParameters(int companyId, int itemId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns ItemParameterModelFetchResult|errorRetrieve parameters for an item
Parameters
- companyId int - The company id
- itemId int - The item id
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemParameterModelFetchResult|error - Success
createItemParameters
Isolated FunctionRemote Function
function createItemParameters(int companyId, int itemId, ItemParameterModel[] payload, string xAvalaraClient) returns ItemParameterModel[]|errorAdd parameters to an item.
Parameters
- companyId int - The ID of the company that owns this item parameter.
- itemId int - The item id.
- payload ItemParameterModel[] - The item parameters you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemParameterModel[]|error - Success
batchDeleteItemParameters
Isolated FunctionRemote Function
function batchDeleteItemParameters(int companyId, int itemId, string xAvalaraClient) returns ErrorDetail[]|errorDelete all parameters for an item
Parameters
- companyId int - The ID of the company that owns this item.
- itemId int - The ID of the item you wish to delete the parameters.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getItemParameter
Isolated FunctionRemote Function
function getItemParameter(int companyId, int itemId, int id, string xAvalaraClient) returns ItemParameterModel|errorRetrieve a single item parameter
Parameters
- companyId int - The company id
- itemId int - The item id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemParameterModel|error - Success
updateItemParameter
Isolated FunctionRemote Function
function updateItemParameter(int companyId, int itemId, int id, ItemParameterModel payload, string xAvalaraClient) returns ItemParameterModel|errorUpdate an item parameter
Parameters
- companyId int - The company id.
- itemId int - The item id
- id int - The item parameter id
- payload ItemParameterModel - The item object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemParameterModel|error - Success
deleteItemParameter
Isolated FunctionRemote Function
function deleteItemParameter(int companyId, int itemId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single item parameter
Parameters
- companyId int - The company id
- itemId int - The item id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getItemTags
Isolated FunctionRemote Function
function getItemTags(int companyId, int itemId, string? filter, int? top, int? skip, string xAvalaraClient) returns ItemTagDetailModelFetchResult|errorRetrieve tags for an item
Parameters
- companyId int - The ID of the company that defined these items
- itemId int - The ID of the item as defined by the company that owns this tag.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: tagName
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemTagDetailModelFetchResult|error - Success
createItemTags
Isolated FunctionRemote Function
function createItemTags(int companyId, int itemId, ItemTagDetailModel[] payload, string xAvalaraClient) returns ItemTagDetailModel[]|errorCreate tags for a item
Parameters
- companyId int - The ID of the company that defined these items
- itemId int - The ID of the item as defined by the company that owns this tag.
- payload ItemTagDetailModel[] - Tags you wish to associate with the Item
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemTagDetailModel[]|error - Success
deleteItemTags
Isolated FunctionRemote Function
function deleteItemTags(int companyId, int itemId, string xAvalaraClient) returns ErrorDetail[]|errorDelete all item tags
Parameters
- companyId int - The ID of the company that defined these items.
- itemId int - The ID of the item as defined by the company that owns this tag.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
deleteItemTag
Isolated FunctionRemote Function
function deleteItemTag(int companyId, int itemId, int itemTagDetailId, string xAvalaraClient) returns ErrorDetail[]|errorDelete item tag by id
Parameters
- companyId int - The ID of the company that defined these items
- itemId int - The ID of the item as defined by the company that owns this tag.
- itemTagDetailId int - The ID of the item tag detail you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryItemsByTag
Isolated FunctionRemote Function
function queryItemsByTag(int companyId, string tag, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns ItemModelFetchResult|errorRetrieve all items associated with given tag
Parameters
- companyId int - The ID of the company that defined these items.
- tag string - The master tag to be associated with item.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxCode, classifications, parameters, tags
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemModelFetchResult|error - Success
syncItems
Isolated FunctionRemote Function
function syncItems(int companyId, SyncItemsRequestModel payload, string xAvalaraClient) returns SyncItemsResponseModel|errorSync items from a product catalog
Parameters
- companyId int - The ID of the company that owns this item.
- payload SyncItemsRequestModel - The request object.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SyncItemsResponseModel|error - Success
bulkUploadItems
Isolated FunctionRemote Function
function bulkUploadItems(int companyId, ItemBulkUploadInputModel payload, string xAvalaraClient) returns ItemBulkUploadOutputModel|errorBulk upload items from a product catalog
Parameters
- companyId int - The ID of the company that owns this items.
- payload ItemBulkUploadInputModel - The items you wish to upload.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemBulkUploadOutputModel|error - Success
queryItems
Isolated FunctionRemote Function
function queryItems(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns ItemModelFetchResult|errorRetrieve all items
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxCode, classifications, parameters, tags
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ItemModelFetchResult|error - Success
listJurisdictionOverridesByAccount
Isolated FunctionRemote Function
function listJurisdictionOverridesByAccount(int accountId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns JurisdictionOverrideModelFetchResult|errorRetrieve overrides for this account
Parameters
- accountId int - The ID of the account that owns this override
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: country, Jurisdictions
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionOverrideModelFetchResult|error - Success
createJurisdictionOverrides
Isolated FunctionRemote Function
function createJurisdictionOverrides(int accountId, JurisdictionOverrideModel[] payload, string xAvalaraClient) returns JurisdictionOverrideModel[]|errorCreate one or more overrides
Parameters
- accountId int - The ID of the account that owns this override
- payload JurisdictionOverrideModel[] - The jurisdiction override objects to create
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionOverrideModel[]|error - Success
getJurisdictionOverride
Isolated FunctionRemote Function
function getJurisdictionOverride(int accountId, int id, string xAvalaraClient) returns JurisdictionOverrideModel|errorRetrieve a single override
Parameters
- accountId int - The ID of the account that owns this override
- id int - The primary key of this override
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionOverrideModel|error - Success
updateJurisdictionOverride
Isolated FunctionRemote Function
function updateJurisdictionOverride(int accountId, int id, JurisdictionOverrideModel payload, string xAvalaraClient) returns JurisdictionOverrideModel|errorUpdate a single jurisdictionoverride
Parameters
- accountId int - The ID of the account that this jurisdictionoverride belongs to.
- id int - The ID of the jurisdictionoverride you wish to update
- payload JurisdictionOverrideModel - The jurisdictionoverride object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionOverrideModel|error - Success
deleteJurisdictionOverride
Isolated FunctionRemote Function
function deleteJurisdictionOverride(int accountId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single override
Parameters
- accountId int - The ID of the account that owns this override
- id int - The ID of the override you wish to delete
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryJurisdictionOverrides
Isolated FunctionRemote Function
function queryJurisdictionOverrides(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns JurisdictionOverrideModelFetchResult|errorRetrieve all overrides
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: country, Jurisdictions
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- JurisdictionOverrideModelFetchResult|error - Success
listLocationsByCompany
Isolated FunctionRemote Function
function listLocationsByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns LocationModelFetchResult|errorRetrieve locations for this company
Parameters
- companyId int - The ID of the company that owns these locations
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: isMarketplaceOutsideUsa, settings, parameters
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationModelFetchResult|error - Success
createLocations
Isolated FunctionRemote Function
function createLocations(int companyId, LocationModel[] payload, string xAvalaraClient) returns LocationModel[]|errorCreate a new location
Parameters
- companyId int - The ID of the company that owns this location.
- payload LocationModel[] - The location you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationModel[]|error - Success
getLocation
Isolated FunctionRemote Function
function getLocation(int companyId, int id, string? include, string xAvalaraClient) returns LocationModel|errorRetrieve a single location
Parameters
- companyId int - The ID of the company that owns this location
- id int - The primary key of this location
- include string? (default ()) - A comma separated list of additional data to retrieve.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationModel|error - Success
updateLocation
Isolated FunctionRemote Function
function updateLocation(int companyId, int id, LocationModel payload, string xAvalaraClient) returns LocationModel|errorUpdate a single location
Parameters
- companyId int - The ID of the company that this location belongs to.
- id int - The ID of the location you wish to update
- payload LocationModel - The location you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationModel|error - Success
deleteLocation
Isolated FunctionRemote Function
function deleteLocation(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single location
Parameters
- companyId int - The ID of the company that owns this location.
- id int - The ID of the location you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
validateLocation
Isolated FunctionRemote Function
function validateLocation(int companyId, int id, string xAvalaraClient) returns LocationValidationModel|errorValidate the location against local requirements
Parameters
- companyId int - The ID of the company that owns this location
- id int - The primary key of this location
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationValidationModel|error - Success
listLocationParameters
Isolated FunctionRemote Function
function listLocationParameters(int companyId, int locationId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns LocationParameterModelFetchResult|errorRetrieve parameters for a location
Parameters
- companyId int - The company id
- locationId int - The ID of the location
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: name, unit
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationParameterModelFetchResult|error - Success
createLocationParameters
Isolated FunctionRemote Function
function createLocationParameters(int companyId, int locationId, LocationParameterModel[] payload, string xAvalaraClient) returns LocationParameterModel[]|errorAdd parameters to a location.
Parameters
- companyId int - The ID of the company that owns this location parameter.
- locationId int - The location id.
- payload LocationParameterModel[] - The location parameters you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationParameterModel[]|error - Success
getLocationParameter
Isolated FunctionRemote Function
function getLocationParameter(int companyId, int locationId, int id, string xAvalaraClient) returns LocationParameterModel|errorRetrieve a single company location parameter
Parameters
- companyId int - The company id
- locationId int - The location id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationParameterModel|error - Success
updateLocationParameter
Isolated FunctionRemote Function
function updateLocationParameter(int companyId, int locationId, int id, LocationParameterModel payload, string xAvalaraClient) returns LocationParameterModel|errorUpdate a location parameter
Parameters
- companyId int - The company id.
- locationId int - The location id
- id int - The location parameter id
- payload LocationParameterModel - The location parameter object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationParameterModel|error - Success
deleteLocationParameter
Isolated FunctionRemote Function
function deleteLocationParameter(int companyId, int locationId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single location parameter
Parameters
- companyId int - The company id
- locationId int - The location id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryLocations
Isolated FunctionRemote Function
function queryLocations(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns LocationModelFetchResult|errorRetrieve all locations
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: isMarketplaceOutsideUsa, settings, parameters
- include string? (default ()) - A comma separated list of additional data to retrieve. You may specify
LocationSettingsto retrieve location settings.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- LocationModelFetchResult|error - Success
listMultiDocumentTransactions
Isolated FunctionRemote Function
function listMultiDocumentTransactions(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns MultiDocumentModelFetchResult|errorRetrieve all MultiDocument transactions
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: documents
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModelFetchResult|error - Success
createMultiDocumentTransaction
Isolated FunctionRemote Function
function createMultiDocumentTransaction(CreateMultiDocumentModel payload, string? include, string xAvalaraClient) returns MultiDocumentModel|errorCreate a new MultiDocument transaction
Parameters
- payload CreateMultiDocumentModel - the multi document transaction model
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
getMultiDocumentTransactionByCodeAndType
Isolated FunctionRemote Function
function getMultiDocumentTransactionByCodeAndType(string code, string 'type, string? include, string xAvalaraClient) returns MultiDocumentModel|errorRetrieve a MultiDocument transaction
Parameters
- code string - The multidocument code to retrieve
- 'type string - The transaction type to retrieve
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
adjustMultiDocumentTransaction
Isolated FunctionRemote Function
function adjustMultiDocumentTransaction(string code, string 'type, AdjustMultiDocumentModel payload, string? include, string xAvalaraClient) returns MultiDocumentModel|errorAdjust a MultiDocument transaction
Parameters
- code string - The transaction code for this MultiDocument transaction
- 'type string - The transaction type for this MultiDocument transaction
- payload AdjustMultiDocumentModel - The adjust request you wish to execute
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
auditMultiDocumentTransaction
Isolated FunctionRemote Function
function auditMultiDocumentTransaction(string code, string 'type, string xAvalaraClient) returns AuditMultiDocumentModel|errorGet audit information about a MultiDocument transaction
Parameters
- code string - The transaction code for this MultiDocument transaction
- 'type string - The transaction type for this MultiDocument transaction
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AuditMultiDocumentModel|error - Success
refundMultiDocumentTransaction
Isolated FunctionRemote Function
function refundMultiDocumentTransaction(string code, string 'type, RefundTransactionModel payload, string? include, string xAvalaraClient) returns MultiDocumentModel|errorCreate a refund for a MultiDocument transaction
Parameters
- code string - The code of this MultiDocument transaction
- 'type string - The type of this MultiDocument transaction
- payload RefundTransactionModel - Information about the refund to create
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
voidMultiDocumentTransaction
Isolated FunctionRemote Function
function voidMultiDocumentTransaction(string code, string 'type, VoidTransactionModel payload, string xAvalaraClient) returns MultiDocumentModel|errorVoid a MultiDocument transaction
Parameters
- code string - The transaction code for this MultiDocument transaction
- 'type string - The transaction type for this MultiDocument transaction
- payload VoidTransactionModel - The void request you wish to execute
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
getMultiDocumentTransactionById
Isolated FunctionRemote Function
function getMultiDocumentTransactionById(int id, string? include, string xAvalaraClient) returns MultiDocumentModel|errorRetrieve a MultiDocument transaction by ID
Parameters
- id int - The unique ID number of the MultiDocument transaction to retrieve
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
commitMultiDocumentTransaction
Isolated FunctionRemote Function
function commitMultiDocumentTransaction(CommitMultiDocumentModel payload, string xAvalaraClient) returns MultiDocumentModel|errorCommit a MultiDocument transaction
Parameters
- payload CommitMultiDocumentModel - The commit request you wish to execute
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
verifyMultiDocumentTransaction
Isolated FunctionRemote Function
function verifyMultiDocumentTransaction(VerifyMultiDocumentModel payload, string xAvalaraClient) returns MultiDocumentModel|errorVerify a MultiDocument transaction
Parameters
- payload VerifyMultiDocumentModel - Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- MultiDocumentModel|error - Success
listNexusByCompany
Isolated FunctionRemote Function
function listNexusByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve nexus for this company
Parameters
- companyId int - The ID of the company that owns these nexus objects
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
createNexus
Isolated FunctionRemote Function
function createNexus(int companyId, NexusModel[] payload, string xAvalaraClient) returns NexusModel[]|errorCreate a new nexus
Parameters
- companyId int - The ID of the company that owns this nexus.
- payload NexusModel[] - The nexus you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModel[]|error - Success
getNexus
Isolated FunctionRemote Function
function getNexus(int companyId, int id, string? include, string xAvalaraClient) returns NexusModel|errorRetrieve a single nexus
Parameters
- companyId int - The ID of the company that owns this nexus object
- id int - The primary key of this nexus
- include string? (default ()) -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModel|error - Success
updateNexus
Isolated FunctionRemote Function
function updateNexus(int companyId, int id, NexusModel payload, string xAvalaraClient) returns NexusModel|errorUpdate a single nexus
Parameters
- companyId int - The ID of the company that this nexus belongs to.
- id int - The ID of the nexus you wish to update
- payload NexusModel - The nexus object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModel|error - Success
deleteNexus
Isolated FunctionRemote Function
function deleteNexus(int companyId, int id, boolean? cascadeDelete, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single nexus
Parameters
- companyId int - The ID of the company that owns this nexus.
- id int - The ID of the nexus you wish to delete.
- cascadeDelete boolean? (default ()) - If true, deletes all the child nexus if they exist along with parent nexus
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
listNexusParameters
Isolated FunctionRemote Function
function listNexusParameters(int companyId, int nexusId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusParameterDetailModelFetchResult|errorRetrieve parameters for a nexus
Parameters
- companyId int - The company id
- nexusId int - The nexus id
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: name, unit
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusParameterDetailModelFetchResult|error - Success
createNexusParameters
Isolated FunctionRemote Function
function createNexusParameters(int companyId, int nexusId, NexusParameterDetailModel[] payload, string xAvalaraClient) returns NexusParameterDetailModel[]|errorAdd parameters to a nexus.
Parameters
- companyId int - The ID of the company that owns this nexus parameter.
- nexusId int - The nexus id.
- payload NexusParameterDetailModel[] - The nexus parameters you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusParameterDetailModel[]|error - Success
deleteNexusParameters
Isolated FunctionRemote Function
function deleteNexusParameters(int companyId, int nexusId, string xAvalaraClient) returns ErrorDetail[]|errorDelete all parameters for an nexus
Parameters
- companyId int - The ID of the company that owns this nexus.
- nexusId int - The ID of the nexus you wish to delete the parameters.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getNexusParameter
Isolated FunctionRemote Function
function getNexusParameter(int companyId, int nexusId, int id, string xAvalaraClient) returns NexusParameterDetailModel|errorRetrieve a single nexus parameter
Parameters
- companyId int - The company id
- nexusId int - The nexus id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusParameterDetailModel|error - Success
updateNexusParameter
Isolated FunctionRemote Function
function updateNexusParameter(int companyId, int nexusId, int id, NexusParameterDetailModel payload, string xAvalaraClient) returns NexusParameterDetailModel|errorUpdate an nexus parameter
Parameters
- companyId int - The company id.
- nexusId int - The nexus id
- id int - The nexus parameter id
- payload NexusParameterDetailModel - The nexus object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusParameterDetailModel|error - Success
deleteNexusParameter
Isolated FunctionRemote Function
function deleteNexusParameter(int companyId, int nexusId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single nexus parameter
Parameters
- companyId int - The company id
- nexusId int - The nexus id
- id int - The parameter id
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
declareNexusByAddress
Isolated FunctionRemote Function
function declareNexusByAddress(int companyId, DeclareNexusByAddressModel[] payload, string xAvalaraClient) returns NexusByAddressModel[]|errorCreates nexus for a list of addresses.
Parameters
- companyId int - The ID of the company that will own this nexus.
- payload DeclareNexusByAddressModel[] - The nexus you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusByAddressModel[]|error - Success
getNexusByFormCode
Isolated FunctionRemote Function
function getNexusByFormCode(int companyId, string formCode, string? include, string xAvalaraClient) returns NexusByTaxFormModel|errorList company nexus related to a tax form
Parameters
- companyId int - The ID of the company that owns this nexus object
- formCode string - The form code that we are looking up the nexus for
- include string? (default ()) -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusByTaxFormModel|error - Success
listNexusByCompanyAndTaxTypeGroup
Isolated FunctionRemote Function
function listNexusByCompanyAndTaxTypeGroup(int companyId, string taxTypeGroup, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve nexus for this company By TaxTypeGroup
Parameters
- companyId int - The ID of the company that owns these nexus objects
- taxTypeGroup string - Name of TaxTypeGroup to filter by
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
queryNexus
Isolated FunctionRemote Function
function queryNexus(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns NexusModelFetchResult|errorRetrieve all nexus
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NexusModelFetchResult|error - Success
createNoticeResponsibilityType
Isolated FunctionRemote Function
function createNoticeResponsibilityType(CreateNoticeResponsibilityTypeModel payload, string xAvalaraClient) returns NoticeResponsibilityModel|errorCreates a new tax notice responsibility type.
Parameters
- payload CreateNoticeResponsibilityTypeModel - The responsibility type to create
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeResponsibilityModel|error - Success
deleteNoticeResponsibilityType
Isolated FunctionRemote Function
function deleteNoticeResponsibilityType(int responsibilityId, string xAvalaraClient) returns ErrorDetail[]|errorDelete a tax notice responsibility type.
Parameters
- responsibilityId int - The unique ID of the responsibility type
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
createNoticeRootCauseType
Isolated FunctionRemote Function
function createNoticeRootCauseType(CreateNoticeRootCauseTypeModel payload, string xAvalaraClient) returns NoticeRootCauseModel|errorCreates a new tax notice root cause type.
Parameters
- payload CreateNoticeRootCauseTypeModel - The root cause type to create
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NoticeRootCauseModel|error - Success
deleteNoticeRootCauseType
Isolated FunctionRemote Function
function deleteNoticeRootCauseType(int rootCauseId, string xAvalaraClient) returns ErrorDetail[]|errorDelete a tax notice root cause type.
Parameters
- rootCauseId int - The unique ID of the root cause type
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
listNotifications
Isolated FunctionRemote Function
function listNotifications(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns NotificationModelFetchResult|errorList all notifications.
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NotificationModelFetchResult|error - Success
createNotifications
Isolated FunctionRemote Function
function createNotifications(NotificationModel[] payload, string xAvalaraClient) returns NotificationModel[]|errorCreate new notifications.
Parameters
- payload NotificationModel[] - The notifications you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NotificationModel[]|error - Success
getNotification
Isolated FunctionRemote Function
function getNotification(int id, string xAvalaraClient) returns NotificationModel|errorRetrieve a single notification.
Parameters
- id int - The id of the notification to retrieve.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NotificationModel|error - Success
updateNotification
Isolated FunctionRemote Function
function updateNotification(int id, NotificationModel payload, string xAvalaraClient) returns NotificationModel|errorUpdate a single notification.
Parameters
- id int - The id of the notification you wish to update.
- payload NotificationModel - The notification object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NotificationModel|error - Success
deleteNotification
Isolated FunctionRemote Function
function deleteNotification(int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single notification.
Parameters
- id int - The id of the notification you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
dismissNotification
Isolated FunctionRemote Function
function dismissNotification(int id, string xAvalaraClient) returns NotificationModel|errorMark a single notification as dismissed.
Parameters
- id int - The id of the notification you wish to mark as dismissed.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NotificationModel|error - Success
requestNewEntitlement
Isolated FunctionRemote Function
function requestNewEntitlement(int id, string offer, string xAvalaraClient) returns OfferModel|errorRequest a new entitilement to an existing customer
Parameters
- id int - The avatax account id of the customer
- offer string - The offer to be added to an already existing customer
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- OfferModel|error - Success
requestNewAccount
Isolated FunctionRemote Function
function requestNewAccount(NewAccountRequestModel payload, string xAvalaraClient) returns NewAccountModel|errorRequest a new Avalara account
Parameters
- payload NewAccountRequestModel - Information about the account you wish to create and the selected product offerings.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- NewAccountModel|error - Success
listAccountsByTssWriteMode
Isolated FunctionRemote Function
function listAccountsByTssWriteMode(string writeMode, string xAvalaraClient) returns AccountMigrationStatusModel|errorRetrieve List of Accounts by Account Migration Status
Parameters
- writeMode string -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AccountMigrationStatusModel|error - Success
resetPassword
Isolated FunctionRemote Function
function resetPassword(int userId, SetPasswordModel payload, boolean unmigrateFromAi, string xAvalaraClient) returns string|errorReset a user's password programmatically
Parameters
- userId int - The unique ID of the user whose password will be changed
- payload SetPasswordModel - The new password for this user
- unmigrateFromAi boolean (default false) - If user's password was migrated to AI, undo this.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
initiateExportDocumentLineReport
Isolated FunctionRemote Function
function initiateExportDocumentLineReport(int companyId, ExportDocumentLineModel payload, string xAvalaraClient) returns ReportModel[]|errorInitiate an ExportDocumentLine report task
Parameters
- companyId int - The unique ID number of the company to report on.
- payload ExportDocumentLineModel - Options that may be configured to customize the report.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ReportModel[]|error - Success
listReports
Isolated FunctionRemote Function
function listReports(int? companyId, string? pageKey, int? skip, int top, string xAvalaraClient) returns ReportModelFetchResult|errorList all report tasks for account
Parameters
- companyId int? (default ()) - The id of the company for which to get reports.
- pageKey string? (default ()) - Provide a page key to retrieve the next page of results.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- top int (default 25) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ReportModelFetchResult|error - Success
getReport
Isolated FunctionRemote Function
function getReport(int id, string xAvalaraClient) returns ReportModel|errorRetrieve a single report
Parameters
- id int - The unique ID number of the report to retrieve
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ReportModel|error - Success
downloadReport
Isolated FunctionRemote Function
Download a report
Parameters
- id int - The unique ID number of this report
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
listSettingsByCompany
Isolated FunctionRemote Function
function listSettingsByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns SettingModelFetchResult|errorRetrieve all settings for this company
Parameters
- companyId int - The ID of the company that owns these settings
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: modifiedDate, ModifiedUserId
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SettingModelFetchResult|error - Success
createSettings
Isolated FunctionRemote Function
function createSettings(int companyId, SettingModel[] payload, string xAvalaraClient) returns SettingModel[]|errorCreate a new setting
Parameters
- companyId int - The ID of the company that owns this setting.
- payload SettingModel[] - The setting you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SettingModel[]|error - Success
getSetting
Isolated FunctionRemote Function
function getSetting(int companyId, int id, string xAvalaraClient) returns SettingModel|errorRetrieve a single setting
Parameters
- companyId int - The ID of the company that owns this setting
- id int - The primary key of this setting
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SettingModel|error - Success
updateSetting
Isolated FunctionRemote Function
function updateSetting(int companyId, int id, SettingModel payload, string xAvalaraClient) returns SettingModel|errorUpdate a single setting
Parameters
- companyId int - The ID of the company that this setting belongs to.
- id int - The ID of the setting you wish to update
- payload SettingModel - The setting you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SettingModel|error - Success
deleteSetting
Isolated FunctionRemote Function
function deleteSetting(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single setting
Parameters
- companyId int - The ID of the company that owns this setting.
- id int - The ID of the setting you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
querySettings
Isolated FunctionRemote Function
function querySettings(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns SettingModelFetchResult|errorRetrieve all settings
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: modifiedDate, ModifiedUserId
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SettingModelFetchResult|error - Success
listSubscriptionsByAccount
Isolated FunctionRemote Function
function listSubscriptionsByAccount(int accountId, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns SubscriptionModelFetchResult|errorRetrieve subscriptions for this account
Parameters
- accountId int - The ID of the account that owns these subscriptions
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: subscriptionDescription
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModelFetchResult|error - Success
createSubscriptions
Isolated FunctionRemote Function
function createSubscriptions(int accountId, SubscriptionModel[] payload, string xAvalaraClient) returns SubscriptionModel[]|errorCreate a new subscription
Parameters
- accountId int - The ID of the account that owns this subscription.
- payload SubscriptionModel[] - The subscription you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModel[]|error - Success
getSubscription
Isolated FunctionRemote Function
function getSubscription(int accountId, int id, string xAvalaraClient) returns SubscriptionModel|errorRetrieve a single subscription
Parameters
- accountId int - The ID of the account that owns this subscription
- id int - The primary key of this subscription
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModel|error - Success
updateSubscription
Isolated FunctionRemote Function
function updateSubscription(int accountId, int id, SubscriptionModel payload, string xAvalaraClient) returns SubscriptionModel|errorUpdate a single subscription
Parameters
- accountId int - The ID of the account that this subscription belongs to.
- id int - The ID of the subscription you wish to update
- payload SubscriptionModel - The subscription you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModel|error - Success
deleteSubscription
Isolated FunctionRemote Function
function deleteSubscription(int accountId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single subscription
Parameters
- accountId int - The ID of the account that owns this subscription.
- id int - The ID of the subscription you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
querySubscriptions
Isolated FunctionRemote Function
function querySubscriptions(string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns SubscriptionModelFetchResult|errorRetrieve all subscriptions
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: subscriptionDescription
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModelFetchResult|error - Success
listTaxCodesByCompany
Isolated FunctionRemote Function
function listTaxCodesByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxCodeModelFetchResult|errorRetrieve tax codes for this company
Parameters
- companyId int - The ID of the company that owns these tax codes
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeModelFetchResult|error - Success
createTaxCodes
Isolated FunctionRemote Function
function createTaxCodes(int companyId, TaxCodeModel[] payload, string xAvalaraClient) returns TaxCodeModel[]|errorCreate a new tax code
Parameters
- companyId int - The ID of the company that owns this tax code.
- payload TaxCodeModel[] - The tax code you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeModel[]|error - Success
getTaxCode
Isolated FunctionRemote Function
function getTaxCode(int companyId, int id, string xAvalaraClient) returns TaxCodeModel|errorRetrieve a single tax code
Parameters
- companyId int - The ID of the company that owns this tax code
- id int - The primary key of this tax code
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeModel|error - Success
updateTaxCode
Isolated FunctionRemote Function
function updateTaxCode(int companyId, int id, TaxCodeModel payload, string xAvalaraClient) returns TaxCodeModel|errorUpdate a single tax code
Parameters
- companyId int - The ID of the company that this tax code belongs to.
- id int - The ID of the tax code you wish to update
- payload TaxCodeModel - The tax code you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeModel|error - Success
deleteTaxCode
Isolated FunctionRemote Function
function deleteTaxCode(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single tax code
Parameters
- companyId int - The ID of the company that owns this tax code.
- id int - The ID of the tax code you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryTaxCodes
Isolated FunctionRemote Function
function queryTaxCodes(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxCodeModelFetchResult|errorRetrieve all tax codes
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxCodeModelFetchResult|error - Success
buildTaxContentFileForLocation
Isolated FunctionRemote Function
function buildTaxContentFileForLocation(int companyId, int id, string? date, string? format, string? partnerId, boolean? includeJurisCodes, string xAvalaraClient) returns string|errorBuild a tax content file for a single location
Parameters
- companyId int - The ID number of the company that owns this location.
- id int - The ID number of the location to retrieve point-of-sale data.
- date string? (default ()) - The date for which point-of-sale data would be calculated (today by default)
- format string? (default ()) - The format of the file (JSON by default)
- partnerId string? (default ()) - If specified, requests a custom partner-formatted version of the file.
- includeJurisCodes boolean? (default ()) - When true, the file will include jurisdiction codes in the result.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
buildTaxContentFile
Isolated FunctionRemote Function
function buildTaxContentFile(PointOfSaleDataRequestModel payload, string xAvalaraClient) returns string|errorBuild a multi-location tax content file
Parameters
- payload PointOfSaleDataRequestModel - Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
taxRatesByAddress
Isolated FunctionRemote Function
function taxRatesByAddress(string line1, string region, string postalCode, string country, string? line2, string? line3, string? city, string xAvalaraClient) returns TaxRateModel|errorSales tax rates for a specified address
Parameters
- line1 string - The street address of the location.
- region string - Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: Two and three character ISO 3166 region codes. Fully spelled out names of the region in ISO supported languages. Common alternative spellings for many regions. For a full list of all supported codes and names, please see the Definitions API
ListRegions.
- postalCode string - The postal code of the location.
- country string - Name or ISO 3166 code identifying the country. This field supports many different country identifiers: Two character ISO 3166 codes. Three character ISO 3166 codes. Fully spelled out names of the country in ISO supported languages. Common alternative spellings for many countries. For a full list of all supported codes and names, please see the Definitions API
ListCountries.
- line2 string? (default ()) - The street address of the location.
- line3 string? (default ()) - The street address of the location.
- city string? (default ()) - The city name of the location.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRateModel|error - Success
taxRatesByPostalCode
Isolated FunctionRemote Function
function taxRatesByPostalCode(string country, string postalCode, string xAvalaraClient) returns TaxRateModel|errorSales tax rates for a specified country and postal code. This API is only available for US postal codes.
Parameters
- country string - Name or ISO 3166 code identifying the country. This field supports many different country identifiers: Two character ISO 3166 codes. Three character ISO 3166 codes. Fully spelled out names of the country in ISO supported languages. Common alternative spellings for many countries. For a full list of all supported codes and names, please see the Definitions API
ListCountries.
- postalCode string - The postal code of the location.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRateModel|error - Success
downloadTaxRatesByZipCode
Isolated FunctionRemote Function
function downloadTaxRatesByZipCode(string date, string? region, string xAvalaraClient) returns string|errorDownload a file listing tax rates by postal code
Parameters
- date string - The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
- region string? (default ()) - A two character region code which limits results to a specific region.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
listTaxRules
Isolated FunctionRemote Function
function listTaxRules(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxRuleModelFetchResult|errorRetrieve tax rules for this company
Parameters
- companyId int - The ID of the company that owns these tax rules
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRuleModelFetchResult|error - Success
createTaxRules
Isolated FunctionRemote Function
function createTaxRules(int companyId, TaxRuleModel[] payload, string xAvalaraClient) returns TaxRuleModel[]|errorCreate a new tax rule
Parameters
- companyId int - The ID of the company that owns this tax rule.
- payload TaxRuleModel[] - The tax rule you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRuleModel[]|error - Success
getTaxRule
Isolated FunctionRemote Function
function getTaxRule(int companyId, int id, string xAvalaraClient) returns TaxRuleModel|errorRetrieve a single tax rule
Parameters
- companyId int - The ID of the company that owns this tax rule
- id int - The primary key of this tax rule
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRuleModel|error - Success
updateTaxRule
Isolated FunctionRemote Function
function updateTaxRule(int companyId, int id, TaxRuleModel payload, string xAvalaraClient) returns TaxRuleModel|errorUpdate a single tax rule
Parameters
- companyId int - The ID of the company that this tax rule belongs to.
- id int - The ID of the tax rule you wish to update
- payload TaxRuleModel - The tax rule you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRuleModel|error - Success
deleteTaxRule
Isolated FunctionRemote Function
function deleteTaxRule(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single tax rule
Parameters
- companyId int - The ID of the company that owns this tax rule.
- id int - The ID of the tax rule you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryTaxRules
Isolated FunctionRemote Function
function queryTaxRules(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns TaxRuleModelFetchResult|errorRetrieve all tax rules
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TaxRuleModelFetchResult|error - Success
listTransactionsByCompany
Isolated FunctionRemote Function
function listTransactionsByCompany(string companyCode, int? dataSourceId, string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns TransactionModelFetchResult|errorRetrieve all transactions
Parameters
- companyCode string - The company code of the company that recorded this transaction
- dataSourceId int? (default ()) - Optionally filter transactions to those from a specific data source.
- include string? (default ()) - Specifies objects to include in this fetch call
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModelFetchResult|error - Success
getTransactionByCode
Isolated FunctionRemote Function
function getTransactionByCode(string companyCode, string transactionCode, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorRetrieve a single transaction by code
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to retrieve
- documentType string? (default ()) - (Optional): The document type of the transaction to retrieve
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
adjustTransaction
Isolated FunctionRemote Function
function adjustTransaction(string companyCode, string transactionCode, AdjustTransactionModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorCorrect a previously created transaction
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to adjust
- payload AdjustTransactionModel - The adjustment you wish to make
- documentType string? (default ()) - (Optional): The document type of the transaction to adjust.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
auditTransaction
Isolated FunctionRemote Function
function auditTransaction(string companyCode, string transactionCode, string xAvalaraClient) returns AuditTransactionModel|errorGet audit information about a transaction
Parameters
- companyCode string - The code identifying the company that owns this transaction
- transactionCode string - The code identifying the transaction
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AuditTransactionModel|error - Success
changeTransactionCode
Isolated FunctionRemote Function
function changeTransactionCode(string companyCode, string transactionCode, ChangeTransactionCodeModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorChange a transaction's code
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to change
- payload ChangeTransactionCodeModel - The code change request you wish to execute
- documentType string? (default ()) - (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
commitTransaction
Isolated FunctionRemote Function
function commitTransaction(string companyCode, string transactionCode, CommitTransactionModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorCommit a transaction for reporting
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to commit
- payload CommitTransactionModel - The commit request you wish to execute
- documentType string? (default ()) - (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
lockTransaction
Isolated FunctionRemote Function
function lockTransaction(string companyCode, string transactionCode, LockTransactionModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorLock a single transaction
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to lock
- payload LockTransactionModel - The lock request you wish to execute
- documentType string? (default ()) - (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
refundTransaction
Isolated FunctionRemote Function
function refundTransaction(string companyCode, string transactionCode, RefundTransactionModel payload, string? include, string? documentType, boolean useTaxDateOverride, string xAvalaraClient) returns TransactionModel|errorCreate a refund for a transaction
Parameters
- companyCode string - The code of the company that made the original sale
- transactionCode string - The transaction code of the original sale
- payload RefundTransactionModel - Information about the refund to create
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- documentType string? (default ()) - (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice.
- useTaxDateOverride boolean (default false) - (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
settleTransaction
Isolated FunctionRemote Function
function settleTransaction(string companyCode, string transactionCode, SettleTransactionModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorPerform multiple actions on a transaction
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to settle
- payload SettleTransactionModel - The data from an external system to reconcile against AvaTax
- documentType string? (default ()) - (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
getTransactionByCodeAndType
Isolated FunctionRemote Function
function getTransactionByCodeAndType(string companyCode, string transactionCode, string documentType, string? include, string xAvalaraClient) returns TransactionModel|errorRetrieve a single transaction by code
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to retrieve
- documentType string - The transaction type to retrieve
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
auditTransactionWithType
Isolated FunctionRemote Function
function auditTransactionWithType(string companyCode, string transactionCode, string documentType, string xAvalaraClient) returns AuditTransactionModel|errorGet audit information about a transaction
Parameters
- companyCode string - The code identifying the company that owns this transaction
- transactionCode string - The code identifying the transaction
- documentType string - The document type of the original transaction
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- AuditTransactionModel|error - Success
uncommitTransaction
Isolated FunctionRemote Function
function uncommitTransaction(string companyCode, string transactionCode, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorUncommit a transaction for reporting
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to Uncommit
- documentType string? (default ()) - (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
unvoidTransaction
Isolated FunctionRemote Function
function unvoidTransaction(string companyCode, string transactionCode, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorUnvoids a transaction
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to commit
- documentType string? (default ()) - (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
verifyTransaction
Isolated FunctionRemote Function
function verifyTransaction(string companyCode, string transactionCode, VerifyTransactionModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorVerify a transaction
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to settle
- payload VerifyTransactionModel - The data from an external system to reconcile against AvaTax
- documentType string? (default ()) - (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
voidTransaction
Isolated FunctionRemote Function
function voidTransaction(string companyCode, string transactionCode, VoidTransactionModel payload, string? documentType, string? include, string xAvalaraClient) returns TransactionModel|errorVoid a transaction
Parameters
- companyCode string - The company code of the company that recorded this transaction
- transactionCode string - The transaction code to void
- payload VoidTransactionModel - The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
- documentType string? (default ()) - (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice.
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
addLines
Isolated FunctionRemote Function
function addLines(AddTransactionLineModel payload, string? include, string xAvalaraClient) returns TransactionModel|errorAdd lines to an existing unlocked transaction
Parameters
- payload AddTransactionLineModel - information about the transaction and lines to be added
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
deleteLines
Isolated FunctionRemote Function
function deleteLines(RemoveTransactionLineModel payload, string? include, string xAvalaraClient) returns TransactionModel|errorRemove lines from an existing unlocked transaction
Parameters
- payload RemoveTransactionLineModel - information about the transaction and lines to be removed
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
getTransactionById
Isolated FunctionRemote Function
function getTransactionById(int id, string? include, string xAvalaraClient) returns TransactionModel|errorRetrieve a single transaction by ID
Parameters
- id int - The unique ID number of the transaction to retrieve
- include string? (default ()) - Specifies objects to include in this fetch call
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
createTransaction
Isolated FunctionRemote Function
function createTransaction(CreateTransactionModel payload, string? include, string xAvalaraClient) returns TransactionModel|errorCreate a new transaction
Parameters
- payload CreateTransactionModel - The transaction you wish to create
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
createOrAdjustTransaction
Isolated FunctionRemote Function
function createOrAdjustTransaction(CreateOrAdjustTransactionModel payload, string? include, string xAvalaraClient) returns TransactionModel|errorCreate or adjust a transaction
Parameters
- payload CreateOrAdjustTransactionModel - The transaction you wish to create or adjust
- include string? (default ()) - Specifies objects to include in the response after transaction is created
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- TransactionModel|error - Success
bulkLockTransaction
Isolated FunctionRemote Function
function bulkLockTransaction(BulkLockTransactionModel payload, string xAvalaraClient) returns BulkLockTransactionResult|errorLock a set of documents
Parameters
- payload BulkLockTransactionModel - bulk lock request
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- BulkLockTransactionResult|error - Success
listUPCsByCompany
Isolated FunctionRemote Function
function listUPCsByCompany(int companyId, string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns UPCModelFetchResult|errorRetrieve UPCs for this company
Parameters
- companyId int - The ID of the company that owns these UPCs
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UPCModelFetchResult|error - Success
createUPCs
Isolated FunctionRemote Function
function createUPCs(int companyId, UPCModel[] payload, string xAvalaraClient) returns UPCModel[]|errorCreate a new UPC
Parameters
- companyId int - The ID of the company that owns this UPC.
- payload UPCModel[] - The UPC you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
getUPC
Isolated FunctionRemote Function
Retrieve a single UPC
Parameters
- companyId int - The ID of the company that owns this UPC
- id int - The primary key of this UPC
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
updateUPC
Isolated FunctionRemote Function
function updateUPC(int companyId, int id, UPCModel payload, string xAvalaraClient) returns UPCModel|errorUpdate a single UPC
Parameters
- companyId int - The ID of the company that this UPC belongs to.
- id int - The ID of the UPC you wish to update
- payload UPCModel - The UPC you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
deleteUPC
Isolated FunctionRemote Function
function deleteUPC(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single UPC
Parameters
- companyId int - The ID of the company that owns this UPC.
- id int - The ID of the UPC you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
queryUPCs
Isolated FunctionRemote Function
function queryUPCs(string? filter, string? include, int? top, int? skip, string? orderby, string xAvalaraClient) returns UPCModelFetchResult|errorRetrieve all UPCs
Parameters
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
- include string? (default ()) - A comma separated list of additional data to retrieve.
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UPCModelFetchResult|error - Success
listUserDefinedFieldsByCompanyId
Isolated FunctionRemote Function
function listUserDefinedFieldsByCompanyId(int companyId, string udfType, boolean allowDefaults, string xAvalaraClient) returns CompanyUserDefinedFieldModelFetchResult|errorSecurity Policies
- This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
- This API depends on the following active services:Required (all): AvaTaxPro, BasicReturns.
Parameters
- companyId int -
- udfType string (default "Document") - Document or Line level UDF
- allowDefaults boolean (default true) - If true this will add defaulted UDFs to the list that are not named yet
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyUserDefinedFieldModelFetchResult|error - Success
updateUserDefinedField
Isolated FunctionRemote Function
function updateUserDefinedField(int companyId, CompanyUserDefinedFieldModel payload, int? id, string xAvalaraClient) returns CompanyUserDefinedFieldModel|errorUpdate a User Defined Field identified by id for a company
Parameters
- companyId int - The id of the company the user defined field belongs to.
- payload CompanyUserDefinedFieldModel -
- id int? (default ()) -
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- CompanyUserDefinedFieldModel|error - Success
deleteUserDefinedField
Isolated FunctionRemote Function
function deleteUserDefinedField(int companyId, int id, string xAvalaraClient) returns ErrorDetail[]|errorDelete a User Defined Field by User Defined Field id for a company.
Parameters
- companyId int - The id of the company the User Defined Field belongs to.
- id int - The id of the User Defined Field you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
listUsersByAccount
Isolated FunctionRemote Function
function listUsersByAccount(int accountId, string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns UserModelFetchResult|errorRetrieve users for this account
Parameters
- accountId int - The accountID of the user you wish to list.
- include string? (default ()) - Optional fetch commands.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: SuppressNewUserEmail
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UserModelFetchResult|error - Success
createUsers
Isolated FunctionRemote Function
function createUsers(int accountId, UserModel[] payload, string xAvalaraClient) returns UserModel[]|errorCreate new users
Parameters
- accountId int - The unique ID number of the account where these users will be created.
- payload UserModel[] - The user or array of users you wish to create.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
getUser
Isolated FunctionRemote Function
function getUser(int id, int accountId, string? include, string xAvalaraClient) returns UserModel|errorRetrieve a single user
Parameters
- id int - The ID of the user to retrieve.
- accountId int - The accountID of the user you wish to get.
- include string? (default ()) - Optional fetch commands.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
updateUser
Isolated FunctionRemote Function
function updateUser(int id, int accountId, UserModel payload, string xAvalaraClient) returns UserModel|errorUpdate a single user
Parameters
- id int - The ID of the user you wish to update.
- accountId int - The accountID of the user you wish to update.
- payload UserModel - The user object you wish to update.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
deleteUser
Isolated FunctionRemote Function
function deleteUser(int id, int accountId, string xAvalaraClient) returns ErrorDetail[]|errorDelete a single user
Parameters
- id int - The ID of the user you wish to delete.
- accountId int - The accountID of the user you wish to delete.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- ErrorDetail[]|error - Success
getUserEntitlements
Isolated FunctionRemote Function
function getUserEntitlements(int id, int accountId, string xAvalaraClient) returns UserEntitlementModel|errorRetrieve all entitlements for a single user
Parameters
- id int - The ID of the user to retrieve.
- accountId int - The accountID of the user you wish to get.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UserEntitlementModel|error - Success
changePassword
Isolated FunctionRemote Function
function changePassword(PasswordChangeModel payload, string xAvalaraClient) returns string|errorChange Password
Parameters
- payload PasswordChangeModel - An object containing your current password and the new password.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
queryUsers
Isolated FunctionRemote Function
function queryUsers(string? include, string? filter, int? top, int? skip, string? orderby, string xAvalaraClient) returns UserModelFetchResult|errorRetrieve all users
Parameters
- include string? (default ()) - Optional fetch commands.
- filter string? (default ()) - A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.<br />Not filterable: SuppressNewUserEmail
- top int? (default ()) - If nonzero, return no more than this number of results. Used with
$skipto provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
- skip int? (default ()) - If nonzero, skip this number of results before returning data. Used with
$topto provide pagination for large datasets.
- orderby string? (default ()) - A comma separated list of sort statements in the format
(fieldname) [ASC|DESC], for exampleid ASC.
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- UserModelFetchResult|error - Success
ping
Isolated FunctionRemote Function
function ping(string xAvalaraClient) returns PingResultModel|errorTests connectivity and version of the service
Parameters
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- PingResultModel|error - Success
listMySubscriptions
Isolated FunctionRemote Function
function listMySubscriptions(string xAvalaraClient) returns SubscriptionModelFetchResult|errorList all services to which the current user is subscribed
Parameters
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModelFetchResult|error - Success
getMySubscription
Isolated FunctionRemote Function
function getMySubscription(string serviceTypeId, string xAvalaraClient) returns SubscriptionModel|errorChecks if the current user is subscribed to a specific service
Parameters
- serviceTypeId string - The service to check
- xAvalaraClient string (default "Swagger UI; 21.12.0; Custom; 1.0") - Identifies the software you are using to call this API. For more information on the client header, see Client Headers .
Return Type
- SubscriptionModel|error - Success
Records
avatax: AccountConfigurationModel
Represents one configuration setting for this account
Fields
- accountId? int - The unique ID number of the account to which this setting applies
- category string - The category of the configuration setting. Avalara-defined categories include
AddressServiceConfigandTaxServiceConfig. Customer-defined categories begin withX-.
- name string - The name of the configuration setting
- value? string - The current value of the configuration setting
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: AccountLicenseKeyModel
An account user who is permitted to use AvaTax.
Fields
- name string - The unique name for license key per account
- accountId int - AccountId for required license key
- createdDate? string - The date when this record was created.
- createdUserId? int - The user id for the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user id of user who last modified this record.
avatax: AccountMigrationStatusModel
An AvaTax account.
Fields
- accountId int - The unique ID number assigned to this account.
- accountName? string - The name of this account.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- accountMigrationStatusId? int - The Tss Read Write Mode.
avatax: AccountModel
An AvaTax account.
Fields
- id int - The unique ID number assigned to this account.
- crmid? string - For system registrar use only.
- name string - The name of this account.
- effectiveDate? string - The earliest date on which this account may be used.
- endDate? string - If this account has been closed, this is the last date the account was open.
- accountStatusId? string - The current status of this account.
- accountTypeId? string - The type of this account.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- subscriptions? SubscriptionModel[] - Optional: A list of subscriptions granted to this account. To fetch this list, add the query string "?$include=Subscriptions" to your URL.
- users? UserModel[] - Optional: A list of all the users belonging to this account. To fetch this list, add the query string "?$include=Users" to your URL.
- isSamlEnabled? boolean - Is Saml based authentication used by this account for user to login via AI.
avatax: AccountModelFetchResult
Fields
- '\@recordsetCount? int -
- value? AccountModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ActivateAccountModel
Represents a request to activate an account by reading and accepting its terms and conditions.
Fields
- acceptAvalaraTermsAndConditions? boolean - Set this to true if and only if you accept Avalara's terms and conditions for your account.
- haveReadAvalaraTermsAndConditions? boolean - Set this to true if and only if you have fully read Avalara's terms and conditions for your account.
avatax: AddressesModel
Information about all the addresses involved in this transaction.
For a physical in-person transaction at a retail point-of-sale location, please specify only one address using
the singleLocation field.
For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to
a destination location such as a customer, please specify the shipFrom and shipTo addresses.
In the United States, some jurisdictions recognize the address types pointOfOrderOrigin and pointOfOrderAcceptance.
These address types affect the sourcing models of some transactions.
If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses.
Fields
- singleLocation? AddressLocationInfo - Represents an address to resolve.
- shipFrom? AddressLocationInfo - Represents an address to resolve.
- shipTo? AddressLocationInfo - Represents an address to resolve.
- pointOfOrderOrigin? AddressLocationInfo - Represents an address to resolve.
- pointOfOrderAcceptance? AddressLocationInfo - Represents an address to resolve.
- goodsPlaceOrServiceRendered? AddressLocationInfo - Represents an address to resolve.
- 'import? AddressLocationInfo - Represents an address to resolve.
- billTo? AddressLocationInfo - Represents an address to resolve.
avatax: AddressInfo
Represents a base address element.
Fields
- line1? string - First line of the street address
- line2? string - Second line of the street address
- line3? string - Third line of the street address
- city? string - City component of the address
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- postalCode? string - Postal Code / Zip Code component of the address.
- latitude? decimal - Geospatial latitude measurement, in Decimal Degrees floating point format.
- longitude? decimal - Geospatial longitude measurement, in Decimal Degrees floating point format.
avatax: AddressLocationInfo
Represents an address to resolve.
Fields
- locationCode? string - If you wish to use the address of an existing location for this company, specify the address here.
Otherwise, leave this value empty.
The
locationCodefield on this object allows you to quickly use the address of an existinglocationModelobject instead of having to retype the address completely. This field does not affect the behavior of transactions that must be filed on location-based tax returns. To specify how a transaction will be reported on location-based tax returns, please see thereportingLocationCodefield on the CreateTransactionModel element.
- line1? string - First line of the street address
- line2? string - Second line of the street address
- line3? string - Third line of the street address
- city? string - City component of the address
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- postalCode? string - Postal Code / Zip Code component of the address.
- latitude? decimal - Geospatial latitude measurement, in Decimal Degrees floating point format.
- longitude? decimal - Geospatial longitude measurement, in Decimal Degrees floating point format.
avatax: AddressResolutionModel
Address Resolution Model
Fields
- address? AddressInfo - Represents a base address element.
- validatedAddresses? ValidatedAddressInfo[] - The validated address or addresses
- coordinates? CoordinateInfo - Coordinate Info
- resolutionQuality? string - The resolution quality of the geospatial coordinates
- taxAuthorities? TaxAuthorityInfo[] - List of informational and warning messages regarding this address
- messages? AvaTaxMessage[] - List of informational and warning messages regarding this address
avatax: AddressValidationInfo
TextCase info for input address
Fields
- line1? string - First line of the street address
- textCase? string - Specify the text case for the validated address result. If not specified, will return uppercase.
- line2? string - Second line of the street address
- line3? string - Third line of the street address
- city? string - City component of the address
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- postalCode? string - Postal Code / Zip Code component of the address.
- latitude? decimal - Geospatial latitude measurement, in Decimal Degrees floating point format.
- longitude? decimal - Geospatial longitude measurement, in Decimal Degrees floating point format.
avatax: AddTransactionLineModel
Model to add specific lines to exising transaction
Fields
- companyCode string - company code
- transactionCode string - document code for the transaction to add lines
- documentType? string - document type
- lines LineItemModel[] - List of lines to be added
- renumber? boolean - Option to renumber lines after add. After renumber, the line number becomes: "1", "2", "3", ...
avatax: AdjustMultiDocumentModel
Replace an existing MultiDocument transaction recorded in AvaTax with a new one.
Fields
- adjustmentReason string - A reason code indicating why this adjustment was made
- adjustDescription? string - If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other).
- newTransaction CreateMultiDocumentModel - A MultiDocument transaction represents a sale or purchase that occurred between more than two companies. A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately.
avatax: AdjustTransactionModel
Replace an existing transaction recorded in AvaTax with a new one.
Fields
- adjustmentReason string - A reason code indicating why this adjustment was made
- adjustmentDescription? string - If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other).
- newTransaction CreateTransactionModel - Create a transaction
avatax: AdvancedRuleCustomerDataSchemaModel
Model for retrieving customer data schema
Fields
- ruleId? string - Unique identifier for the rule
- customerDataSchema? string - Customer data schema
avatax: AdvancedRuleExecutionModel
Model representing an execution of an advanced rule for a company
Fields
- ruleExecutionId? string - Rule execution unique identifier
- name string - Name of rule execution
- startDate? string - Date rule execution starts
- endDate? string - Date rule execution ends
- enabled? boolean - Is rule execution enabled
- continueOnError? boolean - Should we keep running if we hit an exception
- ruleId string - Unique identifier of rule to execute
- rule? AdvancedRuleModel - A generic global advanced rule encapsulating a script
- customerData? string - Json data used for rule execution
- customerDataId? string - Unique identifier of customer data used in rule execution
avatax: AdvancedRuleExecutionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? AdvancedRuleExecutionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: AdvancedRuleExecutionOrderModel
Model for updating rule execution order
Fields
- ruleExecutionIds string[] - The rule execution Ids in the desired order
avatax: AdvancedRuleFullDetailsModel
Model for Advanced Rules when full details are requested
Fields
- script string - The code script for the rule
- customerDataValidatorScript? string - Script run for validating customer data
- isApproved? boolean - Has the rule been approved
- createdBy? string - Creator of the rule
- createdOn? string - When the rule was created
- modifiedBy? string - Last updater of the rule
- modifiedOn? string - When the rule was last updated
- approvedBy? string - Approver of the rule
- isSystemRule? boolean - Is this a system rule as opposed to customer-facing
- isVisibleInCUP? boolean - Is the rule displayed in the CUP UI
- isTest? boolean - Is this a rule created for testing
- customerDataSchema? string - The JSON schema for customer data if it is required for the rule
- 'version? int - The version of the rule
- accountsVisibleFor? int[] - Account Ids the rule is visible for in CUP, when IsVisibleInCUP = false
- ruleId? string - Unique identifier for a rule
- name string - Rule name
- description? string - Description of the rule
- arEntitlementRequired? boolean - Advance Rules limited availability
- executionPosition? string - Execution position. Both, Before or After
avatax: AdvancedRuleFullDetailsModelFetchResult
Fields
- '\@recordsetCount? int -
- value? AdvancedRuleFullDetailsModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: AdvancedRuleLookupFileModel
Model representing a lookup file for a company
Fields
- lookupFileId? string - LookupFile unique identifier
- id? string - CompanyLookupFile unique identifier
- name string - Name of lookup file
- content string - Content of the lookup file.
- fileExtension string - File extension (e.g. CSV).
- isTest? boolean - Is this a lookup file created for testing
- inUse? boolean - Is this a lookup file in use for any rule
- 'version? int - Lookup file version
- createdDate? string - Lookup file CreatedDate
- modifiedDate? string - Lookup file ModifiedDate
avatax: AdvancedRuleLookupFileModelFetchResult
Fields
- '\@recordsetCount? int -
- value? AdvancedRuleLookupFileModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: AdvancedRuleModel
A generic global advanced rule encapsulating a script
Fields
- ruleId? string - Unique identifier for a rule
- name string - Rule name
- description? string - Description of the rule
- arEntitlementRequired? boolean - Advance Rules limited availability
- executionPosition? string - Execution position. Both, Before or After
avatax: AdvancedRuleVisibilityModel
Model for toggling visibility of an advanced rule for an account
Fields
- isVisible? boolean - Should the rule be visible or not visible
- accountId? int - The account Id for which the rule is to be visible/not visible
avatax: ApproveAdvancedRuleModel
Model for changing the approved status of an advanced rule
Fields
- isApproved? boolean - Should the rule be approved
avatax: ApproveFilingsModel
Approve a set of filings.
Fields
- approve boolean - Set this value to true in order to approve the filings.
avatax: AuditEvent
Fields
- auditEventId? int -
- transactionId? int -
- auditEventLevelId? int -
- eventTimestamp? string -
- 'source? string -
- summary? string -
- details? string -
avatax: AuditModel
Provides detailed information about an API call.
The information on this record was captured by AvaTax when your API call was made. If you are unsure why you
received an error, you can fetch these audit objects and examine the RequestUrl, RequestBody, and ErrorMessage
fields to determine root cause for the error.
Fields
- transactionId? int - A unique ID number referring to this individual API call.
- accountId? int - The unique ID number of the account to which the user belongs.
- userId? int - The unique ID number of the user that performed this API call.
- ipAddress? string - The origin IP address from which AvaTax received this API call. If you use a proxy layer or other gateway, this IP address may be the address of the gateway. This information is not guaranteed to be accurate and may change based on network conditions between your site and AvaTax.
- machineName? string - If your API call specified a
MachineNamein the Client Profile Headers, this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.
- clientName? string - If your API call specified a
ClientNamein the Client Profile Headers, this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.
- clientVersion? string - If your API call specified a
ClientVersionin the Client Profile Headers, this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.
- adapterName? string - If your API call specified a
AdapterNamein the Client Profile Headers, this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.
- adapterVersion? string - If your API call specified a
AdapterVersionin the Client Profile Headers, this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present.
- serverName? string - The server name of the AvaTax server that responded to this API call.
- serverVersion? string - The software version number of the currently deployed AvaTax API software on the server that responded to this API call.
- referenceId? int - A context-dependent reference ID for this API call. This reference ID is not guaranteed to contain a specific value and may be used differently by various API calls.
- severityLevelId? int - If the API contained a specific type of error code, this value would contain the unique ID number of the severity level of the response returned to the client.
- serverTimestamp? string - The server timestamp, in UTC, of the time when the server received this API call.
- serverDuration? int - The number of milliseconds that the AvaTax server took to respond to this API call.
- serviceName? string - The service name of the AvaTax API service that responded to this API call.
- operation? string - The operation name of this API call.
- referenceCode? string - A context-dependent reference code for this API call. This reference code is not guaranteed to contain a specific value and may be used differently by various API calls.
- errorMessage? string - If this API call reported an error, this contains the name of the error that was returned. You can look up more information about AvaTax error messages on the AvaTax REST Error Page.
- auditMessage? string - Reserved for Avalara internal usage.
- loadBalancerDuration? int - Reserved for Avalara internal usage.
- recordCount? int - If this API call returned an array of information, this value contains the number of records returned.
- referenceAuthorization? string - Reserved for Avalara internal usage.
- isQueued? boolean - Reserved for Avalara internal usage.
- databaseCallCount? int - If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced. Please note that not all data layers support this measurement.
- databaseCallDuration? string - If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests. Please note that not all data layers support this measurement.
- remoteCallDuration? string - If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services.
- events? AuditEvent[] - Reserved for Avalara internal usage.
- requestUrl? string - The original request URL as provided by the client.
- requestBody? string - If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client. This request body is represented as a string, exactly as it was received from the client. Regardless of whether the request was JSON, Base64 encoded bytes, or a CSV file, this contains the exact contents of the request body.
- responseStatus? int - The HTTP response code that was sent by the server.
- responseBody? string - The entire response body sent from the AvaTax server to the client. This value is returned as a string regardless of whether the results were JSON-formatted text, CSV files, or raw strings.
- remoteCalls? AuditModel[] - Reserved for Avalara internal usage.
avatax: AuditModelFetchResult
Fields
- '\@recordsetCount? int -
- value? AuditModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: AuditMultiDocumentModel
Information about a previously created MultiDocument transaction
Fields
- reconstructed? ReconstructedMultiDocumentModel - Contains information about the original API request and response that created a MultiDocument object.
- code? string - Represents the unique code of this MultiDocument transaction.
A MultiDocument transaction is uniquely identified by its
accountId,code, andtype.
- 'type? string - Represents the document type of this MultiDocument transaction. For more information about
document types, see DocumentType.
A MultiDocument transaction is uniquely identified by its
accountId,code, andtype.
- serverTimestamp? string - Server timestamp, in UTC, of the date/time when the original transaction was created
- serverDuration? string - Length of time the original API call took
- apiCallStatus? string - api call status
- original? OriginalApiRequestResponseModel - Represents the exact API request and response from the original transaction API call, if available
avatax: AuditTransactionModel
Information about a previously created transaction
Fields
- companyId? int - Unique ID number of the company that created this transaction
- reconstructed? ReconstructedApiRequestResponseModel - This model contains a reconstructed CreateTransaction request object that could potentially be used to recreate this transaction. Note that the API changes over time, and this reconstructed model is likely different from the exact request that was originally used to create this transaction.
- serverTimestamp? string - Server timestamp, in UTC, of the date/time when the original transaction was created
- serverDuration? string - Length of time the original API call took
- apiCallStatus? string - api call status
- original? OriginalApiRequestResponseModel - Represents the exact API request and response from the original transaction API call, if available
avatax: AvaFileFormModel
Represents information about a tax form known to Avalara
Fields
- id? int - Unique Id of the form
- returnName? string - Name of the file being returned
- formName? string - Name of the submitted form
- description? string - A description of the submitted form
- effDate? string - The date this form starts to take effect
- endDate? string - The date the form finishes to take effect
- region? string - State/Province/Region where the form is submitted for
- country? string - The country this form is submitted for
- formTypeId? string - The type of the form being submitted
- filingOptionTypeId? string - The type of Filing option
- dueDateTypeId? string - The type of the due date
- dueDay? int - Due date
- efileDueDateTypeId? string - The type of E-file due date.
- efileDueDay? int - The date by when the E-filing should be submitted
- efileDueTime? string - The time of day by when the E-filing should be submitted
- hasVendorDiscount? boolean - Whether the customer has discount
- roundingTypeId? string - The way system does the rounding
- outletTypeId? string - The outlet type of the form
avatax: AvaFileFormModelFetchResult
Fields
- '\@recordsetCount? int -
- value? AvaFileFormModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: AvailableCycleModel
Available Cycle object
Fields
- transactionalPeriodStart? string - Transactional Period Start
- transactionalPeriodEnd? string - Transactional Period End
- filingDueDate? string - Filing Due Date
- cycleName? string - Cycle Name
avatax: AvaTaxMessage
Informational or warning messages returned by AvaTax with a transaction
Fields
- summary? string - A brief summary of what this message tells us
- details? string - Detailed information that explains what the summary provided
- refersTo? string - Information about what object in your request this message refers to
- severity? string - A category that indicates how severely this message affects the results
- 'source? string - The name of the code or service that generated this message
avatax: BatchAdjustTransactionModel
Replace an existing transaction recorded in AvaTax with a new one.
Fields
- companyCode string - Specifies the code of the company for this transaction.
- transactionCode string - Please specify the transaction code of the transacion to void.
- documentType? string - Specifies the type of document to void.
- adjustmentReason string - A reason code indicating why this adjustment was made
- adjustmentDescription? string - If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other).
- newTransaction CreateTransactionModel - Create a transaction
avatax: BatchFileModel
Represents one file in a batch upload.
Fields
- id? int - The unique ID number assigned to this batch file.
- batchId? int - The unique ID number of the batch that this file belongs to.
- name? string - Logical Name of file (e.g. "Input" or "Error").
- content string - Content of the batch file.
- contentLength? int - Size of content, in bytes.
- contentType? string - Content mime type (e.g. text/csv). This is used for HTTP downloading.
- fileExtension? string - File extension (e.g. CSV).
- filePath? string - Path to the file - name/S3 key
- errorCount? int - Number of errors that occurred when processing this file.
avatax: BatchModel
Represents a batch of uploaded documents.
Fields
- 'type string - The type of this batch.
- batchAgent? string - The agent used to create this batch
- options? string - Any optional flags provided for this batch
- id? int - The unique ID number of this batch.
- name string - The user-friendly readable name for this batch.
- accountId? int - The Account ID number of the account that owns this batch.
- companyId? int - The Company ID number of the company that owns this batch.
- status? string - This batch's current processing status
- startedDate? string - The date/time when this batch started processing
- recordCount? int - The number of records in this batch; determined by the server
- currentRecord? int - The current record being processed
- completedDate? string - The date/time when this batch was completely processed
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- files? BatchFileModel[] - The list of files contained in this batch.
avatax: BatchModelFetchResult
Fields
- '\@recordsetCount? int -
- value? BatchModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: BatchVoidTransactionModel
A request to void a previously created transaction.
Fields
- companyCode string - Company Code - Specify the code of the company for this transaction.
- transactionCode string - Please specify the transaction code of the transacion to void.
- documentType? string - Specifies the type of document to void.
- code string - Please specify the reason for voiding or cancelling this transaction. To void the transaction, please specify the reason 'DocVoided'. If you do not provide a reason, the void command will fail.
avatax: BulkLockTransactionModel
Bulk lock documents model
Fields
- documentIds int[] - List of documents to lock
- isLocked boolean - The lock status to set for the documents designated in this API
avatax: BulkLockTransactionResult
Returns information about transactions that were locked
Fields
- numberOfRecords? int - Number of records that have been modified
avatax: CertExpressInvitationModel
Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record.
Fields
- id? int - A unique ID number representing this CertExpress invitation.
- companyId? int - The unique ID number of the AvaTax company that sent this invitation.
- recipient? string - The email address to which this invitation was sent. If this invitation was presented as a weblink, this value will be null.
- customerCode? string - The unique code of the customer that received this invitation. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer.
- customer? CustomerModel - Represents a customer to whom you sell products and/or services.
- coverLetter? CoverLetterModel - The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent.
- emailStatus? string - The status of the emails associated with this invitation. If this invitation was sent via email,
this value will change to
Sentwhen the email message has been sent.
- coverLettersOnly? boolean - True if this invitation contained a cover letter only.
- exposureZones? int[] - When an invitation is sent, it contains a list of exposure zones for which the customer is invited to upload
their exemption certificates. This list contains the ID numbers of the exposure zones identified.
For a list of exposure zones, please call
ListCertificateExposureZones.
- exemptReasons? int[] - The list of exemption reasons identified by this CertExpress invitation.
For a list of reason codes, please call
ListCertificateExemptReasons.
- deliveryMethod? string - Indicates the method that was used to deliver this CertExpress invitation.
- message? string - The custom message delivered with this invitation.
- date? string - The date of the invitation.
- requestLink? string - The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation.
This value is only usable if the status of this invitation is
Readyand the request was created with typeDownload. NOTE: This link usually takes a few minutes to be available.
avatax: CertExpressInvitationModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CertExpressInvitationModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CertExpressInvitationStatusModel
Represent what is the current status of certificate request
Fields
- status? string - The status of the CertExpress invitation for this customer. If this status says
- invitation? CertExpressInvitationModel - Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record.
avatax: CertificateAttributeModel
A certificate attribute can be thought of as a feature or flag that is applied to a certificate.
A single certificate can be linked to zero, one, or many certificate attributes. The full list of
attributes can be obtained by calling the ListCertificateAttributes API.
Fields
- id? int - A unique ID number representing this certificate attribute.
- name? string - A friendly readable name for this certificate attribute.
- description? string - A full help text description of the certificate attribute.
- isSystemCode? boolean - This value is true if this is a system-defined certificate attribute. System-defined attributes cannot be modified or deleted on the CertCapture website.
avatax: CertificateAttributeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CertificateAttributeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CertificateModel
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on criteria you specify when you store the certificate. To view or manage your certificates directly, please log onto the administrative website for the product you purchased.
Fields
- id? int - Unique ID number of this certificate.
- companyId? int - The unique ID number of the AvaTax company that recorded this certificate.
- signedDate string - The date when this certificate was signed.
- expirationDate string - Expiration date when this certificate will no longer be valid.
- filename? string - File name for the image of this certificate.
When creating a certificate, if you do not upload a PDF or JPG image, you must specify the filename
of the certificate as it is tracked in your repository.
To create a certificate, you must provide one of the following fields: either a
filename, apdffile, or an array of JPGpages. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.
- documentExists? boolean - This value is true if there exists scanned PDF copy of this certificate or the PDF version of the form that the customer filled via the CertCapture wizard on S3 bucket.
- valid? boolean - True if this certificate is marked as valid. A valid certificate can be considered for exemption purposes. When a certificate is marked invalid, it will no longer be considered when calculating exemption for a customer.
- verified? boolean - This value is true if the certificate has gone through the certificate validation process. For more information on the certificate validation process, please see the Avalara Help Center.
- exemptPercentage? decimal - If this certificate provides exemption from transactional taxes, what percentage of the transaction is considered exempt? For a fully exempt certificate, this percentage should be 100.
- isSingleCertificate? boolean - This value is true if this certificate is a single (or standalone) certificate. This value is set during the audit stage of the certificate validation process.
- exemptionNumber? string - Indicates the tax number passed in for the certificate.
- validatedExemptionReason? ExemptionReasonModel - An exemption reason defines why a certificate allows a customer to be exempt
for purposes of tax calculation. For a full list of defined exemption reasons,
please call the
ListCertificateExemptionReasonsAPI.
- exemptionReason ExemptionReasonModel - An exemption reason defines why a certificate allows a customer to be exempt
for purposes of tax calculation. For a full list of defined exemption reasons,
please call the
ListCertificateExemptionReasonsAPI.
- status? string - The status of the certificate
- createdDate? string - The date/time when this record was created.
- modifiedDate? string - The date/time when this record was last modified.
- taxNumberType? string - The tax number type for the certificate. For example,
FEIN,Social Security Number, orEmployer Identification Number.
- businessNumberType? string - Description of business for the certificate. For example,
Retail trade,Professional services, orConstruction.
- pageCount? int - Number of pages contained within this certificate.
- customers? CustomerModel[] - A list of customers to which this certificate applies. You can fetch this data by specifying
$include=customerswhen calling a certificate fetch API.
- poNumbers? PoNumberModel[] - A list of purchase order numbers that are valid for use with this certificate.
If this certificate is applicable for all purchase order numbers, this field will be empty.
You can fetch this data by specifying
$include=po_numberswhen calling a certificate fetch API.
- exposureZone ExposureZoneModel - Information about a physical area or zone in which a certificate can apply. An exposure zone for an exemption certificate will generally be a tax authority such as a state, country, or local government entity.
- attributes? CertificateAttributeModel[] - A list of certificate attributes that apply to this certificate.
You can fetch this data by specifying
$include=attributeswhen calling a certificate fetch API.
- ecmsId? int - The unique ID number of current AvaTax Exemption Certificate that refers this certificate.
- ecmsStatus? string - The status of current AvaTax Exemption Certificate that refers to this certificate.
- pdf? string - This field is available for input only. To retrieve the image after creation, use the
DownloadCertificateImageAPI. When creating a certificate, you may optionally provide a PDF image in Base64 URLEncoded format. PDFs are automatically parsed into individual page JPG images and can be retrieved back later as either the original PDF or the individual pages. To create a certificate, you must provide one of the following fields: either afilename, apdffile, or an array of JPGpages. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.
- pages? string[] - This field is available for input only. To retrieve the image after creation, use the
DownloadCertificateImageAPI. When creating a certificate, you may optionally provide a list of JPG images, one per page, in Base64 URLEncoded format. These JPG images are automatically combined into a single downloadable PDF and can be retrieved back later as either the original JPG images or the combined PDF. To create a certificate, you must provide one of the following fields: either afilename, apdffile, or an array of JPGpages. The API will return an error if you omit these fields or if you attempt to put values in more than one of them.
avatax: CertificateModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CertificateModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ChangeTransactionCodeModel
Settle this transaction with your ledger by verifying its amounts. If the transaction is not yet committed, you may specify the "commit" value to commit it to the ledger and allow it to be reported. You may also optionally change the transaction's code by specifying the "newTransactionCode" value.
Fields
- newCode string - To change the transaction code for this transaction, specify the new transaction code here.
avatax: ClassificationModel
Represents a classification for a given item.
Fields
- productCode string - The product code of an item in a given system.
- systemCode? string - The system code in which the product belongs.
avatax: ClassificationParameterUsageMapModel
usage of system defined parameters.
Fields
- id? int - The unique ID number of this property.
- parameterId? int - The id of the parameter.
- taxTypeGroupId? string - tax type group id for the classification parameter usage item.
- visibility? string - This defines if the parameter is recommeded ,optional or mandatory
- attributeType? string - The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
- name? string - The name of the property. To use this property, add a field on the
parametersobject of a CreateTransaction call.
- dataType? string - The data type of the property.
- helpText? string - Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.
- label? string - Label that helps the user to identify a parameter
- helpUrl? string - A help url that provides more information about the parameter
- values? string[] - If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
- measurementType? string - The unit of measurement type of the parameter
avatax: ClassificationParameterUsageMapModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ClassificationParameterUsageMapModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
avatax: CommitMultiDocumentModel
Commit this MultiDocument object so that all transactions within it can be reported on a tax filing.
Fields
- code string - Represents the unique code of this MultiDocument transaction.
A MultiDocument transaction is uniquely identified by its
accountId,code, andtype. ///
- 'type? string - Represents the document type of this MultiDocument transaction. For more information about
document types, see DocumentType.
A MultiDocument transaction is uniquely identified by its
accountId,code, andtype.
- 'commit boolean - Set this value to be
trueto commit this transaction. Committing a transaction allows it to be reported on a tax filing. Uncommitted transactions will not be reported.
avatax: CommitTransactionModel
Commit this transaction as permanent so that it can be reported on a tax filing.
Fields
- 'commit boolean - Set this value to be
trueto commit this transaction. Committing a transaction allows it to be reported on a tax filing. Uncommitted transactions will not be reported.
avatax: CommunicationsTransactionTypeModel
Represents information about a type of telecommunications transaction
Fields
- transactionTypeId int - The numeric Id of the transaction type.
- 'AvaTax\.Communications\.TransactionType? string - The name of the transaction type.
avatax: CommunicationsTransactionTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CommunicationsTransactionTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CommunicationsTSPairModel
Represents a transaction/service type pair for telecommunications tax
Fields
- transactionTypeId int - The numeric Id of the transaction type.
- serviceTypeId int - The numeric Id of the service type.
- 'AvaTax\.Communications\.TransactionType? string - The name of the transaction type.
- 'AvaTax\.Communications\.ServiceType? string - The name of the service type.
- description? string - The description of the transaction/service type pair.
- requiredParameters? string[] - List of the parameters (among Charge, Minutes and Lines) that will be used for calculation for this T/S pair.
avatax: CommunicationsTSPairModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CommunicationsTSPairModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CompanyAddress
Company Address Information
Fields
- line string - Address Line1
- city? string - City
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- postalCode string - Postal Code
avatax: CompanyConfigurationModel
Represents one configuration setting for this company
Fields
- companyId? int - The unique ID number of the account to which this setting applies
- category string - The category of the configuration setting. Avalara-defined categories include
AddressServiceConfigandTaxServiceConfig. Customer-defined categories begin withX-.
- name string - The name of the configuration setting
- value? string - The current value of the configuration setting
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: CompanyDistanceThresholdModel
A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes.
Distance thresholds only apply to sales of goods in certain countries. A distance threshold is applied for each ship-from/ship-to combination of countries. The threshold amount is defined by the ship-to country.
Generally, if you have exceeded a distance threshold for taxes between a pair of countries, your tax calculation will be determined to be the rate in the destination country. If you have not exceeded the threshold, your tax calculation will be determined to be the rate in the origin country.
The amount of a threshold is not tracked or managed in AvaTax, but the decision of your tax compliance department as to whether you have exceeded this threshold is maintained in this object.
By default, you are considered to have exceeded tax thresholds. If you wish to change this default, you can create a company-distance-threshold object to select the correct behavior for this origin/destination tax calculation process.
Fields
- id? int - A unique ID number representing this distance threshold object.
- companyId? int - The ID number of the company that defined this distance threshold.
- originCountry string - The origin country for this threshold.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- destinationCountry string - The destination country for this threshold.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- effDate? string - For distance threshold values that change over time, this is the earliest date for which this distance
threshold is valid. If null, this distance threshold is valid for all dates earlier than the
endDatefield.
- endDate? string - For distance threshold values that change over time, this is the latest date for which this distance
threshold is valid. If null, this distance threshold is valid for all dates later than the
effDatefield.
- thresholdExceeded? boolean - True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries.
If you set this value to
false, your value added taxes will be calculated using the origin country. Otherwise, value added taxes will be calculated on the destination country.
- 'type string - Indicates the distance threshold type.
This value can be either
SaleorPurchase.
avatax: CompanyDistanceThresholdModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CompanyDistanceThresholdModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CompanyInitializationModel
Company Initialization Model
Fields
- name string - Company Name
- companyCode? string - Company Code - used to distinguish between companies within your accounting system
- vatRegistrationId? string - Vat Registration Id - leave blank if not known.
- taxpayerIdNumber? string - United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
- isFein? boolean - Set this field to true if the taxPayerIdNumber is a FEIN.
- line1 string - Address Line1
- line2? string - Line2
- line3? string - Line3
- city string - City
- region string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- postalCode string - Postal Code
- country string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- firstName string - First Name
- lastName string - Last Name
- title? string - Title
- email string - Email
- phoneNumber string - Phone Number
- mobileNumber? string - Mobile Number
- faxNumber? string - Fax Number
- parentCompanyId? int - Parent Company ID
avatax: CompanyModel
A company or business entity.
Fields
- id int - The unique ID number of this company.
- accountId int - The unique ID number of the account this company belongs to.
- parentCompanyId? int - If this company is fully owned by another company, this is the unique identity of the parent company.
- sstPid? string - If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board.
- companyCode? string - A unique code that references this company within your account.
- name string - The name of this company, as shown to customers.
- isDefault? boolean - This flag is true if this company is the default company for this account. Only one company may be set as the default.
- defaultLocationId? int - If set, this is the unique ID number of the default location for this company.
- isActive? boolean - This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions.
- taxpayerIdNumber? string - For United States companies, this field contains your Taxpayer Identification Number. This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation, or SSN for a Social Security Number if this company is a person. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
- isFein? boolean - Set this field to true if the taxPayerIdNumber is a FEIN.
- hasProfile? boolean - Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent.
- isReportingEntity? boolean - Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company.
- sstEffectiveDate? string - If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program.
- defaultCountry string - The two character ISO-3166 country code of the default country for this company.
- baseCurrencyCode? string - This is the three character ISO-4217 currency code of the default currency used by this company.
- roundingLevelId? string - Indicates whether this company prefers to round amounts at the document level or line level.
- warningsEnabled? boolean - Set this value to true to receive warnings in API calls via SOAP.
- isTest? boolean - Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes.
- taxDependencyLevelId? string - Used to apply tax detail dependency at a jurisdiction level.
- inProgress? boolean - Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions.
- businessIdentificationNo? string - Business Identification No
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- contacts? ContactModel[] - Optional: A list of contacts defined for this company. To fetch this list, add the query string
?$include=Contactsto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- items? ItemModel[] - Optional: A list of items defined for this company. To fetch this list, add the query string
?$include=Itemsto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- locations? LocationModel[] - Optional: A list of locations defined for this company. To fetch this list, add the query string
?$include=Locationsto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- nexus? NexusModel[] - Optional: A list of nexus defined for this company. To fetch this list, add the query string
?$include=Nexusto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- settings? SettingModel[] - Optional: A list of settings defined for this company. To fetch this list, add the query string
?$include=Settingsto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- taxCodes? TaxCodeModel[] - Optional: A list of tax codes defined for this company. To fetch this list, add the query string
?$include=TaxCodesto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- taxRules? TaxRuleModel[] - Optional: A list of tax rules defined for this company. To fetch this list, add the query string
?$include=TaxRulesto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- upcs? UPCModel[] - Optional: A list of UPCs defined for this company. To fetch this list, add the query string
?$include=UPCsto your URL. When callingCreateCompany, you may provide a list of objects in this element and they will be created alongside the company. TheUpdateCompanyAPI does not permit updating nested objects.
- nonReportingChildCompanies? CompanyModel[] - Optional: A list of non reporting child companies associated with this company. To fetch this list, add the query string
?$include=NonReportingChildrento your URL.
- exemptCerts? EcmsModel[] - DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the
ListCertificatesAPI.
- mossId? string - The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing.
- mossCountry? string - The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing.
- parameters? CompanyParameterDetailModel[] - The parameters of a company
- supplierandcustomers? CustomerSupplierModel[] - The customers and suppliers of a company
avatax: CompanyModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CompanyModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CompanyParameterDetailModel
Represents a parameter associated with a company.
Fields
- id? int - Identifier for company parameter
- companyId? int - CompanyId associated with the parameter
- name string - The parameter's name
- value string - The value of the parameter
- unit? string - The unit of measurement code for the parameter
avatax: CompanyParameterDetailModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CompanyParameterDetailModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CompanyReturnSettingModel
Fields
- id? int - The unique ID of this CompanyReturnsSetting
- companyReturnId int - The CompanyReturn Id
- filingQuestionId int - The TaxFormCatalog filingQuestionId.
- filingQuestionCode? string - Filing question code as defined in TaxFormCatalog.
- value? string - The value of this setting
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: CompanyUserDefinedFieldModel
Fields
- id? int - The id of the datasource.
- companyId? int - The id of the company to which the datasource belongs to.
- name string - The extractor/connector id.
- friendlyName string - The unique ID number of this connection.
- dataType? string - The unique ID number of this connection.
- userDefinedFieldType? string - The category of user defined type For Example: Document level or Line level UDF.
- createdUserId? int - The User ID of the user who created this record.
- createdDate? string - The date when this record was created.
- modifiedUserId? int - The user ID of the user who last modified this record.
- modifiedDate? string - The date/time when this record was last modified.
avatax: CompanyUserDefinedFieldModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CompanyUserDefinedFieldModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ComplianceAggregatedTaxRateModel
A model for aggregated rates.
Fields
- rate? decimal - The compontent rate.
- stackRate? decimal - The stack rate based on the aggregation method.
- effectiveDate? string - The date this rate is starts to take effect.
- endDate? string - The date this rate is no longer active.
- taxTypeId? string - The tax type of the rate.
- rateTypeId? string - The rate type of the rate.
avatax: ComplianceJurisdictionModel
Model for distinct jurisdictions.
Fields
- taxRegionId? int - The id of the tax region.
- stateAssignedCode? string - The state assigned code for the jurisdiction.
- jurisdictionTypeId? string - The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
- name? string - The name of the jurisdiction.
- county? string - The name of the county.
- city? string - The name of the city.
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country of this jurisdiction.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- taxRegionName? string - The name of the tax region.
- taxAuthorityId? int - The id of the tax authority.
- rates? ComplianceAggregatedTaxRateModel[] - Optional: A list of rates for this jurisdiction. To fetch this list, add the query string
?$include=TaxRatesto your URL.
avatax: ComplianceJurisdictionRateModel
A flattened model for jurisdictions and rates.
Fields
- jurisdictionId? int - The id of the jurisdiction.
- country? string - Name or ISO 3166 code identifying the country of this jurisdiction.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- name? string - The name of the jurisdiction.
- jurisdictionTypeId? string - The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
- rate? decimal - The compontent rate.
- rateTypeId? string - The rate type.
- taxTypeId? string - The tax type.
- effectiveDate? string - The date this rate is starts to take effect.
- endDate? string - The date this rate is no longer active.
- stateAssignedCode? string - The state assigned code.
- taxAuthorityId? int - The id of the tax authority.
avatax: ComplianceTaxRateModel
The tax rate model.
Fields
- id? int - The unique id of the rate.
- rate? decimal - The tax rate.
- jurisdictionId? int - The id of the jurisdiction.
- taxRegionId? int - The id of the tax region.
- effectiveDate? string - The date this rate is starts to take effect.
- endDate? string - The date this rate is no longer active.
- rateTypeId? string - The rate type.
- taxTypeId? string - The tax type.
- taxName? string - The name of the tax.
- unitOfBasisId? int - The unit of basis.
- rateTypeTaxTypeMappingId? int - The rate type tax type mapping id.
avatax: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
avatax: ContactModel
A contact person for a company.
Fields
- id? int - The unique ID number of this contact.
- companyId? int - The unique ID number of the company to which this contact belongs.
- contactCode string - A unique code for this contact.
- firstName? string - The first or given name of this contact.
- middleName? string - The middle name of this contact.
- lastName? string - The last or family name of this contact.
- title? string - Professional title of this contact.
- line1? string - The first line of the postal mailing address of this contact.
- line2? string - The second line of the postal mailing address of this contact.
- line3? string - The third line of the postal mailing address of this contact.
- city? string - The city of the postal mailing address of this contact.
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- postalCode? string - The postal code or zip code of the postal mailing address of this contact.
- country? string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- email? string - The email address of this contact.
- phone? string - The main phone number for this contact.
- mobile? string - The mobile phone number for this contact.
- fax? string - The facsimile phone number for this contact.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: ContactModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ContactModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CoordinateInfo
Coordinate Info
Fields
- latitude? decimal - Latitude
- longitude? decimal - Longitude
avatax: CoverLetterModel
The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent.
Fields
- id? int - A unique ID number representing a cover letter sent with a CertExpress invitation.
- companyId? int - The unique ID number of the AvaTax company that received this certificate.
- title? string - The title used when sending the cover letter.
- subject? string - The subject message used when sending the cover letter via email.
- description? string - A full description of the cover letter's contents and message.
- createdDate? string - The date when this record was created.
- modifiedDate? string - The date/time when this record was last modified.
- active? boolean - Is this cover letter active
- pageCount? int - How many pages this cover letter encompasses
- templateFilename? string - The file name of the cover letter template
- 'version? int - The version number of the template
avatax: CoverLetterModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CoverLetterModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CreateCertExpressInvitationModel
Represents an invitation for a customer to use CertExpress to self-report their own certificates. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where they can follow a step-by-step guide to enter information about their exemption certificates. The certificates entered will be recorded and automatically linked to their customer record.
Fields
- recipient? string - If the value of
deliveryMethodis set toEmail, please specify the email address of the recipient for the request.
- coverLetterTitle? string - If this invitation is sent via email or download, please specify the cover letter to use when building this
invitation. For a list of cover letters, please call
ListCoverLetters.
- exposureZones? int[] - You may optionally specify a list of exposure zones to request in this CertExpress invitation. If you list
more than one exposure zone, the customer will be prompted to provide an exemption certificate for each one.
If you do not provide a list of exposure zones, the customer will be prompted to select an exposure zone.
For a list of available exposure zones, please call
ListCertificateExposureZones.
- exemptReasons? int[] - You may optionally specify a list of exemption reasons to pre-populate in this CertExpress invitation.
If you list exemption reasons, the customer will have part of their form already filled in when they visit
the CertExpress website.
For a list of available exemption reasons, please call
ListCertificateExemptReasons.
- deliveryMethod? string - Specify the type of invitation. CertExpress invitations can be delivered via email, web link, or
facsimile.
- If you specify
Email, the invitation will be delivered via email. Please ask the customer to ensure that - If you specify
Fax, the invitation will be sent via fax to the customer's fax number on file. - If you specify
Download, the invitation will be prepared as a web link that you can display to the customer.
- If you specify
avatax: CreateECommerceTokenInputModel
A model used to initialize a new CertCapture eCommerce token.
Fields
- customerNumber string - The customer's number that the token will be issued for.
avatax: CreateMultiDocumentModel
A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.
A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately.
Fields
- code? string - The transaction code of the MultiDocument transaction.
All individual transactions within this MultiDocument object will have this code as a prefix.
If you leave the
codefield blank, a GUID will be assigned.
- lines MultiDocumentLineItemModel[] - Lines that will appear on the invoice. For a MultiDocument transaction, each line may represent a different company or reporting location code. AvaTax will separate this MultiDocument transaction object into many different transactions, one for each pair of legal entities, so that each legal entity can file their transactional taxes correctly.
- allowAdjust? boolean - Set this value to true to allow this API call to adjust the MultiDocument model if one already exists.
If you omit this field, or if the value is
null, you will receive an error if you try to create two MultiDocument objects with the samecode.
- 'type? string - Specifies the type of document to create. A document type ending with
Invoiceis a permanent transaction that will be recorded in AvaTax. A document type ending withOrderis a temporary estimate that will not be preserved. If you omit this value, the API will assume you want to create aSalesOrder.
- companyCode? string - Company Code - Specify the code of the company creating this transaction here. If you leave this value null, your account's default company will be used instead.
- date string - Transaction Date - The date on the invoice, purchase order, etc.
By default, this date will be used to calculate the tax rates for the transaction. If you wish to use a
different date to calculate tax rates, please specify a
taxOverrideof typetaxDate.
- salespersonCode? string - Salesperson Code - The client application salesperson reference code.
- customerCode string - Customer Code - The client application customer reference code. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. Customer Usage Type - The client application customer or usage type.
- entityUseCode? string - Entity Use Code - The client application customer or usage type. For a list of available usage types, use ListEntityUseCodes API.
- discount? decimal - Discount - The discount amount to apply to the document. This value will be applied only to lines
that have the
discountedflag set to true. If no lines havediscountedset to true, this discount cannot be applied.
- purchaseOrderNo? string - Purchase Order Number for this document. This is required for single use exemption certificates to match the order and invoice with the certificate.
- exemptionNo? string - Exemption Number for this document. If you specify an exemption number for this document, this document will be considered exempt, and you may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor to verify your exemptions. Note: This is same as 'exemptNo' in TransactionModel.
- addresses? AddressesModel - Information about all the addresses involved in this transaction.
For a physical in-person transaction at a retail point-of-sale location, please specify only one address using
the
singleLocationfield. For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to a destination location such as a customer, please specify theshipFromandshipToaddresses. In the United States, some jurisdictions recognize the address typespointOfOrderOriginandpointOfOrderAcceptance. These address types affect the sourcing models of some transactions. If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses.
- parameters? TransactionParameterModel[] - Special parameters for this transaction. To get a full list of available parameters, please use the ListParameters endpoint.
- userDefinedFields? TransactionUserDefinedFieldModel[] - Custom user fields/flex fields for this transaction.
- referenceCode? string - Customer-provided Reference Code with information about this transaction. This field could be used to reference the original document for a return invoice, or for any other reference purpose.
- reportingLocationCode? string - Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting.
- 'commit? boolean - Causes the document to be committed if true. This option is only applicable for invoice document types, not orders.
- batchCode? string - BatchCode for batch operations.
- taxOverride? TaxOverrideModel - Represents a tax override for a transaction
- currencyCode? string - The three-character ISO 4217 currency code for this transaction.
- serviceMode? string - Specifies whether the tax calculation is handled Local, Remote, or Automatic (default). This only applies when using an AvaLocal server.
- exchangeRate? decimal - Currency exchange rate from this transaction to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0.
- exchangeRateEffectiveDate? string - Effective date of the exchange rate.
- exchangeRateCurrencyCode? string - Optional three-character ISO 4217 reporting exchange rate currency code for this transaction. The default value is USD.
- posLaneCode? string - Sets the Point of Sale Lane Code sent by the User for this document.
- businessIdentificationNo? string - VAT business identification number for the customer for this transaction. This number will be used for all lines in the transaction, except for those lines where you have defined a different business identification number. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
- isSellerImporterOfRecord? boolean - Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record.
Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to
ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer
of record will then be the company designated to pay taxes marked as being obligated to the importer of record.
Set this value to
trueto consider your company as the importer of record and collect these taxes. This value may also be set at the Nexus level. SeeNexusModelfor more information.
- description? string - User-supplied description for this transaction.
- email? string - User-supplied email address relevant for this transaction.
- debugLevel? string - If the user wishes to request additional debug information from this transaction, specify a level higher than
normal.
- customerSupplierName? string - The name of the supplier / exporter / seller. For sales doctype enter the name of your own company for which you are reporting. For purchases doctype enter the name of the supplier you have purchased from.
- dataSourceId? int - The Id of the datasource from which this transaction originated. This value will be overridden by the system to take the datasource Id from the call header.
- deliveryTerms? string - The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not. Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total. This field is also used for reports. This field is used for future feature support. This field is not currently in use.
avatax: CreateNoticeResponsibilityTypeModel
Model to create a new tax notice responsibility type.
Fields
- description? string - The description name of this notice responsibility
- isActive? boolean - Defines if the responsibility is active
- sortOrder? int - The sort order of this responsibility
avatax: CreateNoticeRootCauseTypeModel
Model to create a new tax notice root cause type.
Fields
- description? string - The description name of this notice RootCause
- isActive? boolean - Defines if the RootCause is active
- sortOrder? int - The sort order of this RootCause
avatax: CreateOrAdjustTransactionModel
Create or adjust transaction model
Fields
- adjustmentReason? string - A reason code indicating why this adjustment was made
- adjustmentDescription? string - If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other).
- createTransactionModel CreateTransactionModel - Create a transaction
avatax: CreateTransactionBatchRequestModel
Represents a create transaction batch request model.
Fields
- name string - The user-friendly readable name for this batch.
- transactions TransactionBatchItemModel[] - The list of transactions contained in this batch.
avatax: CreateTransactionBatchResponseModel
Represents a create transaction batch response model.
Fields
- id? int - The unique ID number of this batch.
- name string - The user-friendly readable name for this batch.
- accountId? int - The Account ID number of the account that owns this batch.
- companyId? int - The Company ID number of the company that owns this batch.
- status? string - This batch's current processing status
- startedDate? string - The date/time when this batch started processing
- recordCount? int - The number of records in this batch; determined by the server
- currentRecord? int - The current record being processed
- completedDate? string - The date/time when this batch was completely processed
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- files? BatchFileModel[] - The list of files contained in this batch.
avatax: CreateTransactionModel
Create a transaction
Fields
- code? string - The internal reference code used by the client application. This is used for operations such as Get, Adjust, Settle, and Void. If you leave the transaction code blank, a GUID will be assigned to each transaction.
- lines LineItemModel[] - A list of line items that will appear on this transaction.
- 'type? string - Specifies the type of document to create. A document type ending with
Invoiceis a permanent transaction that will be recorded in AvaTax. A document type ending withOrderis a temporary estimate that will not be preserved. If you omit this value, the API will assume you want to create aSalesOrder.
- companyCode? string - Company Code - Specify the code of the company creating this transaction here. If you leave this value null, your account's default company will be used instead.
- date string - Transaction Date - The date on the invoice, purchase order, etc.
By default, this date will be used to calculate the tax rates for the transaction. If you wish to use a
different date to calculate tax rates, please specify a
taxOverrideof typetaxDate.
- salespersonCode? string - Salesperson Code - The client application salesperson reference code.
- customerCode string - Customer Code - The client application customer reference code. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. Customer Usage Type - The client application customer or usage type.
- entityUseCode? string - Entity Use Code - The client application customer or usage type. For a list of available usage types, use ListEntityUseCodes API.
- discount? decimal - Discount - The discount amount to apply to the document. This value will be applied only to lines
that have the
discountedflag set to true. If no lines havediscountedset to true, this discount cannot be applied.
- purchaseOrderNo? string - Purchase Order Number for this document. This is required for single use exemption certificates to match the order and invoice with the certificate.
- exemptionNo? string - Exemption Number for this document. If you specify an exemption number for this document, this document will be considered exempt, and you may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor to verify your exemptions. Note: This is same as 'exemptNo' in TransactionModel.
- addresses? AddressesModel - Information about all the addresses involved in this transaction.
For a physical in-person transaction at a retail point-of-sale location, please specify only one address using
the
singleLocationfield. For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to a destination location such as a customer, please specify theshipFromandshipToaddresses. In the United States, some jurisdictions recognize the address typespointOfOrderOriginandpointOfOrderAcceptance. These address types affect the sourcing models of some transactions. If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses.
- parameters? TransactionParameterModel[] - Special parameters for this transaction. To get a full list of available parameters, please use the ListParameters endpoint.
- userDefinedFields? TransactionUserDefinedFieldModel[] - Custom user fields/flex fields for this transaction.
- referenceCode? string - Customer-provided Reference Code with information about this transaction. This field could be used to reference the original document for a return invoice, or for any other reference purpose.
- reportingLocationCode? string - Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting.
- 'commit? boolean - Causes the document to be committed if true. This option is only applicable for invoice document types, not orders.
- batchCode? string - BatchCode for batch operations.
- taxOverride? TaxOverrideModel - Represents a tax override for a transaction
- currencyCode? string - The three-character ISO 4217 currency code for this transaction.
- serviceMode? string - Specifies whether the tax calculation is handled Local, Remote, or Automatic (default). This only applies when using an AvaLocal server.
- exchangeRate? decimal - Currency exchange rate from this transaction to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0.
- exchangeRateEffectiveDate? string - Effective date of the exchange rate.
- exchangeRateCurrencyCode? string - Optional three-character ISO 4217 reporting exchange rate currency code for this transaction. The default value is USD.
- posLaneCode? string - Sets the Point of Sale Lane Code sent by the User for this document.
- businessIdentificationNo? string - VAT business identification number for the customer for this transaction. This number will be used for all lines in the transaction, except for those lines where you have defined a different business identification number. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
- isSellerImporterOfRecord? boolean - Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record.
Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to
ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer
of record will then be the company designated to pay taxes marked as being obligated to the importer of record.
Set this value to
trueto consider your company as the importer of record and collect these taxes. This value may also be set at the Nexus level. SeeNexusModelfor more information.
- description? string - User-supplied description for this transaction.
- email? string - User-supplied email address relevant for this transaction.
- debugLevel? string - If the user wishes to request additional debug information from this transaction, specify a level higher than
normal.
- customerSupplierName? string - The name of the supplier / exporter / seller. For sales doctype enter the name of your own company for which you are reporting. For purchases doctype enter the name of the supplier you have purchased from.
- dataSourceId? int - The Id of the datasource from which this transaction originated. This value will be overridden by the system to take the datasource Id from the call header.
- deliveryTerms? string - The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not. Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total. This field is also used for reports. This field is used for future feature support. This field is not currently in use.
avatax: CurrencyModel
Represents an ISO 4217 currency code used for designating the currency of a transaction.
Fields
- code? string - The ISO 4217 currency code for this currency.
- description? string - A friendly human-readable name representing this currency.
- decimalDigits? int - The number of decimal digits to use when formatting a currency value for display.
avatax: CurrencyModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CurrencyModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CustomerAttributeModel
A Customer's linked attribute denoting what features applied to the customer. A customer can be linked to multiple customer attributes and vice versa.
Fields
- id? int - A unique ID number representing this attribute.
- name? string - A friendly readable name for this attribute.
- description? string - A full help text description of the attribute.
- isSystemCode? boolean - This value is true if this is a system-defined attribute. System-defined attributes cannot be modified or deleted on the CertCapture website.
- isNonDeliver? boolean - A flag denotes that future exemption certificate request won't be mailed to the customer
- isChangeable? boolean - A flag denotes that this attribute can't be removed/added to a customer record
avatax: CustomerAttributeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CustomerAttributeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CustomerModel
Represents a customer to whom you sell products and/or services.
Fields
- id? int - Unique ID number of this customer.
- companyId int - The unique ID number of the AvaTax company that recorded this customer.
- customerCode string - The unique code identifying this customer. Must be unique within your company.
This code should be used in the
customerCodefield of any call that creates or adjusts a transaction in order to ensure that all exemptions that apply to this customer are correctly considered. Note: This field is case sensitive.
- alternateId? string - A customer-configurable alternate ID number for this customer. You may set this value to match any other system that would like to reference this customer record.
- name string - A friendly name identifying this customer.
- attnName? string - Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped to the attention of a specific person or department name.
- line1 string - First line of the street address of this customer.
- line2? string - Second line of the street address of this customer.
- city string - City component of the street address of this customer.
- postalCode string - Postal Code / Zip Code component of the address of this customer.
- phoneNumber? string - The main phone number for this customer.
- faxNumber? string - The fax phone number for this customer, if any.
- emailAddress? string - The main email address for this customer.
- contactName? string - The name of the main contact person for this customer.
- lastTransaction? string - Date when this customer last executed a transaction.
- createdDate? string - The date when this record was created.
- modifiedDate? string - The date/time when this record was last modified.
- country string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- region string - ISO 3166 code identifying the region within the country.
Two and three character ISO 3166 region codes.
For a full list of all supported codes, please see the Definitions API
ListRegions.
- isBill? boolean - True if this customer record is specifically used for bill-to purposes.
- isShip? boolean - True if this customer record is specifically used for ship-to purposes.
- taxpayerIdNumber? string - For customers in the United States, this field is the federal taxpayer ID number. For businesses, this is a Federal Employer Identification Number. For individuals, this will be a Social Security Number.
- certificates? CertificateModel[] - A list of exemption certficates that apply to this customer. You can fetch this data by specifying
$include=certificateswhen calling a customer fetch API.
- customFields? CustomFieldModel[] - A list of custom fields defined on this customer. For more information about custom fields, see the Avalara Help Center article about custom fields.
- exposureZones? ExposureZoneModel[] - A list of exposure zones where you do business with this customer.
To keep track of certificates that are needed for each customer, set this value to a list of all exposure zones where you
sell products to this customer. You can find a list of exposure zones by calling
ListExposureZones. This field is often called "Ship-To States" or "Ship-To Zones", since it generally refers to locations where you ship products when this customer makes a purchase. This field is useful for audit purposes since it helps you ensure you have the necessary certificates for each customer.
- shipTos? CustomerModel[] - A list of ship-to customer records that are connected to this bill-to customer. Customer records represent businesses or individuals who can provide exemption certificates. Some customers may have certificates that are linked to their shipping address or their billing address. To group these customer records together, you may link multiple bill-to and ship-to addresses together to represent a single entity that has multiple different addresses of different kinds.
- attributes? CustomerAttributeModel[] - A list of attributes that apply to this customer.
You can fetch this data by specifying
$include=attributeswhen calling a customer fetch API.
avatax: CustomerModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CustomerModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CustomerSupplierCountryParamModel
Represents a parameter associated with a company.
Fields
- id? int - Identifier for company parameter
- companyId? int - CompanyId associated with the parameter
- customerId? int - Identifier for company parameter
- customerCode? string -
- country string -
- isEstablished? boolean -
- businessIdentificationNo? string -
- isRegisteredThroughFiscalRep? boolean -
avatax: CustomerSupplierModel
Represents a parameter associated with a company.
Fields
- id? int - Identifier for company parameter
- companyId? int - CompanyId associated with the parameter
- customerCode string - CustomerCode
avatax: CustomerSupplierModelFetchResult
Fields
- '\@recordsetCount? int -
- value? CustomerSupplierModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: CustomFieldModel
A custom field provides extra information about a customer or certificate.
Custom fields are provided to permit you to store additional information about an exemption certificate or customer. They are available to support additional use cases beyond that supported directly by Avalara's exemption certificate software.
For more information about custom fields, see the Avalara Help Center article about custom fields.
Fields
- name? string - The name of the custom field.
- value? string - The value of the custom field.
avatax: CycleAddOptionModel
Model with options for adding a new filing calendar
Fields
- available? boolean - True if this form can be added and filed for the current cycle. "Current cycle" is considered one month before the month of today's date.
- transactionalPeriodStart? string - The period start date for the customer's first transaction in the jurisdiction being added
- transactionalPeriodEnd? string - The period end date for the customer's last transaction in the jurisdiction being added
- filingDueDate? string - The jurisdiction-assigned due date for the form
- cycleName? string - A descriptive name of the cycle and due date of form.
- frequencyName? string - The filing frequency of the form
- filingFrequencyCode? string - A code assigned to the filing frequency
- filingFrequencyId? string - The filing frequency of the request
- availableLocationCodes? string[] - A list of outlet codes that can be assigned to this form for the current cycle
avatax: CycleEditOptionModel
Model with options for actual filing calendar output based on user edits to filing calendar.
Fields
- success? boolean - Whether or not changes can be made to the filing calendar.
- message? string - The message to present to the user when calendar is successfully or unsuccessfully changed.
- customerMustApprove? boolean - Whether or not the user should be warned of a change, because some changes are risky and may be being done not in accordance with jurisdiction rules. For example, user would be warned if user changes filing frequency to new frequency with a start date during an accrual month of the existing frequency.
- mustCloneFilingCalendar? boolean - True if the filing calendar must be cloned to allow this change; false if the existing filing calendar can be changed itself.
- clonedCalendarEffDate? string - The effective date of the filing calendar (only applies if cloning).
- expiredCalendarEndDate? string - The expired end date of the old filing calendar (only applies if cloning).
avatax: CycleExpireModel
Cycle Safe Expiration results.
Fields
- success? boolean - Whether or not the filing calendar can be expired. e.g. if user makes end date of a calendar earlier than latest filing, this would be set to false.
- message? string - The message to present to the user if expiration is successful or unsuccessful.
- cycleExpirationOptions? CycleExpireOptionModel[] - A list of options for expiring the filing calendar.
avatax: CycleExpireOptionModel
Options for expiring a filing calendar.
Fields
- transactionalPeriodStart? string - The period start date for the customer's first transaction in the jurisdiction being expired.
- transactionalPeriodEnd? string - The period end date for the customer's last transaction in the jurisdiction being expired.
- filingDueDate? string - The jurisdiction-assigned due date for the form.
- cycleName? string - A descriptive name of the cycle and due date of the form.
avatax: CycleSafeEditRequestModel
Options for expiring a filing calendar.
Fields
- companyId? int - Company Identifier
- taxFormCode? string - Tax Form Code
- filingCalendarId? int - Filing Calendar Identifier
- edits? CycleSafeFilingCalendarEditModel[] - Filing calendar edits
avatax: CycleSafeFilingCalendarEditModel
Filing Calendar Edit
Fields
- fieldName? string - Field To Edit
- destination? string - Destination is used to identify filing questions' type Other or Settings.
- questionId? int - Question
- questionCode? string - The filing question code.
- oldValue? record {} - Old Value
- newValue? record {} - New Value
avatax: CycleSafeOptionResultModel
CycleSafe Option Result
Fields
- taxFormCode? string - Tax Form Code
- mustCloneFilingCalendar? boolean - Boolean if the Filing Calendar must be cloned
- clonedCalendarEffDate? string - Cloned Calendar Effective Date
- expiredCalendarEndDate? string - Expired Calendar End Date
- frequenciesAvailable? FrequencyAvailableModel[] - Frequencies Available
avatax: DataSourceModel
Data source object
Fields
- id? int - The id of the datasource.
- companyId int - The id of the company to which the datasource belongs to.
- 'source string - The extractor/connector id.
- instance? string - The unique ID number of this connection.
- isEnabled? boolean - The connection using the connection_id is enabled. The customer is responsible to enable or disable.
- isSynced? boolean - If all the information has been transferred from the extractor to the database.
- isAuthorized? boolean - True if this data source is authorized.
- lastSyncedDate? string - The date when the information was last synched.
- createdUserId? int - The User ID of the user who created this record.
- createdDate? string - The date when this record was created.
- modifiedUserId? int - The user ID of the user who last modified this record.
- modifiedDate? string - The date/time when this record was last modified.
- deletedDate? string - The date when this record was deleted.
- recalculate? boolean - Specifies whether transactions created by this data source needs to re-calculate tax or not
- name? string - Specifies the name of the extractor
- externalState? string - Specifies any implementation-specific information along with the DataSource.This field has no internal meaning in AvaTax and is purely for the convenience of the DataSource API user
avatax: DataSourceModelFetchResult
Fields
- '\@recordsetCount? int -
- value? DataSourceModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: DeclareNexusByAddressModel
Use this object to provide an address and date range where your company does business. This address will be used to determine what jurisdictions you should declare nexus and calculate tax.
Fields
- effectiveDate? string - The earliest date on which your company does business at this address. If you omit a value in this field, nexus will be declared at the earliest possible date for this jurisdiction.
- endDate? string - The date on which your company stopped doing business at this address, or empty if your company has no plans to stop doing business at this address.
- line1? string - First line of the street address
- textCase? string - Specify the text case for the validated address result. If not specified, will return uppercase.
- line2? string - Second line of the street address
- line3? string - Third line of the street address
- city? string - City component of the address
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- postalCode? string - Postal Code / Zip Code component of the address.
- latitude? decimal - Geospatial latitude measurement, in Decimal Degrees floating point format.
- longitude? decimal - Geospatial longitude measurement, in Decimal Degrees floating point format.
avatax: DeleteErrorTransactionResponseModel
Response model of a single error transaction delete
Fields
- result? string - Result of the deletion
- documentType string - Type of transaction of the error transaction
- documentCode string - The internal reference code (used by the client application) of the error transaction
avatax: DeleteErrorTransactionsRequestModel
Request model for when a user is deleting multiple error transaction
Fields
- models ErrorTransactionModelBase[] - List of error transactions to be deleted
avatax: DeleteErrorTransactionsResponseModel
Response model of error transaction batch delete
Fields
- results? DeleteErrorTransactionResponseModel[] - The individual result of each error transaction in the request batch
avatax: DenormalizedJurisModel
Represents information about a single legal taxing jurisdiction within a specific Avalara tax region.
Fields
- effectiveDate? string - The jurisdiction's effective date.
- endDate? string - The jurisdiction's end date.
- jurisCode? string - The jurisdiction's code.
- jurisdictionId? int - The jurisdiction's id.
- jurisType? string - The jurisdiction's type.
- jurisName? string - The jurisdiction's name.
- stateAssignedCode? string - The state assigned code.
- taxAuthorityId? int - The id of the tax authority.
- state? string - The jurisdiction's region. This should exist on the TaxRegion, but in practice often doesn't.
- country? string - The jurisdiction's country. This should exist on the TaxRegion, but in practice often doesn't.
- county? string - The jurisdiction's county. This should exist on the TaxRegion, but in practice often doesn't.
- city? string - The jurisdiction's city. This should exist on the TaxRegion, but in practice often doesn't.
- isAcm? boolean - Is Acm flag
- isSst? boolean - Is Sst flag
avatax: DeterminationFactorModel
This object represents a single determination factor for a line that is being inspected through the InspectLine API.
Fields
- code? string - Determination reason code.
- description? string - Determination reason description.
- ids? string[] - The ids of any applied determination factor.
- names? string[] - The name of any applied determination factor.
- createdBy? string - The name of the user who created the determination factor.
avatax: EcmsDetailModel
Represents an ECMS record, used internally by AvaTax to track information about exemptions.
Fields
- exemptCertDetailId int - Unique, system-assigned identifier of a ExemptCertDetail record.
- exemptCertId int - The calc_id associated with a certificate in CertCapture.
- stateFips string - State FIPS
- region string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- idNo? string - The customer Tax Id Number (tax_number) associated with a certificate. This is same as exemptionNo in Transactions.
- country string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- endDate? string - End date of this exempt certificate
- idType? string - The type of idNo (tax_number) associated with a certificate. Example: Driver's Licence Number, Permit Number.
- isTaxCodeListExclusionList? int - Is the tax code list an exculsion list?
- taxCodes? EcmsDetailTaxCodeModel[] - optional: list of tax code associated with this exempt certificate detail
avatax: EcmsDetailTaxCodeModel
Fields
- exemptCertDetailTaxCodeId? int - Id of the exempt certificate detail tax code
- exemptCertDetailId? int - exempt certificate detail id
- taxCodeId? int - tax code id
avatax: EcmsModel
Exempt certificate
Fields
- exemptCertId int - The calc_id associated with a certificate in CertCapture.
- companyId int - Company ID
- customerCode string - Customer code
- customerName? string - Customer name
- address1? string - Address line 1
- address2? string - Address line 2
- address3? string - Address line 3
- city? string - City
- region string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- postalCode? string - Postal code / zip code
- country string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- exemptCertTypeId string - The type of exemption certificate. Permitted values are: Blanket and Single.
- documentRefNo? string - Document Reference Number, in the case of single-use exemption certificates, the DocumentCode or PurchaseOrderNo to which the certificate should apply.
- businessTypeId int - Business type the customer belongs to.
- businessTypeOtherDescription? string - Other description for this business type
- exemptReasonId? string - Exempt reason associated with the certificate, coded by CustomerUsageType. Example: A - Federal Government.
- exemptReasonOtherDescription? string - Other description for exempt reason i.e. Populated on if exemptReasonId is 'L' - Other.
- effectiveDate? string - Effective date for this exempt certificate
- regionsApplicable string - A list of applicable regions for this exempt certificate. To list more than one applicable region, separate the list of region codes with commas.
- exemptCertStatusId string - Status for this exempt certificate
- createdDate? string - Date when this exempt certificate was created
- lastTransactionDate? string - Date when last transaction with this exempt certificate happened
- expiryDate? string - When this exempt certificate will expire
- createdUserId? int - User that creates the certificate
- modifiedDate? string - Date when this exempt certificate was modified
- modifiedUserId? int - Who modified this exempt certificate
- countryIssued string - Name or ISO 3166 code identifying the country that issued this ECMS certificate.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- avaCertId? string - If the certificate record was synced from an AvaTax Certs account(as opposed to being entered in ECMS directly), the unique AvaTax Certs identifier for the certificate record. Usually same as the Id of a Certificate.
- exemptCertReviewStatusId? string - Review status for this exempt certificate
- details? EcmsDetailModel[] - Exempt Cert details
avatax: EcmsModelFetchResult
Fields
- '\@recordsetCount? int -
- value? EcmsModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ECommerceTokenOutputModel
The resource model returned by the ECommerceTokenController's endpoints.
Fields
- token string - The JWT token that authorizes the gencert tool to operate.
- clientIds? int[] - The list of clients that the token is valid for.
- createdDate string - The date the token was created.
- expirationDate string - The date that the token will expire.
avatax: ECommerceTokenOutputModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ECommerceTokenOutputModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: EntityUseCodeModel
Represents a code describing the intended use for a product that may affect its taxability
Fields
- code? string - The Avalara-recognized entity use code for this definition
- name? string - The name of this entity use code
- description? string - Text describing the meaning of this use code
- validCountries? string[] - A list of countries where this use code is valid
avatax: EntityUseCodeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? EntityUseCodeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ErrorCodeOutputModel
Model that has the matching count for an errorcode
Fields
- errorCode? string - Name of the error code
- count? int - Number of error code recorded
avatax: ErrorCodeOutputModelCappedFetchResult
Fields
- '\@isRecordsetCountCapped? boolean -
- '\@recordsetCount? int -
- value? ErrorCodeOutputModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ErrorDetail
Fields
- code? string -
- number? int -
- message? string -
- description? string -
- faultCode? string -
- faultSubCode? string -
- helpLink? string -
- refersTo? string -
- severity? string -
avatax: ErrorTransactionModelBase
Base model class for single error transaction delete request
Fields
- documentType string - Type of transaction of the error transaction
- documentCode string - The internal reference code (used by the client application) of the error transaction
avatax: ErrorTransactionOutputModel
Error Transaction Model
Fields
- errorCode? string - Error code of the error result from transaction creation
- errorMessage? string - Error message of the error result from transaction creation
- avataxErrorJson? string - The full JSON of the error result from transaction creation
- avataxCreateTransactionJson? string - The full JSON of the transaction creation request
- datasource? string - The datasource instance that made the transaction creation call
- documentDate? string - The date of the document
- expiresAt? string - The date that this ErrorTransaction will be automatically purged from the detabase.
- amount? decimal - The amount of the transaction.
- datasourceSource? string - The Datasource source of the transaction creation call.
- shipToCountry? string - The country of the ship to address for the transaction creation call.
- shipToRegion? string - The region of the ship to address for the transaction creation call.
- documentType string - Type of transaction of the error transaction
- documentCode string - The internal reference code (used by the client application) of the error transaction
avatax: ErrorTransactionOutputModelCappedFetchResult
Fields
- '\@isRecordsetCountCapped? boolean -
- '\@recordsetCount? int -
- value? ErrorTransactionOutputModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ExemptionReasonModel
An exemption reason defines why a certificate allows a customer to be exempt
for purposes of tax calculation. For a full list of defined exemption reasons,
please call the ListCertificateExemptionReasons API.
Fields
- id? int - A unique ID number representing this exemption reason.
- name? string - A friendly name describing this exemption reason.
avatax: ExemptionReasonModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ExemptionReasonModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ExemptionStatusModel
Indicates the customer's exemption status in a specific country and region.
Fields
- status? string - The exemption status of this customer in this country/region.
- certificate? CertificateModel - A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on criteria you specify when you store the certificate. To view or manage your certificates directly, please log onto the administrative website for the product you purchased.
avatax: ExportDocumentLineModel
An input model for executing a report detailed to the document line level
Fields
- format? string - The file format.
- startDate? string - The start date filter for report execution. If no date provided, same date of last month will be used as the startDate. Accepts date in short format yyyy-mm-dd as well as date time stamp
- endDate? string - The end date filter for report execution. If no date provided, today's date will be used as the endDate. Accepts date in short format yyyy-mm-dd as well as date time stamp
- country? string - The transactions in the country you wish to run a report. Use "ALL" for all countries Use "ALL Non-US" for all international countries Or use a single 2-char ISO country code
- state? string - The state associated with the transactions you wish to run a report. Use "ALL" for all states or 2-char state code.
- dateFilter? string - The type of date to filter your transactions
- docType? string - The transaction type you want to run a report on
- currencyCode? string - The currency your report is displayed in. Accepts "USD" or leave this blank to get all the documents with all the currencies
- numberOfPartitions? int - Number of partitions (2 - 250) to split the report into. If a value is provided for this property, a value must also be provided for the partition property.
- partition? int - The zero-based partition number to retrieve in this export request. If a value is provided for this property, a value must also be provided for the numberOfPartitions property.
- isLocked? boolean - If true, include only documents that are locked. If false, include only documents that are not locked. Defaults to false if not specified.
- merchantSellerIdentifier? string - If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.
- documentStatus? string - DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
- isModifiedDateSameAsDocumentDate? boolean - Use this parameter when dateFilter = ModifiedDate. For dateFilter = DocumentDate, PaymentDate, TaxDate or ReportingDate, the isModifiedDateSameAsDocumentDate parameter is ignored. Set this parameter to true when you would like to get Documents which have the Document Date same as Modified Date. Defaults to false if not specified.
- taxGroup? string - TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
- taxName? string - The description of the tax
- taxCode? string - The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
- customerVendorCode? string - The code your business application uses to identify a customer or vendor
- taxSubType? string - Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
avatax: ExposureZoneModel
Information about a physical area or zone in which a certificate can apply. An exposure zone for an exemption certificate will generally be a tax authority such as a state, country, or local government entity.
Fields
- id? int - A unique ID number representing this exposure zone.
- companyId? int - The unique ID number of the AvaTax company that recorded this customer.
- name? string - The short name of this exposure zone, suitable for use in a drop-down list.
- tag? string - A tag indicating
- description? string - A more complete description of this exposure zone, suitable for use as a tooltip or help text.
- created? string - The date when this record was created.
- modified? string - The date/time when this record was last modified.
- region? string - Two or three character ISO 3166 region, province, or state name of this exposure zone.
- country? string - Two character ISO 3166 county code for the country component of this exposure zone.
avatax: ExposureZoneModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ExposureZoneModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FiledReturnModel
Filing Returns Model
Fields
- companyId? int - The unique ID number of the company filing return.
- endPeriodMonth? int - The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- endPeriodYear? int - The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- taxformCode? string - The unique code of the form.
avatax: FiledReturnModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FiledReturnModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FilingAdjustmentModel
A model for return adjustments.
Fields
- id? int - The unique ID number for the adjustment.
- filingId? int - The filing return id that this applies too
- amount decimal - The adjustment amount.
- period string - The filing period the adjustment is applied to.
- 'type string - The type of the adjustment.
- isCalculated? boolean - Whether or not the adjustment has been calculated.
- accountType string - The account type of the adjustment.
- reason? string - A descriptive reason for creating this adjustment.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: FilingAnswerModel
Fields
- filingQuestionId int - The ID number for a filing question
- answer? record {} - The value of the answer for the filing question identified by filingQuestionId
avatax: FilingAttachmentModel
An attachment associated with a filing return
Fields
- resourceFileId? int - The resourceFileId used to retrieve the attachment
- description? string - The description of the attachment
avatax: FilingAugmentationModel
A model for return augmentations.
Fields
- id? int - The unique ID number for the augmentation.
- filingId? int - The filing return id that this applies too
- fieldAmount decimal - The field amount.
- fieldName string - The field name.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: FilingCalendarEditModel
An edit to be made on a filing calendar.
Fields
- fieldName string - The name of the field to be modified.
- questionId int - The unique ID of the filing calendar question. "Filing calendar question" is the wording displayed to users for a given field.
- oldValue record {} - The current value of the field.
- newValue record {} - The new/proposed value of the field.
avatax: FilingCalendarModel
Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.
Fields
- id? int - The unique ID number of this filing calendar.
- companyId int - The unique ID number of the company to which this filing calendar belongs.
- returnName? string - DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use
taxFormCodeinstead. The legacy return name of the tax form to file.
- formCountry? string - Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- formRegion? string - Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- taxFormCode? string - The Avalara standard tax form code of the tax form for this filing calendar. The first two characters of the tax form code are the ISO 3166 country code of the country that issued this form.
- fiscalYearStartMonth? int - The start period of a fiscal year for this form/company
- locationCode? string - If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.
- outletTypeId? string - DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. If this calendar is for a location-specific tax return, specify the location-specific behavior here.
- paymentCurrency? string - Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".
- filingFrequencyId string - The frequency on which this tax form is filed.
- months? int - A 16-bit bitmap containing a 1 for each month when the return should be filed.
- stateRegistrationId? string - Tax Registration ID for this Region - in the U.S., this is for your state.
- localRegistrationId? string - Tax Registration ID for the local jurisdiction, if any.
- employerIdentificationNumber? string - The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return.
- line1? string - DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The first line of the mailing address that will be used when filling out this tax return.
- line2? string - DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The second line of the mailing address that will be used when filling out this tax return. Please note that some tax forms do not support multiple address lines.
- city? string - DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The city name of the mailing address that will be used when filling out this tax return.
- region? string - DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The state, region, or province of the mailing address that will be used when filling out this tax return.
- postalCode? string - DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The postal code or zip code of the mailing address that will be used when filling out this tax return.
- country? string - DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The two character ISO-3166 country code of the mailing address that will be used when filling out this tax return.
- mailingAddressLine1? string - The first line of the mailing address that will be used when filling out this tax return.
- mailingAddressLine2? string - The second line of the mailing address that will be used when filling out this tax return. Please note that some tax forms do not support multiple address lines.
- mailingAddressCity? string - The city name of the mailing address that will be used when filling out this tax return.
- mailingAddressRegion? string - Name or ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- mailingAddressPostalCode? string - The postal code or zip code of the mailing address that will be used when filling out this tax return.
- mailingAddressCountry? string - Name or ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- phone? string - The phone number to be used when filing this return.
- customerFilingInstructions? string - DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. Special filing instructions to be used when filing this return. Please note that requesting special filing instructions may incur additional costs.
- legalEntityName? string - The legal entity name to be used when filing this return.
- effectiveDate string - The earliest date for the tax period when this return should be filed. This date specifies the earliest date for tax transactions that should be reported on this filing calendar. Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February.
- endDate? string - The last date for the tax period when this return should be filed. This date specifies the last date for tax transactions that should be reported on this filing calendar. Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February.
- filingTypeId? string - The method to be used when filing this return.
- eFileUsername? string - If you file electronically, this is the username you use to log in to the tax authority's website.
- eFilePassword? string - If you file electronically, this is the password or pass code you use to log in to the tax authority's website.
- prepayPercentage? int - If you are required to prepay a percentage of taxes for future periods, please specify the percentage in whole numbers; for example, the value 90 would indicate 90%.
- prePaymentRequired? boolean - Determines if a prepayment is required for this filing calendar
- fixedPrepaymentAmount? decimal - If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here.
- taxTypeId string - DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward. The type of tax to report on this return.
- taxTypes? string[] - The list of tax types to report on this return.
- internalNotes? string - DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. Internal filing notes.
- alSignOn? string - Custom filing information field for Alabama.
- alAccessCode? string - Custom filing information field for Alabama.
- meBusinessCode? string - Custom filing information field for Maine.
- iaBen? string - Custom filing information field for Iowa.
- ctReg? string - Custom filing information field for Connecticut.
- other1Name? string - Custom filing information field. Leave blank.
- other1Value? string - Custom filing information field. Leave blank.
- other2Name? string - Custom filing information field. Leave blank.
- other2Value? string - Custom filing information field. Leave blank.
- other3Name? string - Custom filing information field. Leave blank.
- other3Value? string - Custom filing information field. Leave blank.
- taxAuthorityId? int - The unique ID of the tax authority of this return.
- taxAuthorityName? string - The name of the tax authority of this return.
- taxAuthorityType? string - The type description of the tax authority of this return.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- bulkAccountId? string - User name of bulk account.
- siteCode? string - The bulk account site code.
- bulkAccountValidationStatus? string - The status of the bulk account's validation.
- settings? CompanyReturnSettingModel[] - CompanyReturn settings for complext filing calendar
avatax: FilingCalendarModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FilingCalendarModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FilingFrequencyModel
FilingFrequency Model
Fields
- id int - The unique ID number of this filing frequency.
- description string - The description name of this filing frequency
avatax: FilingFrequencyModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FilingFrequencyModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FilingModel
Represents a listing of all tax calculation data for filings and for accruing to future filings.
Fields
- id? int - The unique ID number of this filing.
- companyId? int - The unique ID number of the company for this filing.
- month? int - The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- year? int - The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- 'type? string - Indicates whether this is an original or an amended filing.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- filingRegions? FilingRegionModel[] - A listing of regional tax filings within this time period.
avatax: FilingModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FilingModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FilingPaymentModel
A model for return payments.
Fields
- id? int - The unique ID number for the payment.
- filingId int - The filing return id that this applies too
- paymentAmount decimal - The payment amount.
- 'type string - The type of the payment.
- isCalculated? boolean - Whether or not the payment has been calculated.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: FilingRegionModel
Regions
Fields
- id? int - The unique ID number of this filing region.
- filingId? int - The filing id that this region belongs too
- country? string - The two-character ISO-3166 code for the country.
- region? string - The two or three character region code for the region.
- salesAmount? decimal - The sales amount.
- taxableAmount? decimal - The taxable amount.
- taxAmount? decimal - The tax amount.
- taxDueAmount? decimal - The tax amount due.
- collectAmount? decimal - The amount collected by Avalara for this region
- totalRemittanceAmount? decimal - Total remittance amount of all returns in region
- nonTaxableAmount? decimal - The non-taxable amount.
- consumerUseTaxAmount? decimal - Consumer use tax liability.
- consumerUseNonTaxableAmount? decimal - Consumer use non-taxable amount.
- consumerUseTaxableAmount? decimal - Consumer use taxable amount.
- approveDate? string - The date the filing region was approved.
- startDate? string - The start date for the filing cycle.
- endDate? string - The end date for the filing cycle.
- hasNexus? boolean - Whether or not you have nexus in this region.
- status? string - The current status of the filing region.
- 'returns? FilingReturnModel[] - A list of tax returns in this region.
- suggestReturns? FilingsCheckupSuggestedFormModel[] - A list of tax returns in this region.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: FilingRequestDataModel
Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.
Fields
- companyReturnId? int - The company return ID if requesting an update.
- returnName? string - DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use
taxFormCodeinstead. The legacy return name of the requested calendar.
- taxFormCode? string - The Avalara standard tax form code of the tax form for this filing calendar. The first two characters of the tax form code are the ISO 3166 country code of the country that issued this form.
- filingFrequencyId string - The filing frequency of the request
- registrationId? string - State registration ID of the company requesting the filing calendar.
- months int - The months of the request
- fiscalYearStartMonth? int - The start period of a fiscal year for this form/company
- taxTypeId? string - The type of tax to report on this return.
- locationCode? string - Location code of the request
- effDate string - Filing cycle effective date of the request
- endDate? string - Filing cycle end date of the request
- isClone? boolean - Flag if the request is a clone of a current filing calendar
- country? string - The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.
- region? string - The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.
- taxAuthorityId? int - The tax authority id of the return
- taxAuthorityName? string - The tax authority name on the return
- answers? FilingAnswerModel[] - Filing question answers
avatax: FilingRequestModel
Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.
Fields
- id? int - The unique ID number of this filing request.
- companyId int - The unique ID number of the company to which this filing request belongs.
- filingRequestStatusId? string - The current status of this request
- data FilingRequestDataModel - Represents a commitment to file a tax return on a recurring basis. Only used if you subscribe to Avalara Returns.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: FilingRequestModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FilingRequestModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FilingReturnCreditModel
An attachment associated with a filing return
Fields
- totalSales? decimal - The resourceFileId used to retrieve the attachment
- totalExempt? decimal - The resourceFileId used to retrieve the attachment
- totalTaxable? decimal - The resourceFileId used to retrieve the attachment
- totalTax? decimal - The resourceFileId used to retrieve the attachment
- transactionDetails? WorksheetDocument[] - The excluded carry over credit documents
avatax: FilingReturnModel
Filing Returns Model
Fields
- id? int - The unique ID number of this filing return.
- filingRegionId? int - The region id that this return belongs too
- filingCalendarId? int - The unique ID number of the filing calendar associated with this return.
- resourceFileId? int - The resourceFileId of the return. Will be null if not available.
- taxAuthorityId? int - Tax Authority ID of this return
- status? string - The current status of the filing return.
- filingFrequency? string - The filing frequency of the return.
- filedDate? string - The date the return was filed by Avalara.
- startPeriod? string - The start date of this return
- endPeriod? string - The end date of this return
- salesAmount? decimal - The sales amount.
- filingType? string - The filing type of the return.
- formName? string - The name of the form.
- remitAmount? decimal - The remittance amount of the return.
- formCode? string - The unique code of the form.
- description? string - A description for the return.
- taxableAmount? decimal - The taxable amount.
- taxAmount? decimal - The tax amount.
- collectAmount? decimal - The amount collected by avalara for this return
- taxDueAmount? decimal - The tax due amount.
- nonTaxableAmount? decimal - The non-taxable amount.
- nonTaxableDueAmount? decimal - The non-taxable due amount.
- consumerUseTaxAmount? decimal - Consumer use tax liability during the period.
- consumerUseTaxDueAmount? decimal - Consumer use tax liability accrued during the period.
- consumerUseNonTaxableAmount? decimal - Consumer use non-taxable amount.
- consumerUseTaxableAmount? decimal - Consumer use taxable amount.
- totalAdjustments? decimal - Total amount of adjustments on this return
- excludedSalesAmount? decimal - The amount of sales excluded from the liability calculation
- excludedNonTaxableAmount? decimal - The amount of non-taxable sales excluded from the liability calculation
- excludedTaxAmount? decimal - The amount of tax excluded from the liability calculation
- carryOverSalesAmount? decimal - The amount of carry over sales applied to the liability calculation
- carryOverNonTaxableAmount? decimal - The amount of carry over non taxable sales applied to the liability calculation
- carryOverTaxAmount? decimal - The amount of carry over sales tax applied to the liability calculation
- carryOverConsumerUseTaxAmount? decimal - The amount of carry over consumer use tax applied to the liability calculation
- taxAccrualAmount? decimal - The total amount of total tax accrued in the current active period
- salesAccrualAmount? decimal - The total amount of sales accrued in the current active period
- nonTaxableAccrualAmount? decimal - The total amount of nontaxable sales accrued in the current active period
- taxableAccrualAmount? decimal - The total amount of taxable sales accrued in the current active period
- salesTaxAccrualAmount? decimal - The total amount of sales tax accrued in the current active period
- sellersUseTaxAccrualAmount? decimal - The total amount of sellers use tax accrued in the current active period
- consumerUseTaxAccrualAmount? decimal - The total amount of consumer use tax accrued in the current active period
- consumerUseTaxableAccrualAmount? decimal - The total amount of consumer use taxable sales accrued in the current active period
- consumerUseNonTaxableAccrualAmount? decimal - The total amount of consumer use non taxable sales accrued in the current active period
- adjustments? FilingAdjustmentModel[] - The Adjustments for this return.
- totalAugmentations? decimal - Total amount of augmentations on this return
- augmentations? FilingAugmentationModel[] - The Augmentations for this return.
- totalPayments? decimal - Total amount of payments on this return
- payments? FilingPaymentModel[] - The payments for this return.
- accrualType? string - Accrual type of the return
- month? int - The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- year? int - The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- 'type? string - The FilingTaskType for this return.
- attachments? FilingAttachmentModel[] - The attachments for this return.
- excludedCarryOverCredits? FilingReturnCreditModel - An attachment associated with a filing return
- appliedCarryOverCredits? FilingReturnCreditModel - An attachment associated with a filing return
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
avatax: FilingReturnModelBasic
Filing Returns Model
Fields
- companyId? int - The unique ID number of the company filing return.
- id? int - The unique ID number of this filing return.
- filingId? int - The filing id that this return belongs too
- resourceFileId? int - The resourceFileId of the return
- filingRegionId? int - The region id that this return belongs too
- filingCalendarId? int - The unique ID number of the filing calendar associated with this return.
- country? string - The country of the form.
- region? string - The region of the form.
- endPeriodMonth? int - The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- endPeriodYear? int - The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- status? string - The current status of the filing return.
- filingFrequency? string - The filing frequency of the return.
- filedDate? string - The date the return was filed by Avalara.
- salesAmount? decimal - The sales amount.
- filingType? string - The filing type of the return.
- formName? string - The name of the form.
- remitAmount? decimal - The remittance amount of the return.
- formCode? string - The unique code of the form.
- description? string - A description for the return.
- taxableAmount? decimal - The taxable amount.
- taxAmount? decimal - The tax amount.
- collectAmount? decimal - The amount collected by avalara for this return
- taxDueAmount? decimal - The tax due amount.
- nonTaxableAmount? decimal - The non-taxable amount.
- nonTaxableDueAmount? decimal - The non-taxable due amount.
- consumerUseTaxAmount? decimal - Consumer use tax liability.
- consumerUseNonTaxableAmount? decimal - Consumer use non-taxable amount.
- consumerUseTaxableAmount? decimal - Consumer use taxable amount.
- excludedSalesAmount? decimal - The amount of sales excluded from the liability calculation
- excludedNonTaxableAmount? decimal - The amount of non-taxable sales excluded from the liability calculation
- excludedTaxAmount? decimal - The amount of tax excluded from the liability calculation
- accrualType? string - Accrual type of the return
- attachments? FilingAttachmentModel[] - The attachments for this return.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
avatax: FilingReturnModelBasicFetchResult
Fields
- '\@recordsetCount? int -
- value? FilingReturnModelBasic[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FilingsCheckupAuthorityModel
Cycle Safe Expiration results.
Fields
- taxAuthorityId? int - Unique ID of the tax authority
- locationCode? string - Location Code of the tax authority
- taxAuthorityName? string - Name of the tax authority
- taxAuthorityTypeId? int - Type Id of the tax authority
- jurisdictionId? int - Jurisdiction Id of the tax authority
- tax? decimal - Amount of tax collected in this tax authority
- taxTypeId? string - Tax Type collected in the tax authority
- suggestedForms? FilingsCheckupSuggestedFormModel[] - Suggested forms to file due to tax collected
avatax: FilingsCheckupModel
Results of the Worksheet Checkup report
Fields
avatax: FilingsCheckupSuggestedFormModel
Worksheet Checkup Report Suggested Form Model
Fields
- taxAuthorityId? int - Tax Authority ID of the suggested form returned
- country? string - Country of the suggested form returned
- region? string - Region of the suggested form returned
- taxFormCode? string - Name of the suggested form returned
- returnName? string - Legacy Name of the suggested form returned
avatax: FilingStatusChangeModel
Represents a change request for filing status for a company
Fields
- requestedStatus? string - Indicates the filing status you are requesting for this company
avatax: FilingsTaxDetailsModel
Represents a listing of all tax calculation data for filings and for accruing to future filings.
Fields
- taxType? string - The tax type associated with the summary
- salesAmount? decimal - The total sales amount
- nonTaxableAmount? decimal - The nontaxable amount
- taxAmount? decimal - The tax amount
- numberOfNights? int - The number of nights
avatax: FilingsTaxSummaryModel
Represents a listing of all tax calculation data for filings and for accruing to future filings.
Fields
- salesAmount? decimal - The total sales amount
- taxableAmount? decimal - The taxable amount
- nonTaxableAmount? decimal - The nontaxable amount
- taxAmount? decimal - The tax amount
- remittanceAmount? decimal - The remittance amount
- collectAmount? decimal - The collect amount
- salesAccrualAmount? decimal - The sales accrual amount
- taxableAccrualAmount? decimal - The taxable sales accrual amount
- nonTaxableAccrualAmount? decimal - The nontaxable accrual amount
- taxAccrualAmount? decimal - The tax accrual amount
- reportableSalesAmount? decimal - reportableSalesAmount
- reportableNonTaxableAmount? decimal - reportableNonTaxableAmount
- reportableTaxableAmount? decimal - reportableTaxableAmount
- reportableTaxAmount? decimal - reportableTaxAmount
avatax: FirmClientLinkageInputModel
Account Linkage Input model
Fields
- clientAccountId int - Client AccountId that needs to be linked to the firm
- clientAccountName string - Client AccountName that needs to be linked to the firm
avatax: FirmClientLinkageOutputModel
Account Linkage output model
Fields
- id? int - The unique ID number of firm-client linkage.
- firmAccountId? int - Firm Account to be linked with the firm
- firmAccountName? string - FIrm Account name
- clientAccountId? int - Client Account to be linked with the firm
- clientAccountName? string - Client Account name
- createdDate? string - Created date of the linkage
- createdUserId? int - User who created the linkage
- modifiedDate? string - Modified date of the linkage
- modifiedUserId? int - User who modified the linkage
- status? string - The status of the account linkage. The following are the available statuses
- Requested - When a linkage is requested
- Approved - When the linkage is approved
- Rejected - When the linkage is rejected
- Revoked - When the linkage is revoked.
- isDeleted? boolean - This is set to 1 if the linkage is deleted.
- firmContactName? string - Name of the firm's point of contact person for the client
- firmContactEmail? string - Email of the firm's point of contact person for the client
avatax: FirmClientLinkageOutputModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FirmClientLinkageOutputModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FormMasterModel
Represents information about a tax form known to Avalara
Fields
- id? int - Unique ID number of this form master object
- formTypeId? int - The type of the form being submitted
- taxFormCode? string - Unique tax form code representing this tax form
- legacyReturnName? string - Legacy return name as known in the AvaFileForm table
- taxFormName? string - Human readable form summary name
- description? string - Description of this tax form
- isEffective? boolean - True if this form is available for use
- country? string - ISO 3166 code of the country that issued this tax form
- region? string - The region within which this form was issued
- shortCode? string - DEPRECATED
- dueDay? int - Day of the month when the form is due
- delinquentDay? int - Day of the month on which the form is considered delinquent. Almost always the same as DueDay
- fiscalYearStartMonth? int - Month of the year the state considers as the first fiscal month
- hasMultiFrequencies? boolean - Can form support multi frequencies
- isPOARequired? boolean - Does this tax authority require a power of attorney in order to speak to Avalara
- isRegistrationRequired? boolean - True if this form requires that the customer register with the authority
- hasMultiRegistrationMethods? boolean - Unused
- hasSchedules? boolean - Unused
- hasMultiFilingMethods? boolean - Unused
- hasMultiPayMethods? boolean - Unused
- isEFTRequired? boolean - Unused
- isFilePayMethodLinked? boolean - Unused
- mailingReceivedRuleId? int - Unused
- proofOfMailingId? int - Unused
- isNegAmountAllowed? boolean - True if you can report a negative amount in a single jurisdiction on the form
- allowNegativeOverallTax? boolean - True if the form overall can go negative
- isNettingRequired? boolean - Unused
- roundingMethodId? int - Unused
- vendorDiscountAnnualMax? decimal - Total amount of discounts that can be received by a vendor each year
- versionsRequireAuthorityApproval? boolean - Unused
- outletReportingMethodId? int - Type of outlet reporting for this form
- hasReportingCodes? boolean - Unused
- hasPrepayments? boolean - Not sure if used
- grossIncludesInterstateSales? boolean - Unused
- grossIncludesTax? string - Unused
- hasEfileFee? boolean - Unused
- hasEpayFee? boolean - Unused
- hasDependencies? boolean - Unused
- requiredEfileTrigger? string - Unused
- requiredEftTrigger? string - Unused
- vendorDiscountEfile? boolean - Unused
- vendorDiscountPaper? boolean - Unused
- peerReviewed? string - Unused
- peerReviewedId? string - Unused
- peerReviewedDate? string - Unused
- createdUserId? int - ID of the Avalara user who created the form
- createdDate? string - Date when form was created
- modifiedUserId? int - ID of the Avalara user who modified the form
- modifiedDate? string - Date when form was modified
- dorAddressMailTo? string - Mailing address of the department of revenue
- dorAddress1? string - Mailing address of the department of revenue
- dorAddress2? string - Mailing address of the department of revenue
- dorAddressCity? string - Mailing address of the department of revenue
- dorAddressRegion? string - Mailing address of the department of revenue
- dorAddressPostalCode? string - Mailing address of the department of revenue
- dorAddressCountry? string - Mailing address of the department of revenue
- zeroAddressMailTo? string - Mailing address to use when a zero dollar form is filed
- zeroAddress1? string - Mailing address to use when a zero dollar form is filed
- zeroAddress2? string - Mailing address to use when a zero dollar form is filed
- zeroAddressCity? string - Mailing address to use when a zero dollar form is filed
- zeroAddressRegion? string - Mailing address to use when a zero dollar form is filed
- zeroAddressPostalCode? string - Mailing address to use when a zero dollar form is filed
- zeroAddressCountry? string - Mailing address to use when a zero dollar form is filed
- amendedAddressMailTo? string - Mailing address to use when filing an amended return
- amendedAddress1? string - Mailing address to use when filing an amended return
- amendedAddress2? string - Mailing address to use when filing an amended return
- amendedAddressCity? string - Mailing address to use when filing an amended return
- amendedAddressRegion? string - Mailing address to use when filing an amended return
- amendedAddressPostalCode? string - Mailing address to use when filing an amended return
- amendedAddressCountry? string - Mailing address to use when filing an amended return
- onlineBackFiling? boolean - Unused
- onlineAmendedReturns? boolean - Unused
- prepaymentFrequency? string - --Need Further Clarification
- outletLocationIdentifiersRequired? boolean - Unused
- listingSortOrder? string - --Need Further Clarification
- dorWebsite? string - Link to the state department of revenue website, if available
- fileForAllOutlets? boolean - --Need Further Clarification
- paperFormsDoNotHaveDiscounts? boolean - --Need Further Clarification
- stackAggregation? boolean - Internal behavior
- roundingPrecision? string - --Need Further Clarification
- inconsistencyTolerance? string - --Need Further Clarification
- effDate? string - Date when this form became effective
- endDate? string - Date when this form expired
- visibleToCustomers? boolean - True if this form can be shown to customers
- requiresOutletSetup? boolean - True if this form requires that you set up outlets in the state
- achCreditAllowed? boolean - True if this state permits payment by ACH Credit
- reportLevel? string - Jurisdiction level of the state
- postOfficeValidated? boolean - True if this form is verified filed via email
- stackAggregationOption? string - Internal Avalara flag
- sstBehavior? string - Internal Avalara flag
- nonSstBehavior? string - Internal Avalara flag
- dorPhoneNumber? string - Phone number of the department of revenue
- averageCheckClearDays? string - Unused
- filterZeroRatedLineDetails? boolean - Unused
- allowsBulkFilingAccounts? boolean - Unused
- bulkAccountInstructionLink? string - Unused
- registrationIdFormat? string - Unused
- thresholdTrigger? string - Unused
- transactionSortingOption? string - Unused
- contentReviewFrequencyId? int - Unused
- aliasForFormMasterId? string - Unused
avatax: FormMasterModelFetchResult
Fields
- '\@recordsetCount? int -
- value? FormMasterModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: FreeTrialRequestModel
Represents a request for a free trial account for AvaTax. Free trial accounts are only available on the Sandbox environment.
Fields
- firstName string - The first or given name of the user requesting a free trial.
- lastName string - The last or family name of the user requesting a free trial.
- email string - The email address of the user requesting a free trial.
- company string - The company or organizational name for this free trial. If this account is for personal use, it is acceptable to use your full name here.
- phone string - The phone number of the person requesting the free trial.
- campaign? string - Campaign identifier for Notification purpose
- companyAddress CompanyAddress - Company Address Information
- website? string - Website of the company or user requesting a free trial
- haveReadAvalaraTermsAndConditions boolean - Read Avalara's terms and conditions is necessary for a free trial account
- acceptAvalaraTermsAndConditions boolean - Accept Avalara's terms and conditions is necessary for a free trial
avatax: FrequencyAvailableModel
Frequency Available object
Fields
- frequencyCode? string - Frequency Code
- frequencyName? string - Frequency Name
- reason? string - Reason
- availableCycles? AvailableCycleModel[] - Expired Calendar End Date
avatax: FundingConfigurationModel
Status of an Avalara Managed Returns funding configuration for a company
Fields
- companyId? int - CompanyID
- systemType? string - Domain
- currency? string - Recipient
- isFundingSetup? boolean - Sender
- fundingMethod? string - DocumentKey
- lastUpdated? string - LastPolled
avatax: FundingESignMethodReturn
Represents the current status of a funding ESign method
Fields
- method? string - Method
- javaScriptReady? boolean - JavaScriptReady
- javaScript? string - The actual javascript to use to render this object
avatax: FundingInitiateModel
Fields
- requestEmail? boolean - Set this value to true to request an email to the recipient
- fundingEmailRecipient string - If you have requested an email for funding setup, this is the recipient who will receive an email inviting them to setup funding configuration for Avalara Managed Returns. The recipient can then click on a link in the email and setup funding configuration for this company.
- requestWidget? boolean - Set this value to true to request an HTML-based funding widget that can be embedded within an existing user interface. A user can then interact with the HTML-based funding widget to set up funding information for the company.
avatax: FundingStatusModel
Status of an Avalara Managed Returns funding configuration for a company
Fields
- requestId? int - The unique ID number of this funding request
- subledgerProfileID? int - SubledgerProfileID
- companyID? string - CompanyID
- domain? string - Domain
- recipient? string - Recipient
- sender? string - Sender
- documentKey? string - DocumentKey
- documentType? string - DocumentType
- documentName? string - DocumentName
- methodReturn? FundingESignMethodReturn - Represents the current status of a funding ESign method
- status? string - Status
- errorMessage? string - ErrorMessage
- lastPolled? string - LastPolled
- lastSigned? string - LastSigned
- lastActivated? string - LastActivated
- templateRequestId? int - TemplateRequestId
avatax: HsCodeModel
Describes an element in the harmonized tariff system.
According to the United States International Trade Commission, the harmonized tariff schedule is defined as follows:
The HTS is a U.S. nomenclature system used to classify traded goods based on their material composition, product name, and/or intended function. The HTS is designed so that each article falls into only one category. It is divided into chapters, each of which has a 2-digit number. Each product category within the various chapters is designated by 4, 6, 8, or 10 digits. The 4-digit categories are called "headings." The 6-, 8- and 10-digit classifications are called "subheadings."
Within AvaTax, the HsCodeModel object can refer to sections, chapters, headings, subheadings, or articles. Each object represents one
classification. Many of these objects have child objects underneath them; these child objects are more specific than their parent objects.
Fields
- hsCode? string - The harmonized tariff system code for this section and chapter. A full HS code contains more than six characters. Partial HS codes with two, four, or six characters may have child codes underneath them. A child code is one that contains greater specificity than a parent code. It is recommended that when you identify a product you use the most detailed code available to identify it. Top level sections do not have HS Codes.
- id int - A unique identifier for this harmonized tariff system code.
To search for a list of child codes underneath a specific HS code, search for codes where the child's
parentHsCodeIdvalue matches the parent'sidvalue.
- parentHsCodeId? int - The unique ID number of the parent HS code or HS code prefix.
To search for a list of child codes underneath a specific HS code, search for codes where the child's
parentHsCodeIdvalue matches the parent'sidvalue.
- description string - A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading.
- system? string - The system to which this HS code belongs.
- destinationCountry? string - The destination country identified with this HS Code. This value applies when certain products are classified in specific ways by bilateral trade agreements.
- effDate? string - For codes that have been expired or defined on specific dates, this value indicates the earliest date for which this code is considered valid. If this value is null, this code can be used for any valid date earlier than its end date.
- endDate? string - For codes that have been expired or defined on specific dates, this value indicates the latest date for which this code is considered valid. If this value is null, this code can be used for any valid date later than its effective date.
avatax: HsCodeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? HsCodeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: IdAttachmentBody
Fields
- file string - The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
avatax: InspectResponseModel
Response model used as output for InspectLine API.
Fields
- determinationFactors? DeterminationFactorModel[] - A list of determination factors for a line that is being inspected through the InspectLine API.
avatax: InvoiceMessageModel
Represents a message to be displayed on an invoice.
Fields
- content? string - The content of the invoice message.
- lineNumbers? string[] - The applicable tax line numbers and codes.
avatax: IsoCountryModel
Represents an ISO 3166 recognized country
Fields
- code? string - The two character ISO 3166 country code
- alpha3Code? string - The three character ISO 3166 country code
- name? string - The full name of this country in uppercase.
For names in proper or formal case, or for names in other languages, please examine the
localizedNameselement for an appropriate name.
- isEuropeanUnion? boolean - True if this country is a member of the European Union
- localizedNames? IsoLocalizedName[] - A list of localized names in a variety of languages. This list is maintained by the International Standards Organization.
- addressesRequireRegion? boolean - Whether or not this country requires a region in postal addresses.
avatax: IsoCountryModelFetchResult
Fields
- '\@recordsetCount? int -
- value? IsoCountryModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: IsoLocalizedName
Represents a language-specific localized name of a particular geographic entity such as a country or a region.
Fields
- languageAlpha2Code? string - The two-character alphanumeric code identifying the language in which this name is used. Note that languageAlpha2Code and language3AlphaCode refer to the same language.
- languageAlpha3Code? string - The three-character alphanumeric code identifying the language in which this name is used. Note that languageAlpha2Code and language3AlphaCode refer to the same language.
- name? string - The name of this geographic entity as known in this language.
avatax: IsoRegionModel
Represents a region, province, or state within a country
Fields
- countryCode? string - The two-character ISO 3166 country code this region belongs to
- code? string - The three character ISO 3166 region code
- name? string - The full name, using localized characters, for this region, in uppercase.
For names in proper or formal case, or for names in other languages, please examine the
localizedNameselement for an appropriate name.
- classification? string - The word in the local language that classifies what type of a region this represents
- streamlinedSalesTax? boolean - For the United States, this flag indicates whether a U.S. State participates in the Streamlined Sales Tax program. For countries other than the US, this flag is null.
- localizedNames? IsoLocalizedName[] - A list of localized names in a variety of languages. This list is maintained by the International Standards Organization.
- isRegionTaxable? boolean - Whether the region collects tax or not. This field will be populated for US country only and will be null for all the other countries.
avatax: IsoRegionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? IsoRegionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ItemBulkUploadInputModel
Represents a bulk upload input model.
Fields
- items? ItemModel[] - List of items
avatax: ItemBulkUploadOutputModel
Represents a bulk upload response model.
Fields
- total? int - Count of processed objects
- failed? ItemUploadErrorModel[] - Dictionary of object and respective list of errors
avatax: ItemClassificationInputModel
Product classification input model.
Fields
- productCode string - The product code of an item in a given system.
- systemCode? string - The system code in which the product belongs.
avatax: ItemClassificationOutputModel
Product classification output model.
Fields
- id? int - The unique ID number of this product.
- itemId? int - The unique ID number of the item this product belongs to.
- systemId? int - The system id which the product belongs.
- productCode? string - A unique code representing this item.
- systemCode? string - A unique code representing this item.
avatax: ItemClassificationOutputModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ItemClassificationOutputModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ItemModel
Represents an item in your company's product catalog.
Fields
- id int - The unique ID number of this item.
- companyId? int - The unique ID number of the company that owns this item.
- itemCode string - A unique code representing this item.
- taxCodeId? int - DEPRECATED - Date: 11/13/2018, Version: 18.12, Message: For identifying an
ItemwithAvalara TaxCode, please call the [CreateItemClassification API] with your ItemCode and the Avalara TaxCode. The unique ID number of the tax code that is applied when selling this item. When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values.
- taxCode? string - DEPRECATED - Date: 11/13/2018, Version: 18.12, Message: For identifying an
ItemwithAvalara TaxCode, please call the [CreateItemClassification API] with your ItemCode and the Avalara TaxCode. The unique code string of the Tax Code that is applied when selling this item. When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values.
- description string - A friendly description of this item in your product catalog.
- itemGroup? string - A way to group similar items.
- category? string - A category of product
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- classifications? ClassificationModel[] - List of classifications that belong to this item. A single classification consits of a productCode and a systemCode for a particular item.
- parameters? ItemParameterModel[] - List of item parameters.
avatax: ItemModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ItemModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ItemParameterModel
Represents a parameter associated with an item.
Fields
- id? int - The id of the parameter.
- name string - The parameter's name.
- value string - The value for the parameter.
- unit? string - The unit of measurement code for the parameter.
- itemId? int - The item id
- isNeededForCalculation? boolean - This field identifies if parameter is needed for calculation
- isNeededForReturns? boolean - This field identifies if parameter is needed for returns
- isNeededForClassification? boolean - This field identifies if parameter is needed for classification
avatax: ItemParameterModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ItemParameterModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ItemSyncModel
An abridged item model used for syncing product catalogs with AvaTax.
Fields
- itemCode string - A unique code representing this item.
- description string - A friendly description of the item. If your company has enrolled in Streamlined Sales Tax, this description must be auditable.
- itemGroup? string - A group to which the item belongs.
- taxCode? string - The tax code of the item (optional)
avatax: ItemTagDetailModel
Represents a tag for an item in your company's product catalog.
Fields
- itemTagDetailId? int - The unique ID number of the item-tag relation.
- tagId? int - The unique tag Id for the tags.
- tagName string - The tag name.
- itemId? int - The unique ID number of this item.
- companyId? int - The unique ID number of the company that owns this item.
- createdDate? string - The date when this record was created.
avatax: ItemTagDetailModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ItemTagDetailModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ItemUploadErrorModel
Represents a item upload error model.
Fields
- rowIndex? int - Row index of an item
- itemCode? string - Item code
- errors? string[] - List of errors for against given item code
avatax: JurisdictionModel
Represents information about a single legal taxing jurisdiction
Fields
- code string - The code that is used to identify this jurisdiction
- name string - The name of this jurisdiction
- 'type string - The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
- rate? decimal - The base rate of tax specific to this jurisdiction.
- salesRate? decimal - The "Sales" tax rate specific to this jurisdiction.
- signatureCode string - The Avalara-supplied signature code for this jurisdiction.
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- useRate? decimal - The "Seller's Use" tax rate specific to this jurisdiction.
- city? string - The city name of this jurisdiction
- county? string - The county name of this jurisdiction
- country? string - Name or ISO 3166 code identifying the country of this jurisdiction.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- shortName? string - A short name of the jurisidiction
- stateFips? string - State FIPS code
- countyFips? string - County FIPS code
- placeFips? string - City FIPS code
- id? int - Unique AvaTax Id of this Jurisdiction
- effectiveDate? string - The date this jurisdiction starts to take effect on tax calculations
- endDate? string - The date this jurisdiction stops to take effect on tax calculations
avatax: JurisdictionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? JurisdictionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: JurisdictionOverrideModel
Represents an override of tax jurisdictions for a specific address.
During the time period represented by EffDate through EndDate, all tax decisions for addresses matching this override object will be assigned to the list of jurisdictions designated in this object.
Fields
- id? int - The unique ID number of this override.
- accountId? int - The unique ID number assigned to this account.
- description string - A description of why this jurisdiction override was created.
- line1? string - The street address of the physical location affected by this override.
- city? string - The city address of the physical location affected by this override.
- region string - Name or ISO 3166 code identifying the region within the country to be affected by this override.
Note that only United States addresses are affected by the jurisdiction override system.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - The two character ISO-3166 country code of the country affected by this override. Note that only United States addresses are affected by the jurisdiction override system.
- postalCode string - The postal code of the physical location affected by this override.
- effectiveDate? string - The date when this override first takes effect. Set this value to null to affect all dates up to the end date.
- endDate? string - The date when this override will cease to take effect. Set this value to null to never expire.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- jurisdictions JurisdictionModel[] - A list of the tax jurisdictions that will be assigned to this overridden address.
- taxRegionId int - The TaxRegionId of the new location affected by this jurisdiction override.
- boundaryLevel? string - The boundary level of this override
- isDefault? boolean - True if this is a default boundary
avatax: JurisdictionOverrideModelFetchResult
Fields
- '\@recordsetCount? int -
- value? JurisdictionOverrideModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: JurisdictionRateTypeTaxTypeMappingModel
Represents a Jurisdiction with applicable TaxType, TaxSubType and RateType.
Fields
- id? int - The unique ID number of this Jurisdiction RateType TaxType Mapping.
- country? string - Name or ISO 3166 code identifying the country of this jurisdiction.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- state? string - Name or ISO 3166 code identifying the region of this jurisdiction.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- jurisdictionType? string - Jurisdiction TypeId
- jurisdictionCode? string - Jurisdiction Code
- longName? string - Jurisdiction long name
- taxTypeId? string - Tax Type to which this jurisdiction is applicable
- taxSubTypeId? string - Tax Type to which this jurisdiction is applicable
- taxTypeGroupId? string - Tax Type Group to which this jurisdiction is applicable
- rateTypeId? string - Rate Type to which this jurisdiction is applicable
- effectiveDate? string - The date this jurisdiction starts to take effect on tax calculations
- endDate? string - The date this jurisdiction stops to take effect on tax calculations
avatax: JurisdictionRateTypeTaxTypeMappingModelFetchResult
Fields
- '\@recordsetCount? int -
- value? JurisdictionRateTypeTaxTypeMappingModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: LicenseKeyModel
Represents a license key for this account.
Fields
- accountId? int - The primary key of the account
- privateLicenseKey? string - This is your private license key. You must record this license key for safekeeping. If you lose this key, you must contact the ResetLicenseKey API in order to request a new one. Each account can only have one license key at a time.
- httpRequestHeader? string - If your software allows you to specify the HTTP Authorization header directly, this is the header string you should use when contacting Avalara to make API calls with this license key.
avatax: LineItemModel
Represents one line item in a transaction
Fields
- number? string - The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.
- quantity? decimal - Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds. If not provided, or if set to zero, the quantity value is assumed to be one (1).
- amount decimal - Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the
customerCodefield) to the company (represented by thecompanyCode) field. For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company. For refund or return transactions, this value must be negative.
- addresses? AddressesModel - Information about all the addresses involved in this transaction.
For a physical in-person transaction at a retail point-of-sale location, please specify only one address using
the
singleLocationfield. For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to a destination location such as a customer, please specify theshipFromandshipToaddresses. In the United States, some jurisdictions recognize the address typespointOfOrderOriginandpointOfOrderAcceptance. These address types affect the sourcing models of some transactions. If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses.
- taxCode? string - Tax Code - System or Custom Tax Code.
You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see
ListTaxCodes.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use
entityUseCodeinstead.
- entityUseCode? string - Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that
may make this transaction considered exempt by reason of exempt usage.
For a list of entity use codes, see the Definitions API
ListEntityUseCodes.
- itemCode? string - Item Code (SKU). If you provide an
itemCodefield, the AvaTax API will look up the item you created with theCreateItemsAPI call and use all the information available about that item for this transaction.
- exemptionCode? string - The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. Note: This is same as 'exemptNo' in TransactionModel.
- discounted? boolean - True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be
applied to this line even if they are specified on the root
discountelement.
- taxIncluded? boolean - Indicates whether the
amountfor this line already includes tax. If this value istrue, the final price of this line including tax will equal the value inamount. If this value isnullorfalse, the final price will equalamountplus whatever taxes apply to this line.
- revenueAccount? string - Revenue Account (Customer Defined Field). This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
- ref1? string - Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
- ref2? string - Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
- description? string - Item description.
For Streamlined Sales Tax (SST) customers, this field is required if an unmapped
itemCodeis used.
- businessIdentificationNo? string - VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
- taxOverride? TaxOverrideModel - Represents a tax override for a transaction
- parameters? TransactionLineParameterModel[] - Special parameters that apply to this line within this transaction.
To get a full list of available parameters, please use the
ListParametersAPI.
- userDefinedFields? TransactionLineUserDefinedFieldModel[] - Custom user fields/flex fields for this line.
- hsCode? string - The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction. For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.
- merchantSellerId? int - DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead. ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
- merchantSellerIdentifier? string - ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
- marketplaceLiabilityType? string - This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.
- originationDocumentId? string - The transaction's original ID in its origination system
- originationSite? string - Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.
- category? string - Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “. Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.
- summary? string - A long description of the product.
avatax: LinkCertificatesModel
Represents a customer to whom you sell products and/or services.
Fields
- certificates int[] - An array of certificate ID numbers to link
avatax: LinkCustomersModel
Represents a customer to whom you sell products and/or services.
Fields
- customers? string[] - An array of customerCodes that are exempted by this certificate
avatax: LocationModel
A location where this company does business. Some jurisdictions may require you to list all locations where your company does business.
Fields
- id int - The unique ID number of this location.
- companyId? int - The unique ID number of the company that operates at this location.
- locationCode string - A code that identifies this location. Must be unique within your company.
- description? string - A friendly name for this location.
- addressTypeId string - Indicates whether this location is a physical place of business or a temporary salesperson location.
- addressCategoryId string - Indicates the type of place of business represented by this location.
- isMarketplaceOutsideUsa? boolean - Indicates whether the Marketplace is outside or in USA
- line1 string - The first line of the physical address of this location.
- line2? string - The second line of the physical address of this location.
- line3? string - The third line of the physical address of this location.
- city? string - The city of the physical address of this location.
- county? string - The county name of the physical address of this location. Not required.
- region? string - Name or ISO 3166 code identifying the region within the country of the physical address of this location.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- postalCode string - The postal code or zip code of the physical address of this location.
- country string - Name or ISO 3166 code identifying the country of the physical address of this location.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- isDefault? boolean - Set this flag to true to indicate that this is the default location for this company.
- isRegistered? boolean - Set this flag to true to indicate that this location has been registered with a tax authority.
- dbaName? string - If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.
- outletName? string - A friendly name for this location.
- effectiveDate? string - The date when this location was opened for business, or null if not known.
- endDate? string - If this place of business has closed, the date when this location closed business.
- lastTransactionDate? string - The most recent date when a transaction was processed for this location. Set by AvaTax.
- registeredDate? string - The date when this location was registered with a tax authority. Not required.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- settings? LocationSettingModel[] - Extra information required by certain jurisdictions for filing. For a list of settings recognized by Avalara, query the endpoint "/api/v2/definitions/locationquestions". To determine the list of settings required for this location, query the endpoint "/api/v2/companies/(id)/locations/(id)/validate".
- parameters? LocationParameterModel[] - List of location parameters.
avatax: LocationModelFetchResult
Fields
- '\@recordsetCount? int -
- value? LocationModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: LocationParameterModel
The parameter associated with a company location.
Fields
- id? int - The ID number of the parameter.
- name string - The parameter's name.
- unit? string - The parameter's value.
- value string - The value of the parameter.
- locationId? int - The ID of the company location the parameter associated with.
avatax: LocationParameterModelFetchResult
Fields
- '\@recordsetCount? int -
- value? LocationParameterModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: LocationQuestionModel
Information about questions that the local jurisdictions require for each location
Fields
- id int - The unique ID number of this location setting type
- question string - This is the prompt for this question
- description string - If additional information is available about the location setting, this contains descriptive text to help you identify the correct value to provide in this setting.
- regularExpression? string - If available, this regular expression will verify that the input from the user is in the expected format.
- exampleValue? string - If available, this is an example value that you can demonstrate to the user to show what is expected.
- jurisdictionName? string - Indicates which jurisdiction requires this question
- jurisdictionType? string - Indicates which type of jurisdiction requires this question
- jurisdictionCountry? string - Indicates the country that this jurisdiction belongs to
- jurisdictionRegion? string - Indicates the state, region, or province that this jurisdiction belongs to
- helpText? string - Help and guidance for this specific question
- maxLength? int - Maximum length of the answer string
- required? boolean - True if this question must be answered for this filing calendar
- dataType? string - Data type of the answer
- staticOptions? string -
- unique? boolean -
avatax: LocationQuestionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? LocationQuestionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: LocationSettingModel
Represents the answer to one local jurisdiction question for a location.
Fields
- questionId? int - The unique ID number of the location question answered.
- questionName? string - The name of the question
- value? string - The answer the user provided.
avatax: LocationValidationModel
Tells you whether this location object has been correctly set up to the local jurisdiction's standards
Fields
- settingsValidated? boolean - True if the location has a value for each jurisdiction-required setting. The user is required to ensure that the values are correct according to the jurisdiction; this flag does not indicate whether the taxing jurisdiction has accepted the data you have provided.
- requiredSettings? LocationQuestionModel[] - A list of settings that must be defined for this location
avatax: LockTransactionModel
Commit this transaction as permanent
Fields
- isLocked boolean - Set this value to be true to commit this transaction. Committing a transaction allows it to be reported on a tax return. Uncommitted transactions will not be reported.
avatax: LoginVerificationInputModel
Represents a verification request using Skyscraper for a company
Fields
- companyId int - CompanyId that we are verifying the login information for
- accountId int - AccountId of the login verification
- region string - Region of the verification request
- taxFormCode? string - TaxFormCode for the verification request
- username string - Username that we are using for verification
- password string - Password we are using for verification
- additionalOptions? record {} - Additional options of the verification
- bulkRequestId? int - Bulk Request Id of the verification
- priority? int - Priority of the verification request
avatax: LoginVerificationOutputModel
This is the output model coming from skyscraper services
Fields
- jobId int - The job Id returned from skyscraper
- operationStatus? string - The operation status of the job
- message? string - The message returned from the job
- loginSuccess? boolean - Indicates if the login was successful
avatax: MarketplaceLocationModel
Marketplace Location Output model
Fields
- region? string - Marketplace Location State
- country? string - Marketplace Location Country
- marketplaceId? string - Marketplace Location Id
- marketplace? string - Marketplace Location
- marketplaceAdoptionDate? string - Marketplace Location Adoption Date
- marketplaceEndDate? string - Marketplace Location End Date
- legislativeEffectiveDate? string - Marketplace Location Legislative Effective Date
- enforcementDate? string - Marketplace Location Enforcement Date
- createdDate? string - Marketplace Location Created Date
- modifiedDate? string - Marketplace Location Modified Date
avatax: MarketplaceLocationModelFetchResult
Fields
- '\@recordsetCount? int -
- value? MarketplaceLocationModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: MarketplaceModel
Marketplace Location Output model
Fields
- marketplaceId? string - Marketplace Location Id
- marketplace? string - Marketplace Location
avatax: MarketplaceModelFetchResult
Fields
- '\@recordsetCount? int -
- value? MarketplaceModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: Message
Fields
- details? string -
- helpLink? string -
- name? string -
- refersTo? string -
- severity? string -
- 'source? string -
- summary? string -
avatax: MrsCompanyModel
A company and account
Fields
- companyId? int - The unique ID number of this company.
- companyName? string - The name of this company, as shown to customers.
- accountId? int - The unique ID number of the account this company belongs to.
- accountName? string - The name of this account, as shown to customers.
- tin? string - The taxpayer identification number for the company
- companyCode? string - The company code for the company
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: MrsCompanyModelFetchResult
Fields
- '\@recordsetCount? int -
- value? MrsCompanyModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: MultiDocumentLineItemModel
Represents one line item in a MultiDocument transaction
Fields
- companyCode? string - Specify the code of the company for this line of transaction.
If you leave this value null, the
companyCodeat the root level will be used instead.
- reportingLocationCode? string - Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
If you leave this value
null, thereportingLocationCodeat the root level will be used instead.
- number? string - The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.
- quantity? decimal - Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds. If not provided, or if set to zero, the quantity value is assumed to be one (1).
- amount decimal - Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the
customerCodefield) to the company (represented by thecompanyCode) field. For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company. For refund or return transactions, this value must be negative.
- addresses? AddressesModel - Information about all the addresses involved in this transaction.
For a physical in-person transaction at a retail point-of-sale location, please specify only one address using
the
singleLocationfield. For a transaction that was shipped, delivered, or provided from an origin location such as a warehouse to a destination location such as a customer, please specify theshipFromandshipToaddresses. In the United States, some jurisdictions recognize the address typespointOfOrderOriginandpointOfOrderAcceptance. These address types affect the sourcing models of some transactions. If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses.
- taxCode? string - Tax Code - System or Custom Tax Code.
You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see
ListTaxCodes.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use
entityUseCodeinstead.
- entityUseCode? string - Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that
may make this transaction considered exempt by reason of exempt usage.
For a list of entity use codes, see the Definitions API
ListEntityUseCodes.
- itemCode? string - Item Code (SKU). If you provide an
itemCodefield, the AvaTax API will look up the item you created with theCreateItemsAPI call and use all the information available about that item for this transaction.
- exemptionCode? string - The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. Note: This is same as 'exemptNo' in TransactionModel.
- discounted? boolean - True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be
applied to this line even if they are specified on the root
discountelement.
- taxIncluded? boolean - Indicates whether the
amountfor this line already includes tax. If this value istrue, the final price of this line including tax will equal the value inamount. If this value isnullorfalse, the final price will equalamountplus whatever taxes apply to this line.
- revenueAccount? string - Revenue Account (Customer Defined Field). This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
- ref1? string - Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
- ref2? string - Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
- description? string - Item description.
For Streamlined Sales Tax (SST) customers, this field is required if an unmapped
itemCodeis used.
- businessIdentificationNo? string - VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
- taxOverride? TaxOverrideModel - Represents a tax override for a transaction
- parameters? TransactionLineParameterModel[] - Special parameters that apply to this line within this transaction.
To get a full list of available parameters, please use the
ListParametersAPI.
- userDefinedFields? TransactionLineUserDefinedFieldModel[] - Custom user fields/flex fields for this line.
- hsCode? string - The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction. For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.
- merchantSellerId? int - DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead. ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
- merchantSellerIdentifier? string - ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
- marketplaceLiabilityType? string - This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.
- originationDocumentId? string - The transaction's original ID in its origination system
- originationSite? string - Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.
- category? string - Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “. Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.
- summary? string - A long description of the product.
avatax: MultiDocumentModel
A MultiDocument transaction represents a sale or purchase that occurred between more than two companies.
A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately.
Fields
- id? int - The unique ID number of this MultiDocument object.
- accountId? int - The unique ID number of the AvaTax customer account that created this MultiDocument object.
- code? string - The transaction code of the MultiDocument transaction. All individual transactions within this MultiDocument object will have this code as a prefix.
- 'type? string - Indicates the type of MultiDocument transaction. Common values are:
- SalesOrder - An estimate that is not permanently recorded
- SalesInvoice - An invoice that can be reported on a tax return
- createdUserId? int - The user ID of the user who created this record.
- createdDate? string - The date/time when this record was created.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- documents? TransactionModel[] - A separate document will exist for each unique combination of buyer and seller in this MultiDocument transaction.
avatax: MultiDocumentModelFetchResult
Fields
- '\@recordsetCount? int -
- value? MultiDocumentModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: MultiTaxFilingModel
Represents a listing of all tax calculation data for filings and for accruing to future filings.
Fields
- id? int - The unique ID number of this filing.
- companyId? int - The unique ID number of the company for this filing.
- month? int - The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- year? int - The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015.
- 'type? string - Indicates whether this is an original or an amended filing.
- taxSummary? FilingsTaxSummaryModel - Represents a listing of all tax calculation data for filings and for accruing to future filings.
- taxDetails? FilingsTaxDetailsModel[] - A detailed breakdown of the taxes in this filing
- filingRegions? MultiTaxFilingRegionModel[] - A listing of regional tax filings within this time period.
avatax: MultiTaxFilingModelFetchResult
Fields
- '\@recordsetCount? int -
- value? MultiTaxFilingModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: MultiTaxFilingRegionModel
Regions
Fields
- country? string - The two-character ISO-3166 code for the country.
- region? string - The two or three character region code for the region.
- hasNexus? boolean - Whether or not you have nexus in this region.
- status? string - The current status of the filing region.
- regionTaxSummary? FilingsTaxSummaryModel - Represents a listing of all tax calculation data for filings and for accruing to future filings.
- regionTaxDetails? FilingsTaxDetailsModel[] - A detailed breakdown of the taxes in this filing
- suggestReturns? FilingsCheckupSuggestedFormModel[] - A list of tax returns in this region.
- 'returns? MultiTaxFilingReturnModel[] - A list of tax returns in this region.
avatax: MultiTaxFilingReturnModel
Filing Returns Model
Fields
- id? int - The unique ID number of this filing return.
- filingCalendarId? int - The unique ID number of the filing calendar associated with this return.
- status? string - The current status of the filing return.
- filingFrequency? string - The filing frequency of the return.
- filingType? string - The filing type of the return.
- formName? string - The name of the form.
- formCode? string - The unique code of the form.
- description? string - A description for the return.
- taxAuthorityId? int - Tax Authority ID of this return
- filedDate? string - The date the return was filed by Avalara.
- accrualType? string - Accrual type of the return
- startPeriod? string - The start date of this return
- endPeriod? string - The end date of this return
- 'type? string - The FilingTaskType for this return.
- returnTaxSummary? FilingsTaxSummaryModel - Represents a listing of all tax calculation data for filings and for accruing to future filings.
- returnTaxDetails? FilingsTaxDetailsModel[] - A detailed breakdown of the taxes in this filing
- excludedCarryOverCredits? FilingReturnCreditModel - An attachment associated with a filing return
- appliedCarryOverCredits? FilingReturnCreditModel - An attachment associated with a filing return
- totalAdjustments? decimal - Total amount of adjustments on this return
- adjustments? FilingAdjustmentModel[] - The Adjustments for this return.
- totalAugmentations? decimal - Total amount of augmentations on this return
- augmentations? FilingAugmentationModel[] - The Augmentations for this return.
- totalPayments? decimal - Total amount of payments on this return
- payments? FilingPaymentModel[] - The payments for this return.
- attachments? FilingAttachmentModel[] - The attachments for this return.
avatax: NewAccountModel
Represents information about a newly created account
Fields
- accountId? int - This is the ID number of the account that was created
- accountDetailsEmailedTo? string - This is the email address to which credentials were mailed
- createdDate? string - The date and time when this account was created
- emailedDate? string - The date and time when account information was emailed to the user
- limitations? string - If this account includes any limitations, specify them here
- licenseKey? string - The license key of the account that was created
- paymentUrl? string - The payment url where the payment method can be set up
avatax: NewAccountRequestModel
Represents a request for a new account with Avalara for a new subscriber. Contains information about the account requested and the rate plan selected.
Fields
- offer string - The offer code provided to you by your Avalara business development contact. This code controls what services and rates the customer will be provisioned with upon creation. If you do not know your offer code, please contact your Avalara business development representative.
- connectorId? string - The id associated with the connector
- campaign? string - If your Avalara business development representative requests, please provide the campaign ID associated with your
signup process. This campaign identifier helps Avalara match users to the context in which they learned about the product
to help improve the accuracy of our messaging.
The
campaignfield must be either null or a value provided to you by an Avalara business development representative. If you provide an unexpected value in this field, your API call will fail.
- leadSource? string - If your Avalara business development representative requests, please provide the lead source value associated with your
signup process. This lead source identifier helps Avalara match users to the context in which they learned about the product
to help improve the accuracy of our messaging.
The
leadSourcefield must be either null or a value provided to you by an Avalara business development representative. If you provide an unexpected value in this field, your API call will fail.
- effectiveDate? string - The date on which the account should take effect. If null, defaults to today.
You should leave this value
nullunless specifically requested by your Avalara business development manager.
- endDate? string - The date on which the account should expire.
You should leave this value
nullunless specifically requested by your Avalara business development manager.
- accountName string - The name of the account to create
- website? string - Website of the new customer whose account is being created. It is strongly recommended to provide the customer's website URL, as this will help our support representatives better assist customers.
- paymentMethodId? string - Payment Method to be associated with the account. This is strictly to be used internally unless your Avalara business development manager specifically asks you to provide this value while attempting to create an account.
- firstName string - First name of the primary contact person for this account
- lastName string - Last name of the primary contact person for this account
- title? string - Title of the primary contact person for this account
- phoneNumber? string - Phone number of the primary contact person for this account
- email string - Email of the primary contact person for this account
- username? string - The username to be associated with the user created. If this is not provided, email address will be used as the username.
- userPassword? string - If instructed by your Avalara business development manager, set this value to a temporary password to permit the user to continue their onboarding process. If this value is null, a temporary password is generated by the system and emailed to the user. The user will then be asked to choose a permanent password when they first log on to the AvaTax website.
- welcomeEmail? string - This option controls what type of a welcome email is sent when the account is created.
Normal- A standard welcome email will be sent.Suppressed- No email will be sent.Custom- If your Avalara business development representative provides you with a customized welcome email for your customers, please select this option.
- companyAddress CompanyAddress - Company Address Information
- companyCode? string - Company code to be assigned to the company created for this account. If no company code is provided, this will be defaulted to "DEFAULT" company code.
- properties? string[] - Properties of the primary contact person for this account
- acceptAvalaraTermsAndConditions? boolean - Set this to true if and only if the owner of the newly created account accepts Avalara's terms and conditions for your account. Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key.
- haveReadAvalaraTermsAndConditions? boolean - Set this to true if and only if the owner of the newly created account has fully read Avalara's terms and conditions for your account. Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key.
- marketingContext? record {} - A dynamic key-value pair for the marketing context information
- accountType? string - Type of the account to be created. Regular, Firm or FirmClient
- taxPayerIdNumber? string - United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
avatax: NewFirmClientAccountRequestModel
Represents a request for a new account with Avalara for a new Firm client.
Fields
- accountName string - The name of the account to create
- firstName string - First name of the primary contact person for this account
- lastName string - Last name of the primary contact person for this account
- title? string - Title of the primary contact person for this account
- phoneNumber? string - Phone number of the primary contact person for this account
- email string - Email of the primary contact person for this account
- companyCode? string - Company code to be assigned to the company created for this account. If no company code is provided, this will be defaulted to "DEFAULT" company code.
- companyAddress CompanyAddress - Company Address Information
- taxPayerIdNumber? string - United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. This value is required if the address provided is inside the US. Otherwise it is optional.
- properties? string[] - Properties of the primary contact person for this account
avatax: NexusByAddressModel
Contains information about nexus jurisdictions that were declared
as a result of a call to DeclareNexusByAddress. For each address,
this object model contains a list of the nexus objects that were declared
according to the geocoding that corresponds to this address.
Fields
- address? DeclareNexusByAddressModel - Use this object to provide an address and date range where your company does business. This address will be used to determine what jurisdictions you should declare nexus and calculate tax.
- declaredNexus? NexusModel[] - List of all nexus objects that were affected by declaring nexus at the address specified
by
address.
avatax: NexusByTaxFormModel
Identifies all nexus that match a particular tax form
Fields
- formCode? string - The code of the tax form that was requested
- companyId? int - The company ID of the company that was used to load the companyNexus array. If this value is null, no company data was loaded.
- nexusDefinitions? NexusModel[] - A list of all Avalara-defined nexus that are relevant to this tax form
- companyNexus? NexusModel[] - A list of all currently-defined company nexus that are related to this tax form
avatax: NexusModel
Represents a declaration of nexus within a particular taxing jurisdiction.
To create a nexus declaration for your company, you must first call the Definitions API ListNexus to obtain a
list of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize
only the user-selectable fields in this object.
The user selectable fields for the nexus object are companyId, effectiveDate, endDate, localNexusTypeId,
taxId, nexusTypeId, hasPermanentEstablishment, and isSellerImporterOfRecord.
When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields
must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects
by calling ListNexus. If any data does not match, AvaTax may not recognize your nexus declaration.
Fields
- id? int - The unique ID number of this declaration of nexus. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.
- companyId? int - The unique ID number of the company that declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object.
- country string - Name or ISO 3166 code identifying the country in which this company declared nexus.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- region string - Name or ISO 3166 code identifying the region within the country.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- jurisTypeId? string - DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead. The jurisdiction type of the jurisdiction in which this company declared nexus.
- jurisdictionTypeId? string - The type of the jurisdiction in which this company declared nexus.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- jurisCode string - The code identifying the jurisdiction in which this company declared nexus.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- jurisName string - The common name of the jurisdiction in which this company declared nexus.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- effectiveDate? string - The date when this nexus began. If not known, set to null. This field is user-selectable and should be provided when creating or updating a nexus object.
- endDate? string - If this nexus will end or has ended on a specific date, set this to the date when this nexus ends. This field is user-selectable and should be provided when creating or updating a nexus object.
- shortName? string - The short name of the jurisdiction.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- signatureCode? string - The signature code of the boundary region as defined by Avalara.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- stateAssignedNo? string - The state assigned number of this jurisdiction.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- nexusTypeId? string - The type of nexus that this company is declaring.
If you are voluntarily declaring nexus in a jurisdiction, you should select
SalesOrSellersUseTaxfor your nexus type option. This option allows you to calculate tax correctly whether you are selling in-state or shipping from an out-of-state location. If you are legally obligated to declare nexus due to physical presence or other sufficient nexus, you should selectSalesTax. This indicates that, as a legal requirement, your company must always collect and remit full sales tax in this jurisdiction. If you are participating in the Streamlined Sales Tax program, your SST administrator will select nexus settings for you in all SST jurisdictions. Do not select any SST options by yourself. This field is user-selectable and should be provided when creating or updating a nexus object.
- sourcing? string - Indicates whether this nexus is defined as origin or destination nexus.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- hasLocalNexus? boolean - True if you are also declaring local nexus within this jurisdiction.
Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- localNexusTypeId? string - If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions. This field is user-selectable and should be provided when creating or updating a nexus object.
- hasPermanentEstablishment? boolean - Set this value to true if your company has a permanent establishment within this jurisdiction. This field is user-selectable and should be provided when creating or updating a nexus object.
- taxId? string - Optional - the tax identification number under which you declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object.
- streamlinedSalesTax? boolean - DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead.
For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates
in the Streamlined Sales Tax program. For countries other than the US, this flag is null.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- isSSTActive? boolean - For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates
in the Streamlined Sales Tax program and if the account associated with the Nexus has an active AvaTaxCsp subscription.
For countries other than the US, this flag is null.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- createdDate? string - The date when this record was created. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.
- createdUserId? int - The User ID of the user who created this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.
- modifiedDate? string - The date/time when this record was last modified. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.
- modifiedUserId? int - The user ID of the user who last modified this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.
- taxTypeGroup? string - The type group of nexus that this company is declaring
Use ListTaxTypeGroups API for a list of nexus tax type groups.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus. NOTE: This optional field will trigger nexus subtype lookup when populated. When using make sure TaxTypeGroup matches corresponding NexusTaxTypeGroup
- nexusTaxTypeGroup? string - The type of nexus that this company is declaring.Replaces NexusTypeId.
Use ListNexusTaxTypeGroups API for a list of nexus tax type groups.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- taxAuthorityId? int - A unique ID number of the tax authority that is associated with this nexus.
This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling
ListNexus.
- isSellerImporterOfRecord? boolean - For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region.
Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to
ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer
of record will then be the company designated to pay taxes marked as being obligated to the importer of record.
Set this value to
trueto consider your company as the importer of record and collect these taxes. Leave this value as false or null and taxes will be calculated as if your company is not the importer of record. This value may also be set during each transaction API call. SeeCreateTransaction()for more information. This field is user-selectable and should be provided when creating or updating a nexus object.
- taxName? string - A description of corresponding tax type applied to the nexus. When a custom nexus is created, it'll have to be matched to a system nexus to be validated successfully. The matched system nexus has a field to describe the tax type applied to it, that field will be copied over to the nexus that is being created. This field is defined by Avalara. Its main purpose is to give a simple description of the tax type associated with the nexus so users have a better understanding of the nexus when it is displayed.
- parameters? NexusParameterDetailModel[] - List of nexus parameters.
- taxableNexus? boolean - Shows if system nexus records are associated with tax collection
avatax: NexusModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NexusModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NexusParameterDetailModel
Represents a parameter associated with a nexus.
Fields
- id? int - The id of the parameter.
- name string - The parameter's name.
- value string - The value for the parameter.
- unit? string - The unit of measurement code for the parameter.
- nexusId? int - The nexus id
avatax: NexusParameterDetailModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NexusParameterDetailModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NexusSummaryModel
Nexus summary model
Fields
- companyId? int - Company Id
- nexusSummary? NexusTaxTypeGroupCountModel[] - Nexus summary for this company
avatax: NexusTaxTypeGroupCountModel
Nexus tax type groupe with count
Fields
- nexusTaxTypeGroup? string - Which nexus tax type group
- count? int - How many nexus in the group
avatax: NexusTaxTypeGroupModel
Represents a group of tax types
Fields
- id? int - The unique ID number of this nexus tax type group.
- nexusTaxTypeGroupId? string - The unique human readable Id of this nexus tax type group.
- description? string - The description of this nexus tax type group.
- subscriptionTypeId? int - If this tax type group requires a subscription, this contains the ID number of the subscription type required to use it.
- subscriptionDescription? string - If this tax type group requires a subscription, this contains the friendly name of the subscription type required to use it.
- tabName? string - The name of the tab in the AvaTax website corresponding to this tax type group.
- showColumn? boolean - True if this tax type group is displayed in the user interface of the AvaTax website.
avatax: NexusTaxTypeGroupModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NexusTaxTypeGroupModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeCommentModel
Represents communication between Avalara and the company regarding the processing of a tax notice.
Fields
- id? int - The unique ID number of this notice.
- noticeId int - The ID of the notice this comment is attached too
- date? string - The date this comment was entered
- comment? string - TaxNoticeComment
- commentUserId? int - TaxNoticeCommentUserId
- commentUserName? string - TaxNoticeCommentUserName
- commentTypeId? int - taxNoticeCommentTypeId
- commentType string - taxNoticeCommentType
- commentLink? string - TaxNoticeCommentLink
- taxNoticeFileName? string - TaxNoticeFileName
- resourceFileId? int - resourceFileId
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- attachmentUploadRequest? ResourceFileUploadRequestModel - A request to upload a file to Resource Files
avatax: NoticeCommentModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeCommentModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeCustomerFundingOptionModel
Tax Authority Model
Fields
- id int - The unique ID number of this tax notice customer FundingOption.
- description string - The description name of this tax authority FundingOption.
- activeFlag? boolean - A flag if the FundingOption is active
- sortOrder? int - sort order of the FundingOptions
avatax: NoticeCustomerFundingOptionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeCustomerFundingOptionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeCustomerTypeModel
Tax Authority Model
Fields
- id int - The unique ID number of this tax notice customer type.
- description string - The description name of this tax authority type.
- activeFlag? boolean - A flag if the type is active
- sortOrder? int - sort order of the types
avatax: NoticeCustomerTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeCustomerTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeFilingTypeModel
Tax Notice FilingType Model
Fields
- id int - The unique ID number of this tax notice customer type.
- description string - The description name of this tax authority type.
- activeFlag? boolean - A flag if the type is active
- sortOrder? int - sort order of the types
avatax: NoticeFilingTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeFilingTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeFinanceModel
Represents estimated financial results from responding to a tax notice.
Fields
- id? int - The Unique Id of the Finance Model
- noticeId? int - The unique ID of the the tax notice associated with the the finance detail
- noticeDate? string - The date of the notice
- dueDate? string - The due date of the notice
- noticeNumber? string - The sequential number of the notice
- taxDue? decimal - The amount of tax due on the notice
- penalty? decimal - The amound of penalty listed on the notice
- interest? decimal - The amount of interest listed on the notice
- credits? decimal - The amount of credits listed on the notice
- taxAbated? decimal - The amount of tax abated on the notice
- customerPenalty? decimal - The amount of customer penalty on the notice
- customerInterest? decimal - The amount of customer interest on the notice
- cspFeeRefund? decimal - The amount of CSP Fee Refund on the notice
- fileName? string - The name of the file attached to the finance detail
- resourceFileId? int - The ResourceFileId of the finance detail attachment
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- attachmentUploadRequest? ResourceFileUploadRequestModel - A request to upload a file to Resource Files
avatax: NoticeFinanceModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeFinanceModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeModel
Represents a letter received from a tax authority regarding tax filing. These letters often have the warning "Notice" printed at the top, which is why they are called "Notices".
Fields
- id int - The unique ID number of this notice.
- companyId int - The unique ID number of the company to which this notice belongs.
- statusId int - The status id of the notice
- status? string - The status of the notice
- receivedDate string - The received date of the notice
- closedDate? string - The closed date of the notice
- totalRemit? decimal - The total remmitance amount for the notice
- customerTypeId string - NoticeCustomerTypeID can be retrieved from the definitions API
- country? string - Name or ISO 3166 code identifying the country that sent this notice.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- region? string - Name or ISO 3166 code identifying the region within the country that sent this notice.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- taxAuthorityId? int - The tax authority id of the notice
- filingFrequency? string - The filing frequency of the notice
- filingTypeId? string - The filing type of the notice
- ticketReferenceNo? string - The ticket reference number of the notice
- ticketReferenceUrl? string - The ticket reference url of the notice
- salesForceCase? string - The sales force case of the notice
- salesForceCaseUrl? string - The URL to the sales force case
- taxPeriod? string - The tax period of the notice
- reasonId int - The notice reason id
- reason? string - The notice reason
- typeId? int - The tax notice type id
- 'type? string - The tax notice type description
- customerFundingOptionId? string - The notice customer funding options
- priorityId string - The priority of the notice
- customerComment? string - Comments from the customer on this notice
- hideFromCustomer boolean - Indicator to hide from customer
- expectedResolutionDate? string - Expected resolution date of the notice
- showResolutionDateToCustomer boolean - Indicator to show customer this resolution date
- closedByUserId? int - The unique ID number of the user that closed the notice
- createdByUserName? string - The user who created the notice
- ownedByUserId? int - The unique ID number of the user that owns the notice
- description? string - The description of the notice
- avaFileFormId? int - The ava file form id of the notice
- revenueContactId? int - The id of the revenue contact
- complianceContactId? int - The id of the compliance contact
- taxFormCode? string - The tax form code of the notice
- documentReference? string - The document reference of the notice
- jurisdictionName? string - The jurisdiction name of the notice
- jurisdictionType? string - The jurisdiction type of the notice
- comments? NoticeCommentModel[] - Additional comments on the notice
- finances? NoticeFinanceModel[] - Finance details of the notice
- responsibility? NoticeResponsibilityDetailModel[] - Notice Responsibility Details
- rootCause? NoticeRootCauseDetailModel[] - Notice Root Cause Details
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: NoticeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticePriorityModel
Tax Notice Priority Model
Fields
- id int - The unique ID number of this tax notice customer Priority.
- description string - The description name of this tax authority Priority.
- activeFlag? boolean - A flag if the Priority is active
- sortOrder? int - sort order of the Prioritys
avatax: NoticePriorityModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticePriorityModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeReasonModel
Tax Notice Reason Model
Fields
- id int - The unique ID number of this tax notice customer type.
- description string - The description name of this tax authority type.
- activeFlag? boolean - A flag if the type is active
- sortOrder? int - sort order of the types
avatax: NoticeReasonModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeReasonModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeResponsibilityDetailModel
NoticeResponsibility Model
Fields
- id? int - The unique ID number of this filing frequency.
- noticeId int - TaxNoticeId
- taxNoticeResponsibilityId int - TaxNoticeResponsibilityId
- description? string - The description name of this filing frequency
avatax: NoticeResponsibilityDetailModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeResponsibilityDetailModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeResponsibilityModel
NoticeResponsibility Model
Fields
- id? int - The unique ID number of this notice responsibility.
- description? string - The description name of this notice responsibility
- isActive? boolean - Defines if the responsibility is active
- sortOrder? int - The sort order of this responsibility
avatax: NoticeResponsibilityModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeResponsibilityModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeRootCauseDetailModel
NoticeRootCause Model
Fields
- id int - The unique ID number of this filing frequency.
- noticeId int - TaxNoticeId
- taxNoticeRootCauseId int - TaxNoticeRootCauseId
- description? string - The description name of this root cause
avatax: NoticeRootCauseDetailModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeRootCauseDetailModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeRootCauseModel
NoticeRootCause Model
Fields
- id? int - The unique ID number of this notice RootCause.
- description? string - The description name of this notice RootCause
- isActive? boolean - Defines if the RootCause is active
- sortOrder? int - The sort order of this RootCause
avatax: NoticeRootCauseModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeRootCauseModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeStatusModel
Tax Notice Status Model
Fields
- id int - The unique ID number of this tax authority type.
- description string - The description name of this tax authority type.
- isOpen? boolean - True if a tax notice in this status is considered 'open' and has more work expected to be done before it is closed.
- sortOrder? int - If a list of status values is to be displayed in a dropdown, they should be displayed in this numeric order.
avatax: NoticeStatusModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeStatusModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NoticeTypeModel
Tax Notice Type Model
Fields
- id int - The unique ID number of this tax notice customer type.
- description string - The description name of this tax authority type.
- activeFlag? boolean - A flag if the type is active
- sortOrder? int - sort order of the types
avatax: NoticeTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NoticeTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: NotificationModel
Represents a single notification.
A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed any relevant concerns raised by this notification.
An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile.
Fields
- id? int - The unique id of the notification.
- accountId? int - The unique ID number of the account that received this notification.
- companyId? int - If this notification was tied to a specific company, this will be the
unique ID number of the company that received the notification. Notifications that
are tied to accounts will have a
NULLvalue forcompanyId.
- referenceObject? string - The type name of object referred to by this notification, if any.
Some notifications may include information about a related data object.
For example, if this notification was related to a nexus declaration, the
referenceObjectfield would beNexusand thereferenceIdfield would be the unique ID number of that nexus.
- referenceId? int - The unique reference Id number of the object referred to by this notification, if any.
Some notifications may include information about a related data object.
For example, if this notification was related to a nexus declaration, the
referenceObjectfield would beNexusand thereferenceIdfield would be the unique ID number of that nexus.
- severityLevelId string - The severity level of the notification.
- category? string - The category of this notification. Notification categories are a useful way to group related notifications together. Category names may change over time. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".
- topic? string - The topic of this notification. Notification topics contain information about the notification. They are a summary of the issue and can help you decide what type of action to take. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".
- message string - The message for this notification. This is a friendly description of the notification and any relevant information that can help you decide what kind of action, if any, to take in response.
- needsAction? boolean - If this notification object requires user action to resolve, this value will be set to true.
- actionName? string - If there is a specific action suggested by this notification, this is the name of the action.
An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested,
you should give the viewer a hyperlink to the location referred to by
actionLinkand give the hyperlink the nameactionName.
- actionLink? string - If there is a specific action suggested by this notification, this is the URL of the action.
An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested,
you should give the viewer a hyperlink to the location referred to by
actionLinkand give the hyperlink the nameactionName.
- actionDueDate? string - If there is a specific action suggested by this notification, and if this action is requested
by a specific due date, this value will be the due date for the action.
An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested,
you should give the viewer a hyperlink to the location referred to by
actionLinkand give the hyperlink the nameactionName. For actions that have deadlines, such as "Confirm your tax registration before filing", this value will be set to the deadline date for the action. Otherwise, this value will be null.
- dismissed? boolean - When a user has finished reviewing a notification, they may opt to dismiss it by calling the
DismissNotificationAPI. This API marks the notification as dismissed, and dismissed notifications will generally not appear in most user interfaces.
- dismissedByUserId? int - If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification.
- dismissedDate? string - If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification.
- expireDate string - If this notification is time sensitive, this is the latest date when the notification should be displayed to the user.
- createdUserId? int - The unique ID number of the user who created the notification.
- createdDate? string - The UTC timestamp of the time when this notification was created.
- modifiedUserId? int - The unique ID number of the user who most recently modified this notification.
- modifiedDate? string - The UTC timestamp of the time when this notification was last modified.
avatax: NotificationModelFetchResult
Fields
- '\@recordsetCount? int -
- value? NotificationModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: OfferModel
Gets the response for the offer request
Fields
- id? string - Id of the transaction
- offerMessage? string - Message indicating what action took place
avatax: OriginalApiRequestResponseModel
Represents the exact API request and response from the original transaction API call, if available
Fields
- request? CreateTransactionModel - Create a transaction
- response? TransactionModel - This object represents a single transaction; for example, a sales invoice or purchase order.
avatax: ParameterModel
An extra property that can change the behavior of tax transactions.
Fields
- id? int - The unique ID number of this property.
- category? string - DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The category grouping of this parameter. When your user interface displays a large number of parameters, they should be grouped by their category value.
- name? string - The name of the property. To use this property, add a field on the
parametersobject of a CreateTransaction call.
- dataType? string - The data type of the property.
- helpText? string - Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.
- serviceTypes? string[] - A list of service types to which this parameter applies.
- prompt? string - DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The prompt you should use when displaying this parameter to a user. For example, if your user interface displays a parameter in a text box, this is the label you should use to identify that text box.
- regularExpression? string - DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. If your user interface permits client-side validation of parameters, this string is a regular expression you can use to validate the user's data entry prior to submitting a tax request.
- label? string - Label that helps the user to identify a parameter
- helpUrl? string - A help url that provides more information about the parameter
- attributeType? string - The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
- values? string[] - If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
- measurementType? string - The unit of measurement type of the parameter
- isNeededForCalculation? boolean - This field identifies if parameter is needed for calculation
- isNeededForReturns? boolean - This field identifies if parameter is needed for returns
- isNeededForClassification? boolean - This field identifies if parameter is needed for classification
avatax: ParameterModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ParameterModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ParameterUsageModel
usage of system defined parameters.
Fields
- id? int - The unique ID number of this property.
- parameterId? int - The id of the parameter.
- productCode? string - Product code for the parameter usage item.
- country? string - The country for the parameter usage item.
- region? string - The state for the parameter usage item.
- systemId? int - System Id for the parameter usage item
- taxTypeId? string - tax type for the parameter usage item.
- attributeType? string - The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
- name? string - The name of the property. To use this property, add a field on the
parametersobject of a CreateTransaction call.
- dataType? string - The data type of the property.
- helpText? string - Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.
- label? string - Label that helps the user to identify a parameter
- helpUrl? string - A help url that provides more information about the parameter
- values? string[] - If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
- measurementType? string - The unit of measurement type of the parameter
avatax: ParameterUsageModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ParameterUsageModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: PasswordChangeModel
Password Change Model
Fields
- oldPassword string - Old Password
- newPassword string - New Password
avatax: PingResultModel
Ping Result Model
Fields
- 'version? string - Version number
- authenticated? boolean - Returns true if you provided authentication for this API call; false if you did not.
- authenticationType? string - Returns the type of authentication you provided, if authenticated
- authenticatedUserName? string - The username of the currently authenticated user, if any.
- authenticatedUserId? int - The ID number of the currently authenticated user, if any.
- authenticatedAccountId? int - The ID number of the currently authenticated user's account, if any.
- authenticatedCompanyId? int - The ID number of the currently authenticated user's company, if any.
- crmid? string - The connected Salesforce account.
avatax: PointOfSaleDataRequestModel
Point-of-Sale Data Request Model
Fields
- companyCode string - A unique code that references a company within your account.
- documentDate? string - The date associated with the response content. Default is current date. This field can be used to backdate or postdate the response content.
- responseType? string - The format of your response. Formats include JSON, CSV, and XML.
- taxCodes? string[] - A list of tax codes to include in this point-of-sale file. If no tax codes are specified, response will include all distinct tax codes associated with the Items within your company.
- itemCodes? string[] - A list of item codes to include in this point-of-sale file. If no item codes are specified, responese will include all distinct item codes associated with the Items within your company.
- locationCodes? string[] - A list of location codes to include in this point-of-sale file. If no location codes are specified, response will include all locations within your company.
- includeJurisCodes? boolean - Set this value to true to include Juris Code in the response.
- partnerId? string - A unique code assoicated with the Partner you may be working with. If you are not working with a Partner or your Partner has not provided you an ID, leave null.
avatax: PoNumberModel
Represents a purchase order number for a transaction
Fields
- id? int - Unique ID number
- poNumber? string - Purchase order number.
avatax: PostalCodeModel
Represents a PostalCode and its associated data like: country, region, effective dates, etc.
Fields
- country? string - Country this PostalCode locates in
- region? string - The Region/State/Province this PostalCode locates in
- taxRegionId? int - An Avalara assigned TaxRegion Id associated to the PostalCode
- effDate? string - The date when the PostalCode becomes effective
- endDate? string - The date when the PostalCode becomes expired
- postalCode? string - The postalCode
avatax: PostalCodeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? PostalCodeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: PowerOfAttorneyCheckModel
Response when checking if a company has a POA on file with Avalara
Fields
- companyId? int - companyId of the request
- country? string - Country POA is for
- region? string - Region POA is for
- activePoa? boolean - Notes if there is an actice POA
- effectiveDate? string - Effective Date of the POA
- expirationDate? string - End Date of POA
- availablePoa? ResourceFileDownloadResult - Represents everything downloaded from resource files
avatax: PreferredProgramModel
A preferred program is a customs and/or duty program that can be used to handle cross-border transactions. Customers who sign up for a preferred program may obtain better terms for their customs and duty payments.
To indicate that your company has signed up for a preferred program, specify the code value from this
object as the value for the AvaTax.LC.PreferredProgram parameter in your transaction.
Fields
- id? int - The unique ID number representing this preferred program.
- code? string - A code that identifies this preferred program. To select this program, specify this code
value in the
AvaTax.LC.PreferredProgramparameter.
- originCountry? string - The ISO 3166 country code for the origin permitted by this program
- destinationCountry? string - The ISO 3166 country code for the destination permitted by this program
- effectiveDate? string - The earliest date for which this preferred program can be used in AvaTax. If
null, this preferred program is valid for all dates earlier thanendDate.
- endDate? string - The latest date for which this preferred program can be used in AvaTax. If
null, this preferred program is valid for all dates later thaneffectiveDate.
avatax: PreferredProgramModelFetchResult
Fields
- '\@recordsetCount? int -
- value? PreferredProgramModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ProductClassificationSystemModel
Represents a product classification system.
Fields
- systemId? int - Its Integer SystemId value for System
- systemCode? string - The System code for this System.
- description? string - A friendly human-readable name representing this System.
- customsValue? string - custom value set for the system
- countries? ProductSystemCountryModel[] - List of all countries that belong to the system including
avatax: ProductClassificationSystemModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ProductClassificationSystemModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ProductSystemCountryModel
Represents a System Country.
Fields
- systemCountryId? int - Its Integer SystemCountryId value for SystemCountry
- systemId? int - Its Integer SystemId value for SystemCountry
- country? string - string value of country code for SystemCountry
- effDate? string - DateTime as EffDate for SystemCountry
- endDate? string - DateTime as EffDate for SystemCountry
avatax: ProvisionStatusModel
Contains information about a company's exemption certificate status.
This model can be used to determine if your company is able to use the Customers, Certificates, and CertExpressInvites APIs within AvaTax.
Fields
- status? string - The status of exemption certificate setup for this company.
If this value is
Finished, this company will then be able to use the Customers, Certificates, and CertExpressInvites APIs within AvaTax.
- accountId? int - The accountId of the company represented by this status
- companyId? int - The AvaTax company represented by this status
avatax: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
avatax: QueryRequestModel
Represents a complex query request to parse using query filter guidelines from Microsoft REST standards
Fields
- filter? string - A list of conditions to filter objects.
- include? string - A list of included commands for this fetch operation.
- maxResults? int - For pagination: This is the maximum number of results to return.
- startIndex? int - For pagination: This is the index of the first result.
- sortBy? string - Sorts the resulting objects in a specific manner.
avatax: RateModel
Indicates one element of a sales tax rate.
Fields
- rate? decimal - The sales tax rate for general tangible personal property in this jurisdiction.
- name? string - A readable name of the tax or taxing jurisdiction related to this tax rate.
- 'type? string - The type of jurisdiction associated with this tax rate.
avatax: RateTypeModel
Rate type Model
Fields
- id? string - The unique ID number of this rate type.
- description? string - Description of this rate type.
- country? string - Country code for this rate type
avatax: RateTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? RateTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: RateTypesModel
Rate types Model
Fields
- id? int - The unique ID number of this rate type.
- rateType? string - The name of this rateType
- description? string - The description of this rate type.
avatax: RateTypesModelFetchResult
Fields
- '\@recordsetCount? int -
- value? RateTypesModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: RebuildFilingsModel
Rebuild a set of filings.
Fields
- rebuild boolean - Set this value to true in order to rebuild the filings.
avatax: ReconstructedApiRequestResponseModel
This model contains a reconstructed CreateTransaction request object that could potentially be used to recreate this transaction.
Note that the API changes over time, and this reconstructed model is likely different from the exact request that was originally used to create this transaction.
Fields
- request? CreateTransactionModel - Create a transaction
avatax: ReconstructedMultiDocumentModel
Contains information about the original API request and response that created a MultiDocument object.
Fields
- request? CreateMultiDocumentModel - A MultiDocument transaction represents a sale or purchase that occurred between more than two companies. A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate document. This separation of documents allows each seller to file their taxes separately.
avatax: RefreshECommerceTokenInputModel
A model used to request the refresh of a CertCapture eCommerce token.
Fields
- token string - The token that requires its expiration to be extended.
avatax: RefundTransactionModel
Refund a committed transaction
Fields
- refundTransactionCode? string - The transaction code for the refund. This code will be saved to the
ReturnInvoicetransaction, and does not need to match the code of the original sale.
- refundDate string - The date of the refund. For customers using Avalara's Managed Returns Service, this date controls the month in which the refund transaction will be reported on a tax filing.
- refundType? string - Type of this refund.
To submit a full refund, specify
Full. To refund only specific lines from the transaction, specifyPartialand indicate the lines you wish to apply in therefundLinesfield. To refund the tax that was paid in the previous transaction, specifyTaxOnly. To issue a percentage-based discount, specifyPercentage.
- refundPercentage? decimal - The percentage for refund.
This value only applies if you choose
refundType = PercentageorrefundType = Partial.
- refundLines? string[] - If you chose a refund of type
Partial, this indicates which lines from the original transaction are being refunded.
- referenceCode? string - A user-defined reference field containing information about this refund.
avatax: RemoveTransactionLineModel
Model to specify lines to be removed
Fields
- companyCode string - company code
- transactionCode string - document code for the transaction to add lines
- documentType? string - document type
- lines string[] - List of line numbers to be removed
- renumber? boolean - ption to renumber lines after removal. After renumber, the line number becomes: "1", "2", "3", ...
avatax: ReportModel
A model for displaying report task metadata
Fields
- id? int - The unique identifier of the report task
- accountId? int - The ID of the account the reported transactions are from
- companyId? int - The ID of the company the reported transactions are from
- reportType? string - The type of the report: ExportDocumentLine, etc.
- parameters? ReportParametersModel - The output model for report parameter definitions
- status? string - The current status of the report building task
- size? int - The size of the report file, if available
- format? string - The format of the report file
- file? string - The name of the report file, if available
- createdDate? string - The time when the report task was initiated
- createdUserId? int - The Id of the user who initiated this task
- createdUser? string - The userName of the user who initiated the report task
- completedDate? string - The time when the report was finished building, if completed
avatax: ReportModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ReportModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ReportParametersModel
The output model for report parameter definitions
Fields
- startDate? string - The start date filter used for your report
- endDate? string - The end date filter used for your report
- country? string - The country filter used for your report
- state? string - The state filter used for your report
- dateFilter? string - The date type filter used for your report
- docType? string - The doc type filter used for your report
- dateFormat? string - The date format used for your report
- currencyCode? string - The currency code used for your report
- numberOfPartitions? int - Number of partitions to split the report into.
- partition? int - The zero-based partition number to retrieve in this export request.
- isLocked? boolean - If true, include only documents that are locked. If false, include only documents that are not locked. Defaults to false if not specified.
- merchantSellerId? string - If set, include only documents associated with this merchantSellerId.
- documentStatus? string - The Document status filter used for report For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval
- isModifiedDateSameAsDocumentDate? boolean - If true, modified date will be same as document date If false, modified date will not be same as document date Defaults to false if not specified.
- taxGroup? string - TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
- taxName? string - The description of the tax
- taxCode? string - The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
- customerVendorCode? string - The code your business application uses to identify a customer or vendor
- taxSubType? string - Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
avatax: RequiredFilingCalendarDataFieldModel
Represents a verification request using Skyscraper for a company
Fields
- name? string - Region of the verification request
- description? string - Username that we are using for verification
avatax: ResetLicenseKeyModel
Represents a license key reset request.
Fields
- accountId int - The primary key of the account ID to reset
- confirmResetLicenseKey boolean - Set this value to true to reset the license key for this account. This license key reset function will only work when called using the credentials of the account administrator of this account.
avatax: ResourceFileDownloadResult
Represents everything downloaded from resource files
Fields
- success? boolean - True if this download succeeded
- bytes? string - Bytes of the file
- filename? string - Original filename
- contentType? string - Mime content type
avatax: ResourceFileTypeModel
Resource File Type Model
Fields
- resourceFileTypeId? int - The resource file type id
- name? string - The name of the file type
avatax: ResourceFileTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ResourceFileTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ResourceFileUploadRequestModel
A request to upload a file to Resource Files
Fields
- content string - This stream contains the bytes of the file being uploaded.
- username? string - The username adding the file
- accountId? int - The account ID to which this file will be attached.
- companyId? int - The company ID to which this file will be attached.
- name? string - The original name of this file.
- resourceFileTypeId? int - The resource type ID of this file.
- length? int - Length of the file in bytes.
avatax: ResourceFileUploadResultModel
Encapsulates the result of uploading a file to the resource system
Fields
- message? string - If the request failed, this contains a description of the error.
- resourceFileId? int - If the request succeeded, this is the ID number of the file.
- aaa_success? boolean - True if the upload request succeeded.
avatax: ReturnsParameterUsageModel
usage of system defined parameters for returns.
Fields
- id? int - The unique ID number of this property.
- parameterId? int - The id of the parameter.
- productCode? string - Product code for the return parameter usage item.
- taxTypeId? string - tax type for the returns parameter usage item.
- attributeType? string - The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
- name? string - The name of the property. To use this property, add a field on the
parametersobject of a CreateTransaction call.
- dataType? string - The data type of the property.
- helpText? string - Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.
- label? string - Label that helps the user to identify a parameter
- helpUrl? string - A help url that provides more information about the parameter
- values? string[] - If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
- measurementType? string - The unit of measurement type of the parameter
avatax: ReturnsParameterUsageModelFetchResult
Fields
- '\@recordsetCount? int -
- value? ReturnsParameterUsageModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: SecurityRoleModel
Represents a single security role.
Fields
- id? int - The unique ID number of this security role.
- description? string - A description of this security role
avatax: SecurityRoleModelFetchResult
Fields
- '\@recordsetCount? int -
- value? SecurityRoleModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: SendSalesRequestModel
SendSales Request Model.
Fields
- companyId int - The companyId for which the send sales file is being generated.
- taxCodes string[] - List of taxCodes to be included in send sales file.
- date string - The date for which send sales file is being generated.
- format? string - The send sales file format.
- 'type? string - The send sales file type
avatax: SetPasswordModel
Set Password Model
Fields
- newPassword string - New Password
avatax: SettingModel
This object is used to keep track of custom information about a company.
The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of preference information, reminders, or any other storage that would need to persist even if the customer uninstalls your application.
A setting can refer to any type of data you need to remember about this company object.
When creating this object, you may define your own set, name, and value parameters.
To define your own values, please choose a set name that begins with X- to indicate an extension.
Fields
- id int - The unique ID number of this setting.
- companyId? int - The unique ID number of the company this setting refers to.
- set string - A user-defined "set" containing this setting.
Avalara defines some sets that cannot be changed. To create your own set, choose a set
name that begins with
X-to indicate that this is an extension value. We recommend that you choose a set name that clearly identifies your application, and then store data within name/value pairs within that set. For example, if you were creating an application called MyApp, you might choose to create a set namedX-MyCompany-MyApp.
- name string - A user-defined "name" for this name-value pair.
- value? string - The value of this name-value pair.
- modifiedDate? string - The value when the entry was last modified.
- modifiedUserId? int - The value identifying who last modified the entry.
avatax: SettingModelFetchResult
Fields
- '\@recordsetCount? int -
- value? SettingModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: SettleTransactionModel
Settle this transaction with your ledger by executing one or many actions against that transaction.
You may use this endpoint to verify the transaction, change the transaction's code, and commit the transaction for reporting purposes. This endpoint may be used to execute any or all of these actions at once.
Fields
- verify? VerifyTransactionModel - Verify this transaction by matching it to values in your accounting system.
You may specify one or more of the following fields to verify:
date,totalAmount, ortotalTax. This call will report an error if there is any difference between the data stored in AvaTax and the data stored in your accounting system.
- changeCode? ChangeTransactionCodeModel - Settle this transaction with your ledger by verifying its amounts. If the transaction is not yet committed, you may specify the "commit" value to commit it to the ledger and allow it to be reported. You may also optionally change the transaction's code by specifying the "newTransactionCode" value.
- 'commit? CommitTransactionModel - Commit this transaction as permanent so that it can be reported on a tax filing.
avatax: SkyscraperStatusModel
Represents a list of statuses of returns available in skyscraper
Fields
- name? string - The specific name of the returns available in skyscraper
- taxFormCodes? string[] - The tax form codes available to file through skyscrper
- country? string - The country of the returns
- scraperType? string - The Scraper type
- isAvailable? boolean - Indicates if the return is currently available
- expectedResponseTime? string - The expected response time of the call
- message? string - Message on the returns
- requiredFilingCalendarDataFields? RequiredFilingCalendarDataFieldModel[] - A list of required fields to file
avatax: SkyscraperStatusModelFetchResult
Fields
- '\@recordsetCount? int -
- value? SkyscraperStatusModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: StringFetchResult
Fields
- '\@recordsetCount? int -
- value? string[] -
- '\@nextLink? string -
- pageKey? string -
avatax: SubscriptionModel
Represents a service that this account has subscribed to.
Fields
- id? int - The unique ID number of this subscription.
- accountId? int - The unique ID number of the account this subscription belongs to.
- subscriptionTypeId? int - The unique ID number of the service that the account is subscribed to. If this is provided, subscription description is ignored.
- subscriptionDescription? string - A friendly description of the service that the account is subscribed to. You can either provide the subscription type Id or this but not both. If subscription type Id is provided, then this information is ignored and this field will be updated with the information from subscription type id.
- effectiveDate? string - The date when the subscription began.
- endDate? string - If the subscription has ended or will end, this date indicates when the subscription ends.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: SubscriptionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? SubscriptionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: SubscriptionTypeModel
Represents a service or a subscription type.
Fields
- id? int - The unique ID number of this subscription type.
- description string - The friendly name of the service this subscription type represents.
avatax: SubscriptionTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? SubscriptionTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: SyncItemsRequestModel
Represents a request to sync items.
Fields
- items ItemSyncModel[] - A list of items to sync with AvaTax.
avatax: SyncItemsResponseModel
The response returned after an item sync was requested.
Fields
- status? string - The status of the request
avatax: TagsModel
Represents a tag for an item in your company's product catalog.
Fields
- id? int - The unique ID number of the tag.
- tagName? string - The tag name.
avatax: TagsModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TagsModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxAuthorityFormModel
Represents a form that can be filed with a tax authority.
Fields
- taxAuthorityId int - The unique ID number of the tax authority.
- formName string - The form name of the form for this tax authority.
avatax: TaxAuthorityFormModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxAuthorityFormModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxAuthorityInfo
Information about a tax authority relevant for an address.
Fields
- avalaraId? string - A unique ID number assigned by Avalara to this tax authority.
- jurisdictionName string - The friendly jurisdiction name for this tax authority.
- jurisdictionType? string - The type of jurisdiction referenced by this tax authority.
- signatureCode? string - An Avalara-assigned signature code for this tax authority.
avatax: TaxAuthorityModel
Tax Authority Model
Fields
- id int - The unique ID number of this tax authority.
- name string - The friendly name of this tax authority.
- taxAuthorityTypeId? int - The type of this tax authority.
- jurisdictionId? int - The unique ID number of the jurisdiction for this tax authority.
avatax: TaxAuthorityModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxAuthorityModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxAuthorityTypeModel
Tax Authority Type Model
Fields
- id int - The unique ID number of this tax Authority customer type.
- description string - The description name of this tax authority type.
- taxAuthorityGroup? string - Tax Authority Group
avatax: TaxAuthorityTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxAuthorityTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxCodeModel
Represents a tax code that can be applied to items on a transaction. A tax code can have specific rules for specific jurisdictions that change the tax calculation behavior.
Fields
- id? int - The unique ID number of this tax code.
- companyId? int - The unique ID number of the company that owns this tax code.
- taxCode string - A code string that identifies this tax code.
- taxCodeTypeId string - The type of this tax code.
- description? string - A friendly description of this tax code.
- parentTaxCode? string - If this tax code is a subset of a different tax code, this identifies the parent code.
- isPhysical? boolean - True if this tax code type refers to a physical object. Read only field.
- goodsServiceCode? int - The Avalara Goods and Service Code represented by this tax code.
- entityUseCode? string - The Avalara Entity Use Code represented by this tax code.
- isActive? boolean - True if this tax code is active and can be used in transactions.
- isSSTCertified? boolean - True if this tax code has been certified by the Streamlined Sales Tax governing board. By default, you should leave this value empty.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: TaxCodeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxCodeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxCodeTypesModel
Information about Avalara-defined tax code types. This list is used when creating tax codes and tax rules.
Fields
- types? record {} - The list of Avalara-defined tax code types.
avatax: TaxDetailsByTaxSubType
Tax Details by Tax subtype
Fields
- taxSubType? string - Tax subtype
- totalTaxable? decimal - Total taxable amount by tax type
- totalExempt? decimal - Total exempt by tax type
- totalNonTaxable? decimal - Total non taxable by tax type
- totalTax? decimal - Total tax by tax type
avatax: TaxDetailsByTaxType
Tax Details by Tax Type
Fields
- taxType? string - Tax Type
- totalTaxable? decimal - Total taxable amount by tax type
- totalExempt? decimal - Total exempt by tax type
- totalNonTaxable? decimal - Total non taxable by tax type
- totalTax? decimal - Total tax by tax type
- taxSubTypeDetails? TaxDetailsByTaxSubType[] - Tax subtype details
avatax: TaxOverrideModel
Represents a tax override for a transaction
Fields
- 'type? string - Identifies the type of tax override
- taxAmount? decimal - Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines. Tax will be distributed on a best effort basis. It may not always be possible to override all taxes. Please consult your account manager for information about overrides.
- taxDate? string - The override tax date to use This is used when the tax has been previously calculated as in the case of a layaway, return or other reason indicated by the Reason element. If the date is not overridden, then it should be set to the same as the DocDate.
- reason? string - This provides the reason for a tax override for audit purposes. It is required for types 2-4. Typical reasons include: "Return" "Layaway"
- taxAmountByTaxTypes? TransactionLineTaxAmountByTaxTypeModel[] - Indicates a total override of the calculated tax on the line with TaxType. AvaTax will distribute the override across all the line details for that TaxType. TaxAmountByTaxType can be used only at the Line level.
avatax: TaxRateModel
Contains information about the general tangible personal property sales tax rates for this jurisdiction.
This rate is calculated by making assumptions about the tax calculation process. It does not account for:
- Sourcing rules, such as origin-and-destination based transactions.
- Product taxability rules, such as different tax rates for different product types.
- Nexus declarations, where some customers are not obligated to collect tax in specific jurisdictions.
- Tax thresholds and rate differences by amounts.
- And many more custom use cases.
To upgrade to a fully-featured and accurate tax process that handles these scenarios correctly, please contact Avalara to upgrade to AvaTax!
Fields
- totalRate? decimal - The total sales tax rate for general tangible personal property sold at a retail point of presence in this jurisdiction on this date.
- rates? RateModel[] - The list of individual rate elements for general tangible personal property sold at a retail point of presence in this jurisdiction on this date.
avatax: TaxRegionJurisdictionModel
The tax region jurisdiction model.
Fields
- jurisdictionId? int - The id of the jurisdiction.
- taxRegionId? int - The id of the tax region.
- jurisdictionLevelId? int - The id of the jurisdiction level.
- rockName? string - The rock name.
- reportLevel? int - The report level.
- stateAssignedCode? string - The state assigned code.
- taxAuthorityId? int - The id of the tax authority.
- signatureCode? string - The signature code.
- effectiveDate? string - The date in which this tax region jurisdiction starts to take effect.
- endDate? string - The date in which this tax region jurisdiction stops to take effect.
avatax: TaxRegionModel
The tax region model.
Fields
- id? int - The id of the tax region.
- code? string - The code of the tax region.
- name? string - The name of the tax region.
- county? string - The name of the county.
- city? string - The name of the city.
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country of this jurisdiction.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- serCode? string - The ser code.
- signatureCode? string - The tax region signature code.
- effectiveDate? string - The date this tax region starts to take effect.
- endDate? string - The date this tax region stops to take effect.
- isAcm? boolean - Is Acm flag.
- isSst? boolean - Is SST flag.
- jurisdictions? DenormalizedJurisModel[] - List of jurisdictions associated with this tax region.
avatax: TaxRuleModel
Represents a tax rule that changes the behavior of Avalara's tax engine for certain products and/or entity use codes in certain jurisdictions.
Avalara supports a few different types of tax rules. For information about tax rule types, see TaxRuleTypeId
Because different types of tax rules have different behavior, some fields may change their behavior based on the type of tax rule selected. Please read the documentation for each field carefully and ensure that the value you send is appropriate for the type of tax rule.
Fields
- id int - The unique ID number of this tax rule.
- companyId? int - The unique ID number of the company that owns this tax rule.
- taxCodeId? int - For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.
You can choose to specify a tax code either by passing its unique ID number in the
taxCodeIdfield or by passing its alphanumeric code in thetaxCodefield. To search for the appropriate tax code for your custom rule, use theListTaxCodesAPI. TheRateOverrideRule,BaseRule, andExemptEntityRulerule types can be applied to all tax codes. To make a rule that applies to all tax codes, leave both fields blank. TheProductTaxabilityRulerule must be associated with a tax code. If you attempt to create a product taxability rule without a tax code, you will get an error message.
- taxCode? string - For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.
You can choose to specify a tax code either by passing its unique ID number in the
taxCodeIdfield or by passing its alphanumeric code in thetaxCodefield. To search for the appropriate tax code for your custom rule, use theListTaxCodesAPI. TheRateOverrideRule,BaseRule, andExemptEntityRulerule types can be applied to all tax codes. To make a rule that applies to all tax codes, leave both fields blank. TheProductTaxabilityRulerule must be associated with a tax code. If you attempt to create a product taxability rule without a tax code, you will get an error message.
- stateFIPS? string - For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code.
This field is required for rules that apply to specific jurisdictions in the United States. It is not required
if you set the
isAllJurisflag to true.
- jurisName? string - The name of the jurisdiction to which this tax rule applies.
Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the
ListJurisdictions API
or the ListJurisdictionsByAddress API.
To set a rule that applies to all jurisdictions of a specific type, see
isAllJuris. Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in thejurisName,jurisCode, andjurisdictionTypeIdfields using the information you retrieved from the API above.
- jurisCode string - The code of the jurisdiction to which this tax rule applies.
Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the
ListJurisdictions API
or the ListJurisdictionsByAddress API.
Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the
jurisName,jurisCode, andjurisdictionTypeIdfields using the information you retrieved from the API above.
- jurisTypeId? string - DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use
jurisdictionTypeIdinstead.
- jurisdictionTypeId? string - The type of the jurisdiction to which this tax rule applies.
Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the
ListJurisdictions API
or the ListJurisdictionsByAddress API.
Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the
jurisName,jurisCode, andjurisdictionTypeIdfields using the information you retrieved from the API above. To make a custom tax rule for US or Canada that applies to all jurisdictions of a specific type, see theisAllJurisfield for more information.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use
entityUseCodeinstead.
- entityUseCode? string - The entity use code to which this rule applies.
You can create custom
entityUseCodevalues with specific behavior using this API, or you can change the behavior of Avalara's system-defined entity use codes. For a full list of Avalara-defined entity use codes, see the ListEntityUseCodes API.
- taxTypeId? string - DEPRECATED - Date: 09/30/2021, Version: 21.9.0, Message: Please use
taxTypeCodeinstead. Some tax type groups contain multiple different types of tax. To create a rule that affects only one type of tax within a tax type group, set this value to the code matching the specific tax type within that group. The custom tax rule will then only apply to taxes calculated for that specific type. For rules that affect all tax types, use the valueAto matchAlltax types within that group.
- taxTypeCode? string - Indicates the code of the tax type that applies to this rule. Use /api/v2/definitions/taxtypes endpoint to retrieve the list of tax types applicable for your company.
- taxRuleProductDetail? TaxRuleProductDetailModel[] - TaxRule Product Detail indicates the HSCode(s) to which the tax rule applies.
- rateTypeId? string - DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: Please use
rateTypeCode,taxTypeGroupandsubTaxTypeinstead.
- rateTypeCode? string - Indicates the code of the rate type that applies to this rule. Use ListRateTypesByCountry API for a full list of rate type codes. If you specify a value in the rateTypeCode field, this rule will cause tax lines that are affected by the rule to change to a different rate type code.
- taxRuleTypeId string - This type value determines the behavior of the tax rule. You can specify that this rule controls the product's taxability or exempt / nontaxable status, the product's rate (for example, if you have been granted an official ruling for your product's rate that differs from the official rate), or other types of behavior.
- isAllJuris? boolean - Allows you to make tax rules apply to lower jurisdictions. This feature is only available in the United States and Canada.
- In the United States, this value can be used for rules written at the
Statejurisdictional level. If set totrue, this rule will at the state level, county level, city level, and special jurisdiction level. - In Canada, this value can be used for rules written at the
CountryorStatejurisdictional levels. If set totrue, this rule will at all lower jurisdictional levels.
false. - In the United States, this value can be used for rules written at the
- value? decimal - This field has different behavior based on the type of the tax rule.
- For a product taxability rule, this value is either 1 or 0, indicating taxable or non-taxable.
- For a rate override rule, this value is the corrected rate stored as a decimal, for example, a rate of 5% would be stored as 0.05 decimal. If you use the special value of 1.0, only the cap and threshold values will be applied and the rate will be left alone.
- cap? decimal - The maximum cap for the price of this item according to this rule. Any amount above this cap will not be subject to this rule.
For example, if you must pay 5% of a product's value up to a maximum value of $1000, you would set the
capto1000.00and thevalueto0.05.
- threshold? decimal - The per-unit threshold that must be met before this rule applies.
For example, if your product is nontaxable unless it is above $100 per product, you would set the
thresholdvalue to100. In this case, the rate for the rule would apply to the entire amount above $100. You can also create rules that make the entire product taxable if it exceeds a threshold, but is nontaxable if it is below the threshold. To choose this, set theoptionsfield to the valueTaxAll.
- options? string - Supports custom options for your tax rule.
Supported options include:
TaxAll- This value indicates that the entire amount of the line becomes taxable when the line amount exceeds thethreshold.
- effectiveDate? string - The first date at which this rule applies. If
null, this rule will apply to all dates prior to the end date.
- endDate? string - The last date for which this rule applies. If
null, this rule will apply to all dates after the effective date.
- description? string - A friendly name for this tax rule.
- countyFIPS? string - For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code.
This field is required for rules that apply to specific jurisdictions in the United States. It is not required
if you set the
isAllJurisflag to true.
- isSTPro? boolean - DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: This field is no longer required.
- country string - Name or ISO 3166 code identifying the country where this rule will apply.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- region? string - Name or ISO 3166 code identifying the region where this rule will apply.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions. NOTE: Region is required for US and not required for non-US countries because the user may be either creating a Country-level or Region-level rule.
- sourcing? string - The sourcing types to which this rule applies.
- taxTypeGroup? string - This field has different behavior based on the type of rule.
- For a product taxability rule, if the rule applies to an item, this value will override the tax type group of the original product.
- For other rules, this value determines what tax type groups will be affected by the rule.
ListTaxTypeGroupsfor a list of tax type groups supported by AvaTax.
- taxSubType? string - This field has different behavior based on the type of rule.
- For a product taxability rule, if the rule applies to an item, this value will override the tax sub type of the original product.
- For other rules, this value determines what tax sub types will be affected by the rule.
ListTaxSubtypesfor a list of tax sub types supported by AvaTax.
- nonPassthroughExpression? string - Reserved for Avalara internal usage. Leave this field null.
- currencyCode? string - The currency code to use for this rule. For a list of currencies supported by AvaTax, use the ListCurrencies API.
- preferredProgramId? int - Reserved for Avalara internal usage. Leave this field null.
- uomId? int - For tax rules that are calculated using units of measurement, this indicates the unit of measurement type used to calculate the amounts for this rule. For a list of units of measurement, use the ListUnitsOfMeasurement API.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- unitOfBasis? string - The UnitOfBasis for the TaxRule
avatax: TaxRuleModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxRuleModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxRuleProductDetailModel
Represents a tax rule product detail that changes the behavior of Avalara's tax engine for certain tax rules.
Avalara supports a two types of tax product detail. For information about tax rule Product Types HSCode and TaxCode
Because different types of tax rules have different behavior, some fields may change their behavior based on the type of tax rule selected. Please read the documentation for each field carefully and ensure that the value you send is appropriate for the type of tax rule.
Fields
- taxRuleProductDetailId? int - The unique ID number of this Tax rule product detail.
- taxRuleId? int - TaxRule Id of TaxRule Product Detail entry
- productCode? string - Product Code value
- effectiveDate? string - The first date at which this product detail applies. If
null, this product detail will apply to all dates prior to the end date.
- endDate? string - The last date for which this product detail applies. If
null, this product detail will apply to all dates after the effective date.
- systemId? int - Represents the system Id the detail is applicable for.
avatax: TaxSubTypeModel
Represents a tax subtype
Fields
- id int - The unique ID number of this tax sub-type.
- taxSubType string - The unique human readable Id of this tax sub-type.
- description string - The description of this tax sub-type.
- taxTypeGroup string - The upper level group of tax types.
avatax: TaxSubTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxSubTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxTypeGroupModel
Represents a tax type group
Fields
- id? int - The unique ID number of this tax type group.
- taxTypeGroup? string - The unique human readable Id of this tax type group.
- description? string - The description of this tax type group.
- subscriptionTypeId? int - If this tax type group requires a subscription, this contains the ID number of the subscription type required to use it.
- subscriptionDescription? string - If this tax type group requires a subscription, this contains the friendly name of the subscription type required to use it.
- tabName? string - The name of the tab in the AvaTax website corresponding to this tax type group.
- showColumn? boolean - True if this tax type group is displayed in the user interface of the AvaTax website.
- displaySequence? int - The order this record is being returned in the response
avatax: TaxTypeGroupModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxTypeGroupModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TaxTypeModel
Represents a tax type
Fields
- id? int - The unique ID number of this tax type.
- taxType? string - The name of this tax type.
- description? string - The description of this tax type.
avatax: TaxTypeModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TaxTypeModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TransactionAddressModel
An address used within this transaction.
Fields
- id? int - The unique ID number of this address.
- transactionId? int - The unique ID number of the document to which this address belongs.
- boundaryLevel? string - The boundary level at which this address was validated.
- line1? string - The first line of the address.
- line2? string - The second line of the address.
- line3? string - The third line of the address.
- city? string - The city for the address.
- region? string - The ISO 3166 region code. E.g., the second part of ISO 3166-2.
- postalCode? string - The postal code or zip code for the address.
- country? string - The ISO 3166 country code
- taxRegionId? int - The unique ID number of the tax region for this address.
- latitude? string - Latitude for this address
- longitude? string - Longitude for this address
- jurisdictions? JurisdictionModel[] - List of all the qualified jurisdictions for the TaxRegionId.
avatax: TransactionBatchItemModel
Represents a transaction batch item. Only one child transaction model should contain data.
Fields
- memo? string - Represents a transaction memo.
- createTransactionModel? CreateTransactionModel - Create a transaction
- adjustTransactionModel? BatchAdjustTransactionModel - Replace an existing transaction recorded in AvaTax with a new one.
- createOrAdjustTransactionModel? CreateOrAdjustTransactionModel - Create or adjust transaction model
- voidTransactionModel? BatchVoidTransactionModel - A request to void a previously created transaction.
avatax: TransactionLineDetailModel
An individual tax detail element. Represents the amount of tax calculated for a particular jurisdiction, for a particular line in an invoice.
Fields
- id? int - The unique ID number of this tax detail.
- transactionLineId? int - The unique ID number of the line within this transaction.
- transactionId? int - The unique ID number of this transaction.
- addressId? int - The unique ID number of the address used for this tax detail.
- country? string - The two character ISO 3166 country code of the country where this tax detail is assigned.
- region? string - The two-or-three character ISO region code for the region where this tax detail is assigned.
- countyFIPS? string - For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the county where this tax detail is assigned.
- stateFIPS? string - For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the state where this tax detail is assigned.
- exemptAmount? decimal - The amount of this line that was considered exempt in this tax detail.
- exemptReasonId? int - The unique ID number of the exemption reason for this tax detail.
- inState? boolean - True if this detail element represented an in-state transaction.
- jurisCode? string - The code of the jurisdiction to which this tax detail applies.
- jurisName? string - The name of the jurisdiction to which this tax detail applies.
- jurisdictionId? int - The unique ID number of the jurisdiction to which this tax detail applies.
- signatureCode? string - The Avalara-specified signature code of the jurisdiction to which this tax detail applies.
- stateAssignedNo? string - The state assigned number of the jurisdiction to which this tax detail applies.
- jurisType? string - DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Use jurisdictionTypeId instead. The type of the jurisdiction to which this tax detail applies.
- jurisdictionType? string - The type of the jurisdiction in which this tax detail applies.
- nonTaxableAmount? decimal - The amount of this line item that was considered nontaxable in this tax detail.
- nonTaxableRuleId? int - The rule according to which portion of this detail was considered nontaxable.
- nonTaxableType? string - The type of nontaxability that was applied to this tax detail.
- rate? decimal - The rate at which this tax detail was calculated.
- rateRuleId? int - The unique ID number of the rule according to which this tax detail was calculated.
- rateSourceId? int - The unique ID number of the source of the rate according to which this tax detail was calculated.
- serCode? string - For Streamlined Sales Tax customers, the SST Electronic Return code under which this tax detail should be applied.
- sourcing? string - Indicates whether this tax detail applies to the origin or destination of the transaction.
- tax? decimal - The amount of tax for this tax detail.
- taxableAmount? decimal - The taxable amount of this tax detail.
- taxType? string - The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
- taxSubTypeId? string - The id of the tax subtype.
- taxTypeGroupId? string - The id of the tax type group.
- taxName? string - The name of the tax against which this tax amount was calculated.
- taxAuthorityTypeId? int - The type of the tax authority to which this tax will be remitted.
- taxRegionId? int - The unique ID number of the tax region.
- taxCalculated? decimal - The amount of tax that AvaTax calculated. If an override for tax amount is used, there may be a difference between the tax field which applies your override, and the this amount that is calculated without override.
- taxOverride? decimal - The amount of tax override that was specified for this tax line.
- rateType? string - DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use rateTypeCode instead. The rate type for this tax detail.
- rateTypeCode? string - Indicates the code of the rate type that was used to calculate this tax detail. Use ListRateTypesByCountry API for a full list of rate type codes.
- taxableUnits? decimal - Number of units in this line item that were calculated to be taxable according to this rate detail.
- nonTaxableUnits? decimal - Number of units in this line item that were calculated to be nontaxable according to this rate detail.
- exemptUnits? decimal - Number of units in this line item that were calculated to be exempt according to this rate detail.
- unitOfBasis? string - When calculating units, what basis of measurement did we use for calculating the units?
- isNonPassThru? boolean - True if this value is a non-passthrough tax. A non-passthrough tax is a tax that may not be charged to a customer; it must be paid directly by the company.
- isFee? boolean - The Taxes/Fee component. True if the fee is applied.
- reportingTaxableUnits? decimal - Number of units in this line item that were calculated to be taxable according to this rate detail in the reporting currency.
- reportingNonTaxableUnits? decimal - Number of units in this line item that were calculated to be nontaxable according to this rate detail in the reporting currency.
- reportingExemptUnits? decimal - Number of units in this line item that were calculated to be exempt according to this rate detail in the reporting currency.
- reportingTax? decimal - The amount of tax for this tax detail in the reporting currency.
- reportingTaxCalculated? decimal - The amount of tax that AvaTax calculated in the reporting currency. If an override for tax amount is used, there may be a difference between the tax field which applies your override, and the this amount that is calculated without override.
- liabilityType? string - LiabilityType identifies the party liable to file the tax. This field is used to filter taxes from reports and tax filings as appropriate.
avatax: TransactionLineLocationTypeModel
Represents information about location types stored in a line
Fields
- documentLineLocationTypeId? int - The unique ID number of this line location address model
- documentLineId? int - The unique ID number of the document line associated with this line location address model
- documentAddressId? int - The address ID corresponding to this model
- locationTypeCode? string - The location type code corresponding to this model
avatax: TransactionLineModel
One line item on this transaction.
Fields
- id? int - The unique ID number of this transaction line item.
- transactionId? int - The unique ID number of the transaction to which this line item belongs.
- lineNumber? string - The line number or code indicating the line on this invoice or receipt or document.
- boundaryOverrideId? int - The unique ID number of the boundary override applied to this line item.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this line item. Usage type often affects taxability rules.
- entityUseCode? string - The entity use code for this line item. Usage type often affects taxability rules.
- description? string - A description of the item or service represented by this line.
- destinationAddressId? int - The unique ID number of the destination address where this line was delivered or sold. In the case of a point-of-sale transaction, the destination address and origin address will be the same. In the case of a shipped transaction, they will be different.
- originAddressId? int - The unique ID number of the origin address where this line was delivered or sold. In the case of a point-of-sale transaction, the origin address and destination address will be the same. In the case of a shipped transaction, they will be different.
- discountAmount? decimal - The amount of discount that was applied to this line item. This represents the difference between list price and sale price of the item. In general, a discount represents money that did not change hands; tax is calculated on only the amount of money that changed hands.
- discountTypeId? int - The type of discount, if any, that was applied to this line item.
- exemptAmount? decimal - The amount of this line item that was exempt.
- exemptCertId? int - The unique ID number of the exemption certificate that applied to this line item. It is the calc_id associated with a certificate in CertCapture.
- certificateId? string - The CertCapture Certificate ID
- exemptNo? string - The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options.
- isItemTaxable? boolean - True if this item is taxable.
- isSSTP? boolean - True if this item is a Streamlined Sales Tax line item.
- itemCode? string - The code string of the item represented by this line item.
- lineAmount? decimal - The total amount of the transaction, including both taxable and exempt. This is the total price for all items. To determine the individual item price, divide this by quantity.
- quantity? decimal - The quantity of products sold on this line item.
- ref1? string - A user-defined reference identifier for this transaction line item.
- ref2? string - A user-defined reference identifier for this transaction line item.
- reportingDate? string - The date when this transaction should be reported. By default, all transactions are reported on the date when the actual transaction took place. In some cases, line items may be reported later due to delayed shipments or other business reasons.
- revAccount? string - The revenue account number for this line item.
- sourcing? string - Indicates whether this line item was taxed according to the origin or destination.
- tax? decimal - The tax for this line in this transaction.
If you used a
taxOverrideof typetaxAmountfor this line, this value will represent the amount of your override. AvaTax will still attempt to calculate the correct tax for this line and will store that calculated value in thetaxCalculatedfield. You can compare thetaxandtaxCalculatedfields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.
- taxableAmount? decimal - The taxable amount of this line item.
- taxCalculated? decimal - The amount of tax that AvaTax calculated for the transaction.
If you used a
taxOverrideof typetaxAmount, there may be a difference between thetaxfield which applies your override, and thetaxCalculatedfield which represents the amount of tax that AvaTax calculated without the override. You can compare thetaxandtaxCalculatedfields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.
- taxCode? string - The code string for the tax code that was used to calculate this line item.
- taxCodeId? int - The unique ID number for the tax code that was used to calculate this line item.
- taxDate? string - The date that was used for calculating tax amounts for this line item. By default, this date should be the same as the document date. In some cases, for example when a consumer returns a product purchased previously, line items may be calculated using a tax date in the past so that the consumer can receive a refund for the correct tax amount that was charged when the item was originally purchased.
- taxEngine? string - The tax engine identifier that was used to calculate this line item.
- taxOverrideType? string - If a tax override was specified, this indicates the type of tax override.
- businessIdentificationNo? string - VAT business identification number used for this transaction.
- taxOverrideAmount? decimal - If a tax override was specified, this indicates the amount of tax that was requested.
- taxOverrideReason? string - If a tax override was specified, represents the reason for the tax override.
- taxIncluded? boolean - Indicates whether the
amountfor this line already includes tax. If this value istrue, the final price of this line including tax will equal the value inamount. If this value isnullorfalse, the final price will equalamountplus whatever taxes apply to this line.
- merchantSellerId? int - DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead. ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
- merchantSellerIdentifier? string - ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.
- marketplaceLiabilityType? string - This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.
- originationDocumentId? string - The transaction's original ID in its origination system
- originationSite? string - Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.
- details? TransactionLineDetailModel[] - Optional: A list of tax details for this line item.
Tax details represent taxes being charged by various tax authorities. Taxes that appear in the
detailscollection are intended to be displayed to the customer and charged as a 'tax' on the invoice. To fetch this list, add the query string?$include=Detailsto your URL.
- nonPassthroughDetails? TransactionLineDetailModel[] - Optional: A list of non-passthrough tax details for this line item.
Tax details represent taxes being charged by various tax authorities. Taxes that appear in the
nonPassthroughDetailscollection are taxes that must be paid directly by the company and not shown to the customer.
- lineLocationTypes? TransactionLineLocationTypeModel[] - Optional: A list of location types for this line item. To fetch this list, add the query string "?$include=LineLocationTypes" to your URL.
- parameters? TransactionLineParameterModel[] - Contains a list of extra parameters that were set when the transaction was created.
- userDefinedFields? TransactionLineUserDefinedFieldModel[] - Custom user fields/flex fields for this transaction.
- hsCode? string - The cross-border harmonized system code (HSCode) used to calculate tariffs and duties for this line item.
For a full list of HS codes, see
ListCrossBorderCodes().
- costInsuranceFreight? decimal - Indicates the cost of insurance and freight for this line.
- vatCode? string - Indicates the VAT code for this line item.
- vatNumberTypeId? int - Indicates the VAT number type for this line item.
- taxAmountByTaxTypes? TransactionLineTaxAmountByTaxTypeModel[] - Contains a list of TaxType that are to be overridden with their respective TaxOverrideAmount.
- deemedSupplier? string - Deemed Supplier field indicates which party on the marketplace transaction is liable for collecting and reporting the VAT. This is based on the 2021 E-commerce legislative reforms in EU and UK. This field will not be used until after July 1, 2021.
- category? string - Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “. Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.
- summary? string - A long description of the product.
avatax: TransactionLineParameterModel
Represents a transaction parameter.
Fields
- name? string - The name of the parameter.
- value? string - The value of the parameter.
- unit? string - The unit of measure of the parameter value.
avatax: TransactionLineTaxAmountByTaxTypeModel
Represents a transaction parameter.
Fields
- taxTypeId? string - The name of the TaxType.
- taxAmount? decimal - The value of the TaxOverrideAmount.
avatax: TransactionLineUserDefinedFieldModel
User Defined fields/Flex Fields at Transaction Line level.
Fields
- name? string - The name of the user defined field.
- value? string - The value of the user defined field.
avatax: TransactionLocationTypeModel
Information about a location type
Fields
- documentLocationTypeId? int - Location type ID for this location type in transaction
- documentId? int - Transaction ID
- documentAddressId? int - Address ID for the transaction
- locationTypeCode? string - Location type code
avatax: TransactionModel
This object represents a single transaction; for example, a sales invoice or purchase order.
Fields
- id? int - The unique ID number of this transaction.
- code? string - A unique customer-provided code identifying this transaction.
- companyId? int - The unique ID number of the company that recorded this transaction.
- date? string - The date on which this transaction occurred.
- paymentDate? string - DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed. The date when payment was made on this transaction. By default, this should be the same as the date of the transaction.
- status? string - The status of the transaction.
- 'type? string - The type of the transaction.
Transactions of type
SalesOrder,ReturnOrder, and so on are temporary estimates and will not be saved. Transactions of typeSalesInvoice,ReturnInvoice, and so on are permanent transactions that can be reported to tax authorities MISSING[]if they are in statusCommitted. A sales transaction represents a sale from the company to a customer. A purchase transaction represents a purchase made by the company. A return transaction represents a customer who decided to request a refund after purchasing a product from the company. An inventory transfer transaction represents goods that were moved from one location of the company to another location without changing ownership.
- batchCode? string - If this transaction was created as part of a batch, this code indicates which batch.
- currencyCode? string - The three-character ISO 4217 currency code that was used for payment for this transaction.
- exchangeRateCurrencyCode? string - The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.
- customerUsageType? string - DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this transaction. Customer usage types often affect exemption or taxability rules.
- entityUseCode? string - The entity use code for this transaction. Entity use codes often affect exemption or taxability rules.
- customerVendorCode? string - DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use
customerCodeThis field has been renamed tocustomerCodeto match documentation for other APIs related to exemption customers.
- customerCode? string - Unique code identifying the customer that requested this transaction.
When you specify a
customerCode, AvaTax will look to see if a customer exists with this code in the exemption certificate system. If that customer exists, and if that customer has uploaded an exemption certificate that applies to this transaction, the relevant parts of this transaction that can use the exemption certificate will be treated as exempt.
- exemptNo? string - The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options.
- reconciled? boolean - If this transaction has been reconciled against the company's ledger, this value is set to true.
- locationCode? string - DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead. This field has been replaced by the reportingLocationCode field
- reportingLocationCode? string - For customers who use location-based tax reporting, this field controls how this transaction will be filed for multi-location tax filings. If you specify a non-null value for this field, AvaTax will ensure that this transaction is reported on the tax return associated with the LocationModel identified by this code. This field does not affect any addresses for the transaction. It only controls the tax filing behavior of this transaction. If you are looking for information about how to set up addresses for a transaction, please see Using Address Types in the AvaTax Developer Guide.
- purchaseOrderNo? string - The customer-supplied purchase order number of this transaction.
- referenceCode? string - A user-defined reference code for this transaction.
- salespersonCode? string - The salesperson who provided this transaction. Not required.
- taxOverrideType? string - If a tax override was applied to this transaction, indicates what type of tax override was applied.
- taxOverrideAmount? decimal - If a tax override was applied to this transaction, indicates the amount of tax that was requested by the customer.
- taxOverrideReason? string - If a tax override was applied to this transaction, indicates the reason for the tax override.
- totalAmount? decimal - The total amount of this transaction.
- totalExempt? decimal - The amount of this transaction that was exempt.
- totalDiscount? decimal - The total amount of discounts applied to all lines within this transaction.
- totalTax? decimal - The total tax for all lines in this transaction.
If you used a
taxOverrideof typetaxAmountfor any lines in this transaction, this value may be different than the amount of tax calculated by AvaTax. The amount of tax calculated by AvaTax will be stored in thetotalTaxCalculatedfield, whereas this field will contain the total tax that was charged on the transaction. You can compare thetotalTaxandtotalTaxCalculatedfields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.
- totalTaxable? decimal - The portion of the total amount of this transaction that was taxable.
- totalTaxCalculated? decimal - The amount of tax that AvaTax calculated for the transaction.
If you used a
taxOverrideof typetaxAmountfor any lines in this transaction, this value will represent the amount that AvaTax calculated for this transaction without applying the override. The fieldtotalTaxwill be the total amount of tax after all overrides are applied. You can compare thetotalTaxandtotalTaxCalculatedfields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.
- adjustmentReason? string - If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted.
- adjustmentDescription? string - If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.
- locked? boolean - If this transaction has been reported to a tax authority, this transaction is considered locked and may not be adjusted after reporting.
- region? string - The two-or-three character ISO region code of the region for this transaction.
- country? string - The two-character ISO 3166 code of the country for this transaction.
- 'version? int - If this transaction was adjusted, this indicates the version number of this transaction. Incremented each time the transaction is adjusted.
- softwareVersion? string - The software version used to calculate this transaction.
- originAddressId? int - The unique ID number of the origin address for this transaction.
- destinationAddressId? int - The unique ID number of the destination address for this transaction.
- exchangeRateEffectiveDate? string - If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated.
- exchangeRate? decimal - If this transaction included foreign currency exchange, this is the exchange rate that was used.
- isSellerImporterOfRecord? boolean - By default, the value is null, when the value is null, the value can be set at nexus level and used. If the value is not null, it will override the value at nexus level. If true, this seller was considered the importer of record of a product shipped internationally. If this transaction is not an international transaction, this field may be left blank. The "importer of record" is liable to pay customs and import duties for products shipped internationally. If you specify that the seller is the importer of record, then estimates of customs and import duties will be added as tax details to the transaction. Otherwise, the buyer is considered the importer of record, and customs and import duties will not be added to the tax details for this transaction.
- description? string - Description of this transaction. Field permits unicode values.
- email? string - Email address associated with this transaction.
- businessIdentificationNo? string - VAT business identification number used for this transaction.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
- taxDate? string - Tax date for this transaction
- lines? TransactionLineModel[] - A list of line items in this transaction. To fetch this list, add the query string
?$include=Linesor?$include=Detailsto your URL.
- addresses? TransactionAddressModel[] - A list of line items in this transaction. To fetch this list, add the query string
?$include=Addressesto your URL. For more information about transaction addresses, please see Using Address Types in the AvaTax Developer Guide.
- locationTypes? TransactionLocationTypeModel[] - A list of location types in this transaction. To fetch this list, add the query string
?$include=Addressesto your URL.
- summary? TransactionSummary[] - Contains a summary of tax on this transaction.
- taxDetailsByTaxType? TaxDetailsByTaxType[] - Contains the tax details per tax type
- parameters? TransactionParameterModel[] - Contains a list of extra parameters that were set when the transaction was created.
- userDefinedFields? TransactionUserDefinedFieldModel[] - Custom user fields/flex fields for this transaction.
- messages? AvaTaxMessage[] - List of informational and warning messages regarding this API call. These messages are only relevant to the current API call.
- invoiceMessages? InvoiceMessageModel[] - Invoice messages associated with this document. Currently, this stores legally-required VAT messages.
- customerSupplierName? string - The name of the supplier / exporter / seller. For sales doctype this will be the name of your own company for which you are reporting. For purchases doctype this will be the name of the supplier you have purchased from.
- dataSourceId? int - The Id of the datasource from which this transaction originated. This value will be overridden by the system to take the datasource Id from the call header.
- deliveryTerms? string - The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not. Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total. This field is also used for reports. This field is used for future feature support. This field is not currently in use.
avatax: TransactionModelFetchResult
Fields
- '\@recordsetCount? int -
- value? TransactionModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: TransactionParameterModel
Represents a transaction parameter.
Fields
- name? string - The name of the parameter.
- value? string - The value of the parameter.
- unit? string - The unit of measure of the parameter value.
avatax: TransactionSummary
Summary information about an overall transaction.
Fields
- country? string - Two character ISO-3166 country code.
- region? string - Two or three character ISO region, state or province code, if applicable.
- jurisType? string - The type of jurisdiction that collects this tax.
- jurisCode? string - Jurisdiction Code for the taxing jurisdiction
- jurisName? string - The name of the jurisdiction that collects this tax.
- taxAuthorityType? int - The unique ID of the Tax Authority Type that collects this tax.
- stateAssignedNo? string - The state assigned number of the jurisdiction that collects this tax.
- taxType? string - The tax type of this tax.
- taxSubType? string - The tax subtype of this tax.
- taxName? string - The name of the tax.
- taxGroup? string - Group code when special grouping is enabled.
- rateType? string - DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead. Indicates the tax rate type.
- rateTypeCode? string - Indicates the code of the rate type. Use ListRateTypesByCountry API for a full list of rate type codes.
- taxable? decimal - Tax Base - The adjusted taxable amount.
- rate? decimal - Tax Rate - The rate of taxation, as a fraction of the amount.
- tax? decimal - Tax amount - The calculated tax (Base * Rate).
- taxCalculated? decimal - The amount of tax that AvaTax calculated for the transaction.
If you used a
taxOverrideof typetaxAmount, there may be a difference between thetaxfield which applies your override, and theTaxCalculatedfield which represents the amount of tax that AvaTax calculated for this transaction without override. You can use this for comparison.
- nonTaxable? decimal - The amount of the transaction that was non-taxable.
- exemption? decimal - The amount of the transaction that was exempt.
avatax: TransactionUserDefinedFieldModel
User Defined fields/Flex Fields at Transaction level.
Fields
- name? string - The name of the user defined field.
- value? string - The value of the user defined field.
avatax: UnitOfBasisModel
Fields
- unitOfBasisId? int - UnitOfBasisId
- unitOfBasis? string - UnitOfBasis Name
avatax: UnitOfBasisModelFetchResult
Fields
- '\@recordsetCount? int -
- value? UnitOfBasisModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: UomModel
The "Unit of Measurement" model captures information about a type of measurement. Types of measurement refer to different scales for the same dimension. For example, measurements of type "Distance" may include units of measurement such as meters, feet, inches, and miles.
Fields
- id? int - The unique ID number of this unit of measurement.
- code? string - The code that refers to this unit of measurement.
- shortDesc? string - A short description of this unit of measurement.
- description? string - A longer description of this unit of measurement.
- measurementTypeId? int - The ID number of the measurement type, such as "Distance" or "Mass".
- measurementTypeCode? string - The code describing the measurement type.
- siUOM? string - For a particular measurement type, this is the ID number of the unit of measurement object corresponding to the International System of Units (abbreviated SI) unit of measurement standard. This pointer allows you to select the SI unit of measurement for a particular measurement type.
- measurementTypeDescription? string - A description of the measurement type system.
- isSiUom? boolean - True if this measurement is an International System of Units (abbreviated SI) defined standard.
avatax: UomModelFetchResult
Fields
- '\@recordsetCount? int -
- value? UomModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: UPCModel
One Universal Product Code object as defined for your company.
Fields
- id? int - The unique ID number for this UPC.
- companyId? int - The unique ID number of the company to which this UPC belongs.
- upc string - The 12-14 character Universal Product Code, European Article Number, or Global Trade Identification Number.
- legacyTaxCode? string - Legacy Tax Code applied to any product sold with this UPC.
- description string - Description of the product to which this UPC applies.
- effectiveDate? string - If this UPC became effective on a certain date, this contains the first date on which the UPC was effective.
- endDate? string - If this UPC expired or will expire on a certain date, this contains the last date on which the UPC was effective.
- usage? int - A usage identifier for this UPC code.
- isSystem? int - A flag indicating whether this UPC code is attached to the AvaTax system or to a company.
- createdDate? string - The date when this record was created.
- createdUserId? int - The User ID of the user who created this record.
- modifiedDate? string - The date/time when this record was last modified.
- modifiedUserId? int - The user ID of the user who last modified this record.
avatax: UPCModelFetchResult
Fields
- '\@recordsetCount? int -
- value? UPCModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: UpdateCompanyLocationRemittanceModel
Expire a location without restriction then update with new remittance and dates.
Fields
- addressCategoryId string - Indicates whether this location is a physical place of business or a temporary salesperson location.
- effectiveDate string - The date when this location was opened for business.
- endDate? string - If this place of business has closed, the date when this location closed business. If null it'll be set to the date of 9998-12-31.
avatax: UserEntitlementModel
User Entitlement Model
Fields
- permissions? string[] - List of API names and categories that this user is permitted to access
- accessLevel? string - What access privileges does the current user have to see companies?
- companies? int[] - The identities of all companies this user is permitted to access
avatax: UserModel
An account user who is permitted to use AvaTax.
Fields
- id int - The unique ID number of this user.
- accountId int - The unique ID number of the account to which this user belongs.
- companyId? int - If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.
- userName string - The username which is used to log on to the AvaTax website, or to authenticate against API calls.
- firstName string - The first or given name of the user.
- lastName string - The last or family name of the user.
- email string - The email address to be used to contact this user. If the user has forgotten a password, an email can be sent to this email address with information on how to reset this password.
- postalCode? string - The postal code in which this user resides.
- securityRoleId string - The security level for this user.
- passwordStatus? string - The status of the user's password. For a new user created, this is always going to be
UserMustChange
- isActive? boolean - True if this user is currently active.
- createdDate? string - The date when this record was created.
- modifiedDate? string - The date/time when this record was last modified.
- subjectId? string - Matches the subjectId of corresponding user record in AI.
- suppressNewUserEmail? boolean - Suppress new user email
avatax: UserModelFetchResult
Fields
- '\@recordsetCount? int -
- value? UserModel[] -
- '\@nextLink? string -
- pageKey? string -
avatax: ValidatedAddressInfo
Represents a validated address
Fields
- addressType? string - Address type code. One of:
- Firm or company address
- General Delivery address
- High-rise or business complex
- PO Box address
- Rural route address
- Street or residential address
- line1? string - First line of the street address
- line2? string - Second line of the street address
- line3? string - Third line of the street address
- city? string - City component of the address
- region? string - Name or ISO 3166 code identifying the region within the country.
This field supports many different region identifiers:
- Two and three character ISO 3166 region codes
- Fully spelled out names of the region in ISO supported languages
- Common alternative spellings for many regions
ListRegions.
- country? string - Name or ISO 3166 code identifying the country.
This field supports many different country identifiers:
- Two character ISO 3166 codes
- Three character ISO 3166 codes
- Fully spelled out names of the country in ISO supported languages
- Common alternative spellings for many countries
ListCountries.
- postalCode? string - Postal Code / Zip Code component of the address.
- latitude? decimal - Geospatial latitude measurement, in Decimal Degrees floating point format.
- longitude? decimal - Geospatial longitude measurement, in Decimal Degrees floating point format.
avatax: VerifyMultiDocumentModel
Verify that a MultiDocument object matches the information in your accounting system.
If all attributes of the MultiDocument object match the values in your request, the
MultiDocument object will be moved to the document status Posted.
For more information on document status, see DocumentStatus.
Fields
- code string - Represents the unique code of this MultiDocument transaction.
A MultiDocument transaction is uniquely identified by its
accountId,code, andtype.
- 'type string - Represents the document type of this MultiDocument transaction. For more information about
document types, see DocumentType.
A MultiDocument transaction is uniquely identified by its
accountId,code, andtype.
- verifyTransactionDate? string - Set this value if you wish to verify a match between
verifyTransactionDateand thedocumentDatevalue on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field.
- verifyTotalAmount? decimal - Set this value if you wish to verify a match between
verifyTotalAmountand thetotalAmountvalue on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field.
- verifyTotalTax? decimal - Set this value if you wish to verify a match between
verifyTotalTaxand thetotalTaxvalue on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field.
avatax: VerifyTransactionModel
Verify this transaction by matching it to values in your accounting system.
You may specify one or more of the following fields to verify: date, totalAmount, or totalTax.
This call will report an error if there is any difference between the data stored in AvaTax and
the data stored in your accounting system.
Fields
- verifyTransactionDate? string - Set this value if you wish to verify a match between
verifyTransactionDateand thedocumentDatevalue on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field.
- verifyTotalAmount? decimal - Set this value if you wish to verify a match between
verifyTotalAmountand thetotalAmountvalue on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field.
- verifyTotalTax? decimal - Set this value if you wish to verify a match between
verifyTotalTaxand thetotalTaxvalue on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field.
avatax: VoidTransactionModel
A request to void a previously created transaction
Fields
- code string - Please specify the reason for voiding or cancelling this transaction. To void the transaction, please specify the reason 'DocVoided'. If you do not provide a reason, the void command will fail.
avatax: WorksheetDocument
Fields
- docCode? string -
- docDate? string -
- totalExempt? decimal -
- totalTaxable? decimal -
- totalTax? decimal -
- lines? WorksheetDocumentLine[] -
- messages? Message[] -
- resultCode? string -
- transactionId? string -
avatax: WorksheetDocumentLine
Fields
- reportingDate? string -
- lineNo? string -
- lineAmount? decimal -
- exemptAmount? decimal -
- taxableAmount? decimal -
- taxAmount? decimal -
- messages? Message[] -
- resultCode? string -
- transactionId? string -
Array types
avatax: AccountModelArr
AccountModelArr
avatax: ErrorDetailArr
ErrorDetailArr
avatax: AccountConfigurationModelArr
AccountConfigurationModelArr
avatax: AccountLicenseKeyModelArr
AccountLicenseKeyModelArr
avatax: AvaFileFormModelArr
AvaFileFormModelArr
avatax: BatchModelArr
BatchModelArr
avatax: CertExpressInvitationStatusModelArr
CertExpressInvitationStatusModelArr
avatax: CertificateModelArr
CertificateModelArr
avatax: CompanyModelArr
CompanyModelArr
avatax: FundingConfigurationModelArr
FundingConfigurationModelArr
avatax: CompanyParameterDetailModelArr
CompanyParameterDetailModelArr
avatax: CompanyConfigurationModelArr
CompanyConfigurationModelArr
avatax: FundingStatusModelArr
FundingStatusModelArr
avatax: ContactModelArr
ContactModelArr
avatax: CustomerModelArr
CustomerModelArr
avatax: DataSourceModelArr
DataSourceModelArr
avatax: CompanyDistanceThresholdModelArr
CompanyDistanceThresholdModelArr
avatax: CompanyReturnSettingModelArr
CompanyReturnSettingModelArr
avatax: ItemModelArr
ItemModelArr
avatax: ItemClassificationOutputModelArr
ItemClassificationOutputModelArr
avatax: ItemParameterModelArr
ItemParameterModelArr
avatax: ItemTagDetailModelArr
ItemTagDetailModelArr
avatax: JurisdictionOverrideModelArr
JurisdictionOverrideModelArr
avatax: LocationModelArr
LocationModelArr
avatax: LocationParameterModelArr
LocationParameterModelArr
avatax: NexusModelArr
NexusModelArr
avatax: NexusParameterDetailModelArr
NexusParameterDetailModelArr
avatax: NexusByAddressModelArr
NexusByAddressModelArr
avatax: NotificationModelArr
NotificationModelArr
avatax: ReportModelArr
ReportModelArr
avatax: SettingModelArr
SettingModelArr
avatax: SubscriptionModelArr
SubscriptionModelArr
avatax: TaxCodeModelArr
TaxCodeModelArr
avatax: TaxRuleModelArr
TaxRuleModelArr
avatax: UPCModelArr
UPCModelArr
avatax: UserModelArr
UserModelArr