Package net.avalara.avatax.rest.client

Class AvaTaxClient

java.lang.Object

net.avalara.avatax.rest.client.AvaTaxClient

public class AvaTaxClient
extends Object

Constructor Summary

Constructors

Constructor	Description
AvaTaxClient(String appName, String appVersion, String machineName, String environmentUrl)
AvaTaxClient(String appName, String appVersion, String machineName, String environmentUrl, String proxyHost, int proxyPort, String proxySchema)
AvaTaxClient(String appName, String appVersion, String machineName, String environmentUrl, String proxyHost, int proxyPort, String proxySchema, ExecutorService threadPool)
AvaTaxClient(String appName, String appVersion, String machineName, String environmentUrl, ExecutorService threadPool)
AvaTaxClient(String appName, String appVersion, String machineName, String environmentUrl, ExecutorService threadPool, org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)
AvaTaxClient(String appName, String appVersion, String machineName, AvaTaxEnvironment environment)
AvaTaxClient(String appName, String appVersion, String machineName, AvaTaxEnvironment environment, String proxyHost, int proxyPort, String proxySchema)
AvaTaxClient(String appName, String appVersion, String machineName, AvaTaxEnvironment environment, String proxyHost, int proxyPort, String proxySchema, ExecutorService threadPool)
AvaTaxClient(String appName, String appVersion, String machineName, AvaTaxEnvironment environment, ExecutorService threadPool)
AvaTaxClient(String appName, String appVersion, String machineName, AvaTaxEnvironment environment, ExecutorService threadPool, org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

Method Summary

Modifier and Type	Method	Description
LicenseKeyModel	accountResetLicenseKey(Integer id, ResetLicenseKeyModel model)	Reset this account's license key Resets the existing license key for this account to a new key.
Future<LicenseKeyModel>	accountResetLicenseKeyAsync(Integer id, ResetLicenseKeyModel model)	Reset this account's license key Resets the existing license key for this account to a new key.
AccountModel	activateAccount(Integer id, ActivateAccountModel model)	Activate an account by accepting terms and conditions Activate the account specified by the unique accountId number.
Future<AccountModel>	activateAccountAsync(Integer id, ActivateAccountModel model)	Activate an account by accepting terms and conditions Activate the account specified by the unique accountId number.
FundingStatusModel	activateFundingRequest(Long id)	Request the javascript for a funding setup widget This API is available by invitation only.
Future<FundingStatusModel>	activateFundingRequestAsync(Long id)	Request the javascript for a funding setup widget This API is available by invitation only.
TransactionModel	addLines(String include, AddTransactionLineModel model)	Add lines to an existing unlocked transaction Add lines to an existing unlocked transaction.
Future<TransactionModel>	addLinesAsync(String include, AddTransactionLineModel model)	Add lines to an existing unlocked transaction Add lines to an existing unlocked transaction.
MultiDocumentModel	adjustMultiDocumentTransaction(String code, DocumentType type, String include, AdjustMultiDocumentModel model)	Adjust a MultiDocument transaction Adjusts the current MultiDocument transaction uniquely identified by this URL.
Future<MultiDocumentModel>	adjustMultiDocumentTransactionAsync(String code, DocumentType type, String include, AdjustMultiDocumentModel model)	Adjust a MultiDocument transaction Adjusts the current MultiDocument transaction uniquely identified by this URL.
TransactionModel	adjustTransaction(String companyCode, String transactionCode, DocumentType documentType, String include, AdjustTransactionModel model)	Correct a previously created transaction Replaces the current transaction uniquely identified by this URL with a new transaction.
Future<TransactionModel>	adjustTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include, AdjustTransactionModel model)	Correct a previously created transaction Replaces the current transaction uniquely identified by this URL with a new transaction.
FirmClientLinkageOutputModel	approveFirmClientLinkage(Integer id)	Approves linkage to a firm for a client account This API enables the account admin of a client account to approve linkage request by a firm.
Future<FirmClientLinkageOutputModel>	approveFirmClientLinkageAsync(Integer id)	Approves linkage to a firm for a client account This API enables the account admin of a client account to approve linkage request by a firm.
FetchResult<AuditModel>	auditAccount(Integer id, Date start, Date end, Integer top, Integer skip)	Retrieve audit history for an account.
Future<FetchResult<AuditModel>>	auditAccountAsync(Integer id, Date start, Date end, Integer top, Integer skip)	Retrieve audit history for an account.
AuditMultiDocumentModel	auditMultiDocumentTransaction(String code, DocumentType type)	Get audit information about a MultiDocument transaction Retrieve audit information about a MultiDocument transaction stored in AvaTax.
Future<AuditMultiDocumentModel>	auditMultiDocumentTransactionAsync(String code, DocumentType type)	Get audit information about a MultiDocument transaction Retrieve audit information about a MultiDocument transaction stored in AvaTax.
AuditTransactionModel	auditTransaction(String companyCode, String transactionCode)	Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax.
Future<AuditTransactionModel>	auditTransactionAsync(String companyCode, String transactionCode)	Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax.
AuditTransactionModel	auditTransactionWithType(String companyCode, String transactionCode, DocumentType documentType)	Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax.
Future<AuditTransactionModel>	auditTransactionWithTypeAsync(String companyCode, String transactionCode, DocumentType documentType)	Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax.
ArrayList<ErrorDetail>	batchDeleteItemClassifications(Integer companyId, Long itemId)	Delete all classifications for an item Delete all the classifications for a given item.
Future<ArrayList<ErrorDetail>>	batchDeleteItemClassificationsAsync(Integer companyId, Long itemId)	Delete all classifications for an item Delete all the classifications for a given item.
ArrayList<ErrorDetail>	batchDeleteItemParameters(Integer companyId, Long itemId)	Delete all parameters for an item Delete all the parameters for a given item.
Future<ArrayList<ErrorDetail>>	batchDeleteItemParametersAsync(Integer companyId, Long itemId)	Delete all parameters for an item Delete all the parameters for a given item.
String	buildTaxContentFile(PointOfSaleDataRequestModel model)	Build a multi-location tax content file Builds a tax content file containing information useful for a retail point-of-sale solution.
Future<String>	buildTaxContentFileAsync(PointOfSaleDataRequestModel model)	Build a multi-location tax content file Builds a tax content file containing information useful for a retail point-of-sale solution.
String	buildTaxContentFileForLocation(Integer companyId, Integer id, Date date, PointOfSaleFileType format, PointOfSalePartnerId partnerId, Boolean includeJurisCodes)	Build a tax content file for a single location Builds a tax content file containing information useful for a retail point-of-sale solution.
Future<String>	buildTaxContentFileForLocationAsync(Integer companyId, Integer id, Date date, PointOfSaleFileType format, PointOfSalePartnerId partnerId, Boolean includeJurisCodes)	Build a tax content file for a single location Builds a tax content file containing information useful for a retail point-of-sale solution.
BulkLockTransactionResult	bulkLockTransaction(BulkLockTransactionModel model)	Lock a set of documents This API is available by invitation only.
Future<BulkLockTransactionResult>	bulkLockTransactionAsync(BulkLockTransactionModel model)	Lock a set of documents This API is available by invitation only.
ItemBulkUploadOutputModel	bulkUploadItems(Integer companyId, ItemBulkUploadInputModel model)	Bulk upload items from a product catalog Create/Update one or more item objects attached to this company.
Future<ItemBulkUploadOutputModel>	bulkUploadItemsAsync(Integer companyId, ItemBulkUploadInputModel model)	Bulk upload items from a product catalog Create/Update one or more item objects attached to this company.
BatchModel	cancelBatch(Integer companyId, Integer id)	Cancel an in progress batch Marks the in progress batch identified by this URL as cancelled.
Future<BatchModel>	cancelBatchAsync(Integer companyId, Integer id)	Cancel an in progress batch Marks the in progress batch identified by this URL as cancelled.
String	certifyIntegration(Integer id)	Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
Future<String>	certifyIntegrationAsync(Integer id)	Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
String	changeFilingStatus(Integer id, FilingStatusChangeModel model)	Change the filing status of this company Changes the current filing status of this company.
Future<String>	changeFilingStatusAsync(Integer id, FilingStatusChangeModel model)	Change the filing status of this company Changes the current filing status of this company.
String	changePassword(PasswordChangeModel model)	Change Password Allows a user to change their password via an API call.
Future<String>	changePasswordAsync(PasswordChangeModel model)	Change Password Allows a user to change their password via an API call.
TransactionModel	changeTransactionCode(String companyCode, String transactionCode, DocumentType documentType, String include, ChangeTransactionCodeModel model)	Change a transaction's code Renames a transaction uniquely identified by this URL by changing its `code` value.
Future<TransactionModel>	changeTransactionCodeAsync(String companyCode, String transactionCode, DocumentType documentType, String include, ChangeTransactionCodeModel model)	Change a transaction's code Renames a transaction uniquely identified by this URL by changing its `code` value.
MultiDocumentModel	commitMultiDocumentTransaction(CommitMultiDocumentModel model)	Commit a MultiDocument transaction Marks a list of transactions by changing its status to `Committed`.
Future<MultiDocumentModel>	commitMultiDocumentTransactionAsync(CommitMultiDocumentModel model)	Commit a MultiDocument transaction Marks a list of transactions by changing its status to `Committed`.
TransactionModel	commitTransaction(String companyCode, String transactionCode, DocumentType documentType, String include, CommitTransactionModel model)	Commit a transaction for reporting Marks a transaction by changing its status to `Committed`.
Future<TransactionModel>	commitTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include, CommitTransactionModel model)	Commit a transaction for reporting Marks a transaction by changing its status to `Committed`.
CompanyModel	companyInitialize(CompanyInitializationModel model)	Quick setup for a company with a single physical address Shortcut to quickly setup a single-physical-location company with critical information and activate it.
Future<CompanyModel>	companyInitializeAsync(CompanyInitializationModel model)	Quick setup for a company with a single physical address Shortcut to quickly setup a single-physical-location company with critical information and activate it.
ArrayList<AccountModel>	createAccount(AccountModel model)	Create a new account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
Future<ArrayList<AccountModel>>	createAccountAsync(AccountModel model)	Create a new account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
FirmClientLinkageOutputModel	createAndLinkNewFirmClientAccount(NewFirmClientAccountRequestModel model)	Request a new FirmClient account and create an approved linkage to it This API is for use by Firms only.
Future<FirmClientLinkageOutputModel>	createAndLinkNewFirmClientAccountAsync(NewFirmClientAccountRequestModel model)	Request a new FirmClient account and create an approved linkage to it This API is for use by Firms only.
ArrayList<AvaFileFormModel>	createAvaFileForms(ArrayList<AvaFileFormModel> model)	Create a new AvaFileForm Create one or more AvaFileForms A 'AvaFileForm' represents a form supported by our returns team ### Security Policies * This API requires the user role Compliance Root User.
Future<ArrayList<AvaFileFormModel>>	createAvaFileFormsAsync(ArrayList<AvaFileFormModel> model)	Create a new AvaFileForm Create one or more AvaFileForms A 'AvaFileForm' represents a form supported by our returns team ### Security Policies * This API requires the user role Compliance Root User.
ArrayList<BatchModel>	createBatches(Integer companyId, ArrayList<BatchModel> model)	Create a new batch Create one or more new batch objects attached to this company.
Future<ArrayList<BatchModel>>	createBatchesAsync(Integer companyId, ArrayList<BatchModel> model)	Create a new batch Create one or more new batch objects attached to this company.
ArrayList<CertExpressInvitationStatusModel>	createCertExpressInvitation(Integer companyId, String customerCode, ArrayList<CreateCertExpressInvitationModel> model)	Create a CertExpress invitation Creates an invitation for a customer to self-report certificates using the CertExpress website.
Future<ArrayList<CertExpressInvitationStatusModel>>	createCertExpressInvitationAsync(Integer companyId, String customerCode, ArrayList<CreateCertExpressInvitationModel> model)	Create a CertExpress invitation Creates an invitation for a customer to self-report certificates using the CertExpress website.
ArrayList<CertificateModel>	createCertificates(Integer companyId, Boolean preValidatedExemptionReason, ArrayList<CertificateModel> model)	Create certificates for this company Record one or more certificates document for this company.
Future<ArrayList<CertificateModel>>	createCertificatesAsync(Integer companyId, Boolean preValidatedExemptionReason, ArrayList<CertificateModel> model)	Create certificates for this company Record one or more certificates document for this company.
ArrayList<CompanyModel>	createCompanies(ArrayList<CompanyModel> model)	Create new companies Create one or more new company objects.
Future<ArrayList<CompanyModel>>	createCompaniesAsync(ArrayList<CompanyModel> model)	Create new companies Create one or more new company objects.
AdvancedRuleLookupFileModel	createCompanyLookupFile(Integer accountId, Integer companyId, AdvancedRuleLookupFileModel model)	Create a lookup file for a company Swagger Name: AvaTaxClient
Future<AdvancedRuleLookupFileModel>	createCompanyLookupFileAsync(Integer accountId, Integer companyId, AdvancedRuleLookupFileModel model)	Create a lookup file for a company Swagger Name: AvaTaxClient
ArrayList<CompanyParameterDetailModel>	createCompanyParameters(Integer companyId, ArrayList<CompanyParameterDetailModel> model)	Add parameters to a company.
Future<ArrayList<CompanyParameterDetailModel>>	createCompanyParametersAsync(Integer companyId, ArrayList<CompanyParameterDetailModel> model)	Add parameters to a company.
ArrayList<ContactModel>	createContacts(Integer companyId, ArrayList<ContactModel> model)	Create a new contact Create one or more new contact objects.
Future<ArrayList<ContactModel>>	createContactsAsync(Integer companyId, ArrayList<ContactModel> model)	Create a new contact Create one or more new contact objects.
ArrayList<CustomerModel>	createCustomers(Integer companyId, ArrayList<CustomerModel> model)	Create customers for this company Create one or more customers for this company.
Future<ArrayList<CustomerModel>>	createCustomersAsync(Integer companyId, ArrayList<CustomerModel> model)	Create customers for this company Create one or more customers for this company.
ArrayList<DataSourceModel>	createDataSources(Integer companyId, ArrayList<DataSourceModel> model)	Create and store new datasources for the respective companies.
Future<ArrayList<DataSourceModel>>	createDataSourcesAsync(Integer companyId, ArrayList<DataSourceModel> model)	Create and store new datasources for the respective companies.
ArrayList<CompanyDistanceThresholdModel>	createDistanceThreshold(Integer companyId, ArrayList<CompanyDistanceThresholdModel> model)	Create one or more DistanceThreshold objects Create one or more DistanceThreshold objects for this company.
Future<ArrayList<CompanyDistanceThresholdModel>>	createDistanceThresholdAsync(Integer companyId, ArrayList<CompanyDistanceThresholdModel> model)	Create one or more DistanceThreshold objects Create one or more DistanceThreshold objects for this company.
ECommerceTokenOutputModel	createECommerceToken(Integer companyId, CreateECommerceTokenInputModel model)	Create a new eCommerce token.
Future<ECommerceTokenOutputModel>	createECommerceTokenAsync(Integer companyId, CreateECommerceTokenInputModel model)	Create a new eCommerce token.
FirmClientLinkageOutputModel	createFirmClientLinkage(FirmClientLinkageInputModel model)	Links a firm account with the client account This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
Future<FirmClientLinkageOutputModel>	createFirmClientLinkageAsync(FirmClientLinkageInputModel model)	Links a firm account with the client account This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
FundingStatusModel	createFundingRequest(Integer id, FundingInitiateModel model)	Request managed returns funding setup for a company This API is available by invitation only.
Future<FundingStatusModel>	createFundingRequestAsync(Integer id, FundingInitiateModel model)	Request managed returns funding setup for a company This API is available by invitation only.
ArrayList<ItemClassificationOutputModel>	createItemClassifications(Integer companyId, Long itemId, ArrayList<ItemClassificationInputModel> model)	Add classifications to an item.
Future<ArrayList<ItemClassificationOutputModel>>	createItemClassificationsAsync(Integer companyId, Long itemId, ArrayList<ItemClassificationInputModel> model)	Add classifications to an item.
ArrayList<ItemParameterModel>	createItemParameters(Integer companyId, Long itemId, ArrayList<ItemParameterModel> model)	Add parameters to an item.
Future<ArrayList<ItemParameterModel>>	createItemParametersAsync(Integer companyId, Long itemId, ArrayList<ItemParameterModel> model)	Add parameters to an item.
ArrayList<ItemModel>	createItems(Integer companyId, ArrayList<ItemModel> model)	Create a new item Creates one or more new item objects attached to this company.
Future<ArrayList<ItemModel>>	createItemsAsync(Integer companyId, ArrayList<ItemModel> model)	Create a new item Creates one or more new item objects attached to this company.
ArrayList<ItemTagDetailModel>	createItemTags(Integer companyId, Integer itemId, ArrayList<ItemTagDetailModel> model)	Create tags for a item Creates one or more new `Tag` objects attached to this Item.
Future<ArrayList<ItemTagDetailModel>>	createItemTagsAsync(Integer companyId, Integer itemId, ArrayList<ItemTagDetailModel> model)	Create tags for a item Creates one or more new `Tag` objects attached to this Item.
ArrayList<JurisdictionOverrideModel>	createJurisdictionOverrides(Integer accountId, ArrayList<JurisdictionOverrideModel> model)	Create one or more overrides Creates one or more jurisdiction override objects for this account.
Future<ArrayList<JurisdictionOverrideModel>>	createJurisdictionOverridesAsync(Integer accountId, ArrayList<JurisdictionOverrideModel> model)	Create one or more overrides Creates one or more jurisdiction override objects for this account.
LicenseKeyModel	createLicenseKey(Integer id, AccountLicenseKeyModel model)	Create license key for this account Creates a new license key for this account.
Future<LicenseKeyModel>	createLicenseKeyAsync(Integer id, AccountLicenseKeyModel model)	Create license key for this account Creates a new license key for this account.
ArrayList<LocationParameterModel>	createLocationParameters(Integer companyId, Integer locationId, ArrayList<LocationParameterModel> model)	Add parameters to a location.
Future<ArrayList<LocationParameterModel>>	createLocationParametersAsync(Integer companyId, Integer locationId, ArrayList<LocationParameterModel> model)	Add parameters to a location.
ArrayList<LocationModel>	createLocations(Integer companyId, ArrayList<LocationModel> model)	Create a new location Create one or more new location objects attached to this company.
Future<ArrayList<LocationModel>>	createLocationsAsync(Integer companyId, ArrayList<LocationModel> model)	Create a new location Create one or more new location objects attached to this company.
MultiDocumentModel	createMultiDocumentTransaction(String include, CreateMultiDocumentModel model)	Create a new MultiDocument transaction Records a new MultiDocument transaction in AvaTax.
Future<MultiDocumentModel>	createMultiDocumentTransactionAsync(String include, CreateMultiDocumentModel model)	Create a new MultiDocument transaction Records a new MultiDocument transaction in AvaTax.
ArrayList<NexusModel>	createNexus(Integer companyId, ArrayList<NexusModel> model)	Create a new nexus Creates one or more new nexus declarations attached to this company.
Future<ArrayList<NexusModel>>	createNexusAsync(Integer companyId, ArrayList<NexusModel> model)	Create a new nexus Creates one or more new nexus declarations attached to this company.
ArrayList<NexusParameterDetailModel>	createNexusParameters(Integer companyId, Integer nexusId, ArrayList<NexusParameterDetailModel> model)	Add parameters to a nexus.
Future<ArrayList<NexusParameterDetailModel>>	createNexusParametersAsync(Integer companyId, Integer nexusId, ArrayList<NexusParameterDetailModel> model)	Add parameters to a nexus.
NoticeResponsibilityModel	createNoticeResponsibilityType(CreateNoticeResponsibilityTypeModel model)	Creates a new tax notice responsibility type.
Future<NoticeResponsibilityModel>	createNoticeResponsibilityTypeAsync(CreateNoticeResponsibilityTypeModel model)	Creates a new tax notice responsibility type.
NoticeRootCauseModel	createNoticeRootCauseType(CreateNoticeRootCauseTypeModel model)	Creates a new tax notice root cause type.
Future<NoticeRootCauseModel>	createNoticeRootCauseTypeAsync(CreateNoticeRootCauseTypeModel model)	Creates a new tax notice root cause type.
ArrayList<NotificationModel>	createNotifications(ArrayList<NotificationModel> model)	Create new notifications.
Future<ArrayList<NotificationModel>>	createNotificationsAsync(ArrayList<NotificationModel> model)	Create new notifications.
TransactionModel	createOrAdjustTransaction(String include, CreateOrAdjustTransactionModel model)	Create or adjust a transaction Records a new transaction or adjust an existing transaction in AvaTax.
Future<TransactionModel>	createOrAdjustTransactionAsync(String include, CreateOrAdjustTransactionModel model)	Create or adjust a transaction Records a new transaction or adjust an existing transaction in AvaTax.
ArrayList<SettingModel>	createSettings(Integer companyId, ArrayList<SettingModel> model)	Create a new setting Create one or more new setting objects attached to this company.
Future<ArrayList<SettingModel>>	createSettingsAsync(Integer companyId, ArrayList<SettingModel> model)	Create a new setting Create one or more new setting objects attached to this company.
ArrayList<SubscriptionModel>	createSubscriptions(Integer accountId, ArrayList<SubscriptionModel> model)	Create a new subscription This API is for use by Avalara Registrar administrative users only.
Future<ArrayList<SubscriptionModel>>	createSubscriptionsAsync(Integer accountId, ArrayList<SubscriptionModel> model)	Create a new subscription This API is for use by Avalara Registrar administrative users only.
ItemTaxCodeClassificationRequestOutputModel	createTaxCodeClassificationRequest(Integer companyId, ItemTaxCodeClassificationRequestInputModel model)	Create a new tax code classification request Creates a new tax code classification request.
Future<ItemTaxCodeClassificationRequestOutputModel>	createTaxCodeClassificationRequestAsync(Integer companyId, ItemTaxCodeClassificationRequestInputModel model)	Create a new tax code classification request Creates a new tax code classification request.
ArrayList<TaxCodeModel>	createTaxCodes(Integer companyId, ArrayList<TaxCodeModel> model)	Create a new tax code Create one or more new taxcode objects attached to this company.
Future<ArrayList<TaxCodeModel>>	createTaxCodesAsync(Integer companyId, ArrayList<TaxCodeModel> model)	Create a new tax code Create one or more new taxcode objects attached to this company.
ArrayList<TaxRuleModel>	createTaxRules(Integer companyId, ArrayList<TaxRuleModel> model)	Create a new tax rule Create one or more custom tax rules attached to this company.
Future<ArrayList<TaxRuleModel>>	createTaxRulesAsync(Integer companyId, ArrayList<TaxRuleModel> model)	Create a new tax rule Create one or more custom tax rules attached to this company.
TransactionModel	createTransaction(String include, CreateTransactionModel model)	Create a new transaction Records a new transaction in AvaTax.
Future<TransactionModel>	createTransactionAsync(String include, CreateTransactionModel model)	Create a new transaction Records a new transaction in AvaTax.
CreateTransactionBatchResponseModel	createTransactionBatch(Integer companyId, CreateTransactionBatchRequestModel model)	Create a new transaction batch Create a new transaction batch objects attached to this company.
Future<CreateTransactionBatchResponseModel>	createTransactionBatchAsync(Integer companyId, CreateTransactionBatchRequestModel model)	Create a new transaction batch Create a new transaction batch objects attached to this company.
ArrayList<UPCModel>	createUPCs(Integer companyId, ArrayList<UPCModel> model)	Create a new UPC Create one or more new UPC objects attached to this company.
Future<ArrayList<UPCModel>>	createUPCsAsync(Integer companyId, ArrayList<UPCModel> model)	Create a new UPC Create one or more new UPC objects attached to this company.
ArrayList<UserModel>	createUsers(Integer accountId, ArrayList<UserModel> model)	Create new users Create one or more new user objects attached to this account.
Future<ArrayList<UserModel>>	createUsersAsync(Integer accountId, ArrayList<UserModel> model)	Create new users Create one or more new user objects attached to this account.
ArrayList<NexusByAddressModel>	declareNexusByAddress(Integer companyId, ArrayList<DeclareNexusByAddressModel> model)	Creates nexus for a list of addresses.
Future<ArrayList<NexusByAddressModel>>	declareNexusByAddressAsync(Integer companyId, ArrayList<DeclareNexusByAddressModel> model)	Creates nexus for a list of addresses.
ArrayList<ErrorDetail>	deleteAccount(Integer id)	Delete a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
Future<ArrayList<ErrorDetail>>	deleteAccountAsync(Integer id)	Delete a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
ArrayList<ErrorDetail>	deleteAvaFileForm(Integer id)	Delete a single AvaFileForm Marks the existing AvaFileForm object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteAvaFileFormAsync(Integer id)	Delete a single AvaFileForm Marks the existing AvaFileForm object at this URL as deleted.
ArrayList<ErrorDetail>	deleteBatch(Integer companyId, Integer id)	Delete a single batch Marks the batch identified by this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteBatchAsync(Integer companyId, Integer id)	Delete a single batch Marks the batch identified by this URL as deleted.
ArrayList<ErrorDetail>	deleteCatalogueItem(Integer companyId, String itemCode)	Delete a single item Deletes the item object at this URL.
Future<ArrayList<ErrorDetail>>	deleteCatalogueItemAsync(Integer companyId, String itemCode)	Delete a single item Deletes the item object at this URL.
ArrayList<ErrorDetail>	deleteCertificate(Integer companyId, Integer id)	Revoke and delete a certificate Revoke the certificate identified by this URL, then delete it.
Future<ArrayList<ErrorDetail>>	deleteCertificateAsync(Integer companyId, Integer id)	Revoke and delete a certificate Revoke the certificate identified by this URL, then delete it.
ArrayList<ErrorDetail>	deleteCompany(Integer id)	Delete a single company Deleting a company will delete all child companies, and all users attached to this company.
Future<ArrayList<ErrorDetail>>	deleteCompanyAsync(Integer id)	Delete a single company Deleting a company will delete all child companies, and all users attached to this company.
ArrayList<ErrorDetail>	deleteCompanyParameter(Integer companyId, Long id)	Delete a single company parameter Delete a parameter of a company.
Future<ArrayList<ErrorDetail>>	deleteCompanyParameterAsync(Integer companyId, Long id)	Delete a single company parameter Delete a parameter of a company.
ArrayList<ErrorDetail>	deleteContact(Integer companyId, Integer id)	Delete a single contact Mark the existing contact object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteContactAsync(Integer companyId, Integer id)	Delete a single contact Mark the existing contact object at this URL as deleted.
CustomerModel	deleteCustomer(Integer companyId, String customerCode)	Delete a customer record Deletes the customer object referenced by this URL.
Future<CustomerModel>	deleteCustomerAsync(Integer companyId, String customerCode)	Delete a customer record Deletes the customer object referenced by this URL.
ArrayList<ErrorDetail>	deleteDataSource(Integer companyId, Integer id)	Delete a datasource by datasource id for a company.
Future<ArrayList<ErrorDetail>>	deleteDataSourceAsync(Integer companyId, Integer id)	Delete a datasource by datasource id for a company.
ArrayList<ErrorDetail>	deleteDistanceThreshold(Integer companyId, Long id)	Delete a single DistanceThreshold object Marks the DistanceThreshold object identified by this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteDistanceThresholdAsync(Integer companyId, Long id)	Delete a single DistanceThreshold object Marks the DistanceThreshold object identified by this URL as deleted.
ArrayList<ErrorDetail>	deleteFirmClientLinkage(Integer id)	Delete a linkage This API marks a linkage between a firm and client as deleted.
Future<ArrayList<ErrorDetail>>	deleteFirmClientLinkageAsync(Integer id)	Delete a linkage This API marks a linkage between a firm and client as deleted.
ArrayList<ErrorDetail>	deleteItem(Integer companyId, Long id)	Delete a single item Deletes the item object at this URL.
Future<ArrayList<ErrorDetail>>	deleteItemAsync(Integer companyId, Long id)	Delete a single item Deletes the item object at this URL.
ArrayList<ErrorDetail>	deleteItemClassification(Integer companyId, Long itemId, Long id)	Delete a single item classification.
Future<ArrayList<ErrorDetail>>	deleteItemClassificationAsync(Integer companyId, Long itemId, Long id)	Delete a single item classification.
ArrayList<ErrorDetail>	deleteItemParameter(Integer companyId, Long itemId, Long id)	Delete a single item parameter Delete a single item parameter.
Future<ArrayList<ErrorDetail>>	deleteItemParameterAsync(Integer companyId, Long itemId, Long id)	Delete a single item parameter Delete a single item parameter.
ArrayList<ErrorDetail>	deleteItemTag(Integer companyId, Long itemId, Integer itemTagDetailId)	Delete item tag by id Deletes the `Tag` object of an Item at this URL.
Future<ArrayList<ErrorDetail>>	deleteItemTagAsync(Integer companyId, Long itemId, Integer itemTagDetailId)	Delete item tag by id Deletes the `Tag` object of an Item at this URL.
ArrayList<ErrorDetail>	deleteItemTags(Integer companyId, Long itemId)	Delete all item tags Deletes all `Tags` objects of an Item at this URL.
Future<ArrayList<ErrorDetail>>	deleteItemTagsAsync(Integer companyId, Long itemId)	Delete all item tags Deletes all `Tags` objects of an Item at this URL.
ArrayList<ErrorDetail>	deleteJurisdictionOverride(Integer accountId, Integer id)	Delete a single override Marks the item object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteJurisdictionOverrideAsync(Integer accountId, Integer id)	Delete a single override Marks the item object at this URL as deleted.
ArrayList<ErrorDetail>	deleteLicenseKey(Integer id, String licensekeyname)	Delete license key for this account by license key name Deletes the license key for this account using license key name.
Future<ArrayList<ErrorDetail>>	deleteLicenseKeyAsync(Integer id, String licensekeyname)	Delete license key for this account by license key name Deletes the license key for this account using license key name.
TransactionModel	deleteLines(String include, RemoveTransactionLineModel model)	Remove lines from an existing unlocked transaction Remove lines to an existing unlocked transaction.
Future<TransactionModel>	deleteLinesAsync(String include, RemoveTransactionLineModel model)	Remove lines from an existing unlocked transaction Remove lines to an existing unlocked transaction.
ArrayList<ErrorDetail>	deleteLocation(Integer companyId, Integer id)	Delete a single location Mark the location object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteLocationAsync(Integer companyId, Integer id)	Delete a single location Mark the location object at this URL as deleted.
ArrayList<ErrorDetail>	deleteLocationParameter(Integer companyId, Integer locationId, Long id)	Delete a single location parameter Delete a single location parameter.
Future<ArrayList<ErrorDetail>>	deleteLocationParameterAsync(Integer companyId, Integer locationId, Long id)	Delete a single location parameter Delete a single location parameter.
ArrayList<ErrorDetail>	deleteLookupFile(Integer accountId, String id)	Delete a lookup file Swagger Name: AvaTaxClient
Future<ArrayList<ErrorDetail>>	deleteLookupFileAsync(Integer accountId, String id)	Delete a lookup file Swagger Name: AvaTaxClient
ArrayList<ErrorDetail>	deleteNexus(Integer companyId, Integer id, Boolean cascadeDelete)	Delete a single nexus Marks the existing nexus object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteNexusAsync(Integer companyId, Integer id, Boolean cascadeDelete)	Delete a single nexus Marks the existing nexus object at this URL as deleted.
ArrayList<ErrorDetail>	deleteNexusParameter(Integer companyId, Integer nexusId, Long id)	Delete a single nexus parameter Delete a single nexus parameter.
Future<ArrayList<ErrorDetail>>	deleteNexusParameterAsync(Integer companyId, Integer nexusId, Long id)	Delete a single nexus parameter Delete a single nexus parameter.
ArrayList<ErrorDetail>	deleteNexusParameters(Integer companyId, Integer nexusId)	Delete all parameters for an nexus Delete all the parameters for a given nexus.
Future<ArrayList<ErrorDetail>>	deleteNexusParametersAsync(Integer companyId, Integer nexusId)	Delete all parameters for an nexus Delete all the parameters for a given nexus.
ArrayList<ErrorDetail>	deleteNoticeResponsibilityType(Integer responsibilityId)	Delete a tax notice responsibility type.
Future<ArrayList<ErrorDetail>>	deleteNoticeResponsibilityTypeAsync(Integer responsibilityId)	Delete a tax notice responsibility type.
ArrayList<ErrorDetail>	deleteNoticeRootCauseType(Integer rootCauseId)	Delete a tax notice root cause type.
Future<ArrayList<ErrorDetail>>	deleteNoticeRootCauseTypeAsync(Integer rootCauseId)	Delete a tax notice root cause type.
ArrayList<ErrorDetail>	deleteNotification(Long id)	Delete a single notification.
Future<ArrayList<ErrorDetail>>	deleteNotificationAsync(Long id)	Delete a single notification.
ArrayList<ErrorDetail>	deleteSetting(Integer companyId, Integer id)	Delete a single setting Mark the setting object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteSettingAsync(Integer companyId, Integer id)	Delete a single setting Mark the setting object at this URL as deleted.
ArrayList<ErrorDetail>	deleteSubscription(Integer accountId, Integer id)	Delete a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
Future<ArrayList<ErrorDetail>>	deleteSubscriptionAsync(Integer accountId, Integer id)	Delete a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
ArrayList<ErrorDetail>	deleteTaxCode(Integer companyId, Integer id)	Delete a single tax code Marks the existing TaxCode object at this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteTaxCodeAsync(Integer companyId, Integer id)	Delete a single tax code Marks the existing TaxCode object at this URL as deleted.
ArrayList<ErrorDetail>	deleteTaxRule(Integer companyId, Integer id)	Delete a single tax rule Mark the custom tax rule identified by this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteTaxRuleAsync(Integer companyId, Integer id)	Delete a single tax rule Mark the custom tax rule identified by this URL as deleted.
ArrayList<ErrorDetail>	deleteUPC(Integer companyId, Integer id)	Delete a single UPC Marks the UPC object identified by this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteUPCAsync(Integer companyId, Integer id)	Delete a single UPC Marks the UPC object identified by this URL as deleted.
ArrayList<ErrorDetail>	deleteUser(Integer id, Integer accountId)	Delete a single user Mark the user object identified by this URL as deleted.
Future<ArrayList<ErrorDetail>>	deleteUserAsync(Integer id, Integer accountId)	Delete a single user Mark the user object identified by this URL as deleted.
ArrayList<ErrorDetail>	deleteUserDefinedField(Integer companyId, Long id)	Delete a User Defined Field by User Defined Field id for a company.
Future<ArrayList<ErrorDetail>>	deleteUserDefinedFieldAsync(Integer companyId, Long id)	Delete a User Defined Field by User Defined Field id for a company.
Void	deregisterShipment(String companyCode, String transactionCode, String documentType)
Void	deregisterShipment(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Removes the transaction from consideration when evaluating regulations that span multiple transactions.
Future<Void>	deregisterShipmentAsync(String companyCode, String transactionCode, String documentType)
Future<Void>	deregisterShipmentAsync(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Removes the transaction from consideration when evaluating regulations that span multiple transactions.
NotificationModel	dismissNotification(Long id)	Mark a single notification as dismissed.
Future<NotificationModel>	dismissNotificationAsync(Long id)	Mark a single notification as dismissed.
String	downloadBatch(Integer companyId, Integer batchId, Integer id)	Download a single batch file Download a single batch file identified by this URL.
Future<String>	downloadBatchAsync(Integer companyId, Integer batchId, Integer id)	Download a single batch file Download a single batch file identified by this URL.
String	downloadCertificateImage(Integer companyId, Integer id, Integer page, CertificatePreviewType type)	Download an image for this certificate Download an image or PDF file for this certificate.
Future<String>	downloadCertificateImageAsync(Integer companyId, Integer id, Integer page, CertificatePreviewType type)	Download an image for this certificate Download an image or PDF file for this certificate.
String	downloadReport(Long id)	Download a report This API downloads the file associated with a report.
Future<String>	downloadReportAsync(Long id)	Download a report This API downloads the file associated with a report.
String	downloadTaxRatesByZipCode(Date date, String region)	Download a file listing tax rates by postal code Download a CSV file containing all five digit postal codes in the United States and their sales and use tax rates for tangible personal property.
Future<String>	downloadTaxRatesByZipCodeAsync(Date date, String region)	Download a file listing tax rates by postal code Download a CSV file containing all five digit postal codes in the United States and their sales and use tax rates for tangible personal property.
FundingConfigurationModel	fundingConfigurationByCompany(Integer companyId)	Check the funding configuration of a company This API is available by invitation only.
Future<FundingConfigurationModel>	fundingConfigurationByCompanyAsync(Integer companyId)	Check the funding configuration of a company This API is available by invitation only.
ArrayList<FundingConfigurationModel>	fundingConfigurationsByCompanyAndCurrency(Integer companyId, String currency)	Check the funding configuration of a company This API is available by invitation only.
Future<ArrayList<FundingConfigurationModel>>	fundingConfigurationsByCompanyAndCurrencyAsync(Integer companyId, String currency)	Check the funding configuration of a company This API is available by invitation only.
FundingStatusModel	fundingRequestStatus(Integer id)	Retrieve status about a funding setup request This API is available by invitation only.
Future<FundingStatusModel>	fundingRequestStatusAsync(Integer id)	Retrieve status about a funding setup request This API is available by invitation only.
AccountModel	getAccount(Integer id, String include)	Retrieve a single account Get the account object identified by this URL.
Future<AccountModel>	getAccountAsync(Integer id, String include)	Retrieve a single account Get the account object identified by this URL.
ArrayList<AccountConfigurationModel>	getAccountConfiguration(Integer id)	Get configuration settings for this account Retrieve a list of all configuration settings tied to this account.
Future<ArrayList<AccountConfigurationModel>>	getAccountConfigurationAsync(Integer id)	Get configuration settings for this account Retrieve a list of all configuration settings tied to this account.
AvaFileFormModel	getAvaFileForm(Integer id)	Retrieve a single AvaFileForm Get the AvaFileForm object identified by this URL.
Future<AvaFileFormModel>	getAvaFileFormAsync(Integer id)	Retrieve a single AvaFileForm Get the AvaFileForm object identified by this URL.
BatchModel	getBatch(Integer companyId, Integer id)	Retrieve a single batch Get the batch object identified by this URL.
Future<BatchModel>	getBatchAsync(Integer companyId, Integer id)	Retrieve a single batch Get the batch object identified by this URL.
CertExpressInvitationModel	getCertExpressInvitation(Integer companyId, String customerCode, Integer id, String include)	Retrieve a single CertExpress invitation Retrieve an existing CertExpress invitation sent to a customer.
Future<CertExpressInvitationModel>	getCertExpressInvitationAsync(Integer companyId, String customerCode, Integer id, String include)	Retrieve a single CertExpress invitation Retrieve an existing CertExpress invitation sent to a customer.
CertificateModel	getCertificate(Integer companyId, Integer id, String include)	Retrieve a single certificate Get the current certificate identified by this URL.
Future<CertificateModel>	getCertificateAsync(Integer companyId, Integer id, String include)	Retrieve a single certificate Get the current certificate identified by this URL.
ProvisionStatusModel	getCertificateSetup(Integer companyId)	Check a company's exemption certificate status.
Future<ProvisionStatusModel>	getCertificateSetupAsync(Integer companyId)	Check a company's exemption certificate status.
FetchResult<ItemTaxCodeClassificationRequestStatusOutputModel>	getClassificationStatus(Integer companyId, Boolean includeClassificationDetails, String filter, Integer top, Integer skip, String orderBy)	Get the status of classification requests for a company Get the status of tax code classification requests for a company.
Future<FetchResult<ItemTaxCodeClassificationRequestStatusOutputModel>>	getClassificationStatusAsync(Integer companyId, Boolean includeClassificationDetails, String filter, Integer top, Integer skip, String orderBy)	Get the status of classification requests for a company Get the status of tax code classification requests for a company.
CompanyModel	getCompany(Integer id, String include)	Retrieve a single company Get the company object identified by this URL.
Future<CompanyModel>	getCompanyAsync(Integer id, String include)	Retrieve a single company Get the company object identified by this URL.
ArrayList<CompanyConfigurationModel>	getCompanyConfiguration(Integer id)	Get configuration settings for this company Retrieve a list of all configuration settings tied to this company.
Future<ArrayList<CompanyConfigurationModel>>	getCompanyConfigurationAsync(Integer id)	Get configuration settings for this company Retrieve a list of all configuration settings tied to this company.
FetchResult<AdvancedRuleLookupFileModel>	getCompanyLookupFiles(Integer accountId, Integer companyId)	Get the lookup files for a company Swagger Name: AvaTaxClient
Future<FetchResult<AdvancedRuleLookupFileModel>>	getCompanyLookupFilesAsync(Integer accountId, Integer companyId)	Get the lookup files for a company Swagger Name: AvaTaxClient
CompanyParameterDetailModel	getCompanyParameterDetail(Integer companyId, Integer id)	Retrieve a single company parameter Retrieves a single parameter of a company.
Future<CompanyParameterDetailModel>	getCompanyParameterDetailAsync(Integer companyId, Integer id)	Retrieve a single company parameter Retrieves a single parameter of a company.
ContactModel	getContact(Integer companyId, Integer id)	Retrieve a single contact Get the contact object identified by this URL.
Future<ContactModel>	getContactAsync(Integer companyId, Integer id)	Retrieve a single contact Get the contact object identified by this URL.
FetchResult<HsCodeModel>	getCrossBorderCode(String country, String hsCode)	Lists all parents of an HS Code.
Future<FetchResult<HsCodeModel>>	getCrossBorderCodeAsync(String country, String hsCode)	Lists all parents of an HS Code.
CustomerModel	getCustomer(Integer companyId, String customerCode, String include)	Retrieve a single customer Retrieve the customer identified by this URL.
Future<CustomerModel>	getCustomerAsync(Integer companyId, String customerCode, String include)	Retrieve a single customer Retrieve the customer identified by this URL.
DataSourceModel	getDataSourceById(Integer companyId, Integer id)	Get data source by data source id Retrieve the data source by its unique ID number.
Future<DataSourceModel>	getDataSourceByIdAsync(Integer companyId, Integer id)	Get data source by data source id Retrieve the data source by its unique ID number.
CompanyDistanceThresholdModel	getDistanceThreshold(Integer companyId, Long id)	Retrieve a single DistanceThreshold Retrieves a single DistanceThreshold object defined by this URL.
Future<CompanyDistanceThresholdModel>	getDistanceThresholdAsync(Integer companyId, Long id)	Retrieve a single DistanceThreshold Retrieves a single DistanceThreshold object defined by this URL.
String	getFilingStatus(Integer id)	Get this company's filing status Retrieve the current filing status of this company.
Future<String>	getFilingStatusAsync(Integer id)	Get this company's filing status Retrieve the current filing status of this company.
FirmClientLinkageOutputModel	getFirmClientLinkage(Integer id)	Get linkage between a firm and client by id This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
Future<FirmClientLinkageOutputModel>	getFirmClientLinkageAsync(Integer id)	Get linkage between a firm and client by id This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
ItemModel	getItem(Integer companyId, Long id, String include)	Retrieve a single item Get the `Item` object identified by this URL.
Future<ItemModel>	getItemAsync(Integer companyId, Long id, String include)	Retrieve a single item Get the `Item` object identified by this URL.
ItemClassificationOutputModel	getItemClassification(Integer companyId, Long itemId, Long id)	Retrieve a single item classification.
Future<ItemClassificationOutputModel>	getItemClassificationAsync(Integer companyId, Long itemId, Long id)	Retrieve a single item classification.
ItemParameterModel	getItemParameter(Integer companyId, Long itemId, Long id)	Retrieve a single item parameter Retrieve a single item parameter.
Future<ItemParameterModel>	getItemParameterAsync(Integer companyId, Long itemId, Long id)	Retrieve a single item parameter Retrieve a single item parameter.
FetchResult<ItemTagDetailModel>	getItemTags(Integer companyId, Long itemId, String filter, Integer top, Integer skip)	Retrieve tags for an item Get the `Tag` objects of an Item identified by this URL.
Future<FetchResult<ItemTagDetailModel>>	getItemTagsAsync(Integer companyId, Long itemId, String filter, Integer top, Integer skip)	Retrieve tags for an item Get the `Tag` objects of an Item identified by this URL.
JurisdictionOverrideModel	getJurisdictionOverride(Integer accountId, Integer id)	Retrieve a single override Get the item object identified by this URL.
Future<JurisdictionOverrideModel>	getJurisdictionOverrideAsync(Integer accountId, Integer id)	Retrieve a single override Get the item object identified by this URL.
AccountLicenseKeyModel	getLicenseKey(Integer id, String licensekeyname)	Retrieve license key by license key name ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
Future<AccountLicenseKeyModel>	getLicenseKeyAsync(Integer id, String licensekeyname)	Retrieve license key by license key name ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
ArrayList<AccountLicenseKeyModel>	getLicenseKeys(Integer id)	Retrieve all license keys for this account Gets list of all the license keys used by the account.
Future<ArrayList<AccountLicenseKeyModel>>	getLicenseKeysAsync(Integer id)	Retrieve all license keys for this account Gets list of all the license keys used by the account.
LocationModel	getLocation(Integer companyId, Integer id, String include)	Retrieve a single location Get the location object identified by this URL.
Future<LocationModel>	getLocationAsync(Integer companyId, Integer id, String include)	Retrieve a single location Get the location object identified by this URL.
LocationParameterModel	getLocationParameter(Integer companyId, Integer locationId, Long id)	Retrieve a single company location parameter Retrieve a single location parameter.
Future<LocationParameterModel>	getLocationParameterAsync(Integer companyId, Integer locationId, Long id)	Retrieve a single company location parameter Retrieve a single location parameter.
FetchResult<SkyscraperStatusModel>	getLoginVerifierByForm(String form, String filter, Integer top, Integer skip, String orderBy)	Test whether a form supports online login verification This API is intended to be useful to identify whether the user should be allowed Swagger Name: AvaTaxClient
Future<FetchResult<SkyscraperStatusModel>>	getLoginVerifierByFormAsync(String form, String filter, Integer top, Integer skip, String orderBy)	Test whether a form supports online login verification This API is intended to be useful to identify whether the user should be allowed Swagger Name: AvaTaxClient
AdvancedRuleLookupFileModel	getLookupFile(Integer accountId, String id)	Get a lookup file for an accountId and companyLookupFileId Swagger Name: AvaTaxClient
Future<AdvancedRuleLookupFileModel>	getLookupFileAsync(Integer accountId, String id)	Get a lookup file for an accountId and companyLookupFileId Swagger Name: AvaTaxClient
MultiDocumentModel	getMultiDocumentTransactionByCodeAndType(String code, DocumentType type, String include)	Retrieve a MultiDocument transaction Get the current MultiDocument transaction identified by this URL.
Future<MultiDocumentModel>	getMultiDocumentTransactionByCodeAndTypeAsync(String code, DocumentType type, String include)	Retrieve a MultiDocument transaction Get the current MultiDocument transaction identified by this URL.
MultiDocumentModel	getMultiDocumentTransactionById(Long id, String include)	Retrieve a MultiDocument transaction by ID Get the unique MultiDocument transaction identified by this URL.
Future<MultiDocumentModel>	getMultiDocumentTransactionByIdAsync(Long id, String include)	Retrieve a MultiDocument transaction by ID Get the unique MultiDocument transaction identified by this URL.
SubscriptionModel	getMySubscription(String serviceTypeId)	Checks if the current user is subscribed to a specific service Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
Future<SubscriptionModel>	getMySubscriptionAsync(String serviceTypeId)	Checks if the current user is subscribed to a specific service Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
NexusModel	getNexus(Integer companyId, Integer id, String include)	Retrieve a single nexus Get the nexus object identified by this URL.
Future<NexusModel>	getNexusAsync(Integer companyId, Integer id, String include)	Retrieve a single nexus Get the nexus object identified by this URL.
NexusByTaxFormModel	getNexusByFormCode(Integer companyId, String formCode, String include)	List company nexus related to a tax form Retrieves a list of nexus related to a tax form.
Future<NexusByTaxFormModel>	getNexusByFormCodeAsync(Integer companyId, String formCode, String include)	List company nexus related to a tax form Retrieves a list of nexus related to a tax form.
NexusParameterDetailModel	getNexusParameter(Integer companyId, Integer nexusId, Long id)	Retrieve a single nexus parameter Retrieve a single nexus parameter.
Future<NexusParameterDetailModel>	getNexusParameterAsync(Integer companyId, Integer nexusId, Long id)	Retrieve a single nexus parameter Retrieve a single nexus parameter.
NotificationModel	getNotification(Long id)	Retrieve a single notification.
Future<NotificationModel>	getNotificationAsync(Long id)	Retrieve a single notification.
ItemPremiumClassificationOutputModel	getPremiumClassification(Integer companyId, String itemCode, String systemCode)	Retrieve premium classification for a company's item based on its ItemCode and SystemCode.
Future<ItemPremiumClassificationOutputModel>	getPremiumClassificationAsync(Integer companyId, String itemCode, String systemCode)	Retrieve premium classification for a company's item based on its ItemCode and SystemCode.
ReportModel	getReport(Long id)	Retrieve a single report Retrieve a single report by its unique ID number.
Future<ReportModel>	getReportAsync(Long id)	Retrieve a single report Retrieve a single report by its unique ID number.
SettingModel	getSetting(Integer companyId, Integer id)	Retrieve a single setting Get a single setting object by its unique ID.
Future<SettingModel>	getSettingAsync(Integer companyId, Integer id)	Retrieve a single setting Get a single setting object by its unique ID.
SubscriptionModel	getSubscription(Integer accountId, Integer id)	Retrieve a single subscription Get the subscription object identified by this URL.
Future<SubscriptionModel>	getSubscriptionAsync(Integer accountId, Integer id)	Retrieve a single subscription Get the subscription object identified by this URL.
TaxCodeModel	getTaxCode(Integer companyId, Integer id)	Retrieve a single tax code Get the taxcode object identified by this URL.
Future<TaxCodeModel>	getTaxCodeAsync(Integer companyId, Integer id)	Retrieve a single tax code Get the taxcode object identified by this URL.
FetchResult<ItemTaxCodeRecommendationsOutputModel>	getTaxCodeRecommendations(Integer companyId, Integer requestId, String filter, Integer top, Integer skip, String orderBy)	Get tax code recommendations Get tax code recommendations.
Future<FetchResult<ItemTaxCodeRecommendationsOutputModel>>	getTaxCodeRecommendationsAsync(Integer companyId, Integer requestId, String filter, Integer top, Integer skip, String orderBy)	Get tax code recommendations Get tax code recommendations.
TaxRuleModel	getTaxRule(Integer companyId, Integer id)	Retrieve a single tax rule Get the taxrule object identified by this URL.
Future<TaxRuleModel>	getTaxRuleAsync(Integer companyId, Integer id)	Retrieve a single tax rule Get the taxrule object identified by this URL.
TransactionModel	getTransactionByCode(String companyCode, String transactionCode, DocumentType documentType, String include)	Retrieve a single transaction by code Get the current transaction identified by this company code, transaction code, and document type.
TransactionModel	getTransactionByCodeAndType(String companyCode, String transactionCode, DocumentType documentType, String include)	Retrieve a single transaction by code DEPRECATED: Please use the `GetTransactionByCode` API instead.
Future<TransactionModel>	getTransactionByCodeAndTypeAsync(String companyCode, String transactionCode, DocumentType documentType, String include)	Retrieve a single transaction by code DEPRECATED: Please use the `GetTransactionByCode` API instead.
Future<TransactionModel>	getTransactionByCodeAsync(String companyCode, String transactionCode, DocumentType documentType, String include)	Retrieve a single transaction by code Get the current transaction identified by this company code, transaction code, and document type.
TransactionModel	getTransactionById(Long id, String include)	Retrieve a single transaction by ID Get the unique transaction identified by this URL.
Future<TransactionModel>	getTransactionByIdAsync(Long id, String include)	Retrieve a single transaction by ID Get the unique transaction identified by this URL.
UPCModel	getUPC(Integer companyId, Integer id)	Retrieve a single UPC Get the UPC object identified by this URL.
Future<UPCModel>	getUPCAsync(Integer companyId, Integer id)	Retrieve a single UPC Get the UPC object identified by this URL.
UserModel	getUser(Integer id, Integer accountId, String include)	Retrieve a single user Get the user object identified by this URL.
Future<UserModel>	getUserAsync(Integer id, Integer accountId, String include)	Retrieve a single user Get the user object identified by this URL.
UserEntitlementModel	getUserEntitlements(Integer id, Integer accountId)	Retrieve all entitlements for a single user Return a list of all entitlements to which this user has rights to access.
Future<UserEntitlementModel>	getUserEntitlementsAsync(Integer id, Integer accountId)	Retrieve all entitlements for a single user Return a list of all entitlements to which this user has rights to access.
ArrayList<ReportModel>	initiateExportDocumentLineReport(Integer companyId, ExportDocumentLineModel model)	Initiate an ExportDocumentLine report task Begins running an `ExportDocumentLine` report task and returns the identity of the report.
Future<ArrayList<ReportModel>>	initiateExportDocumentLineReportAsync(Integer companyId, ExportDocumentLineModel model)	Initiate an ExportDocumentLine report task Begins running an `ExportDocumentLine` report task and returns the identity of the report.
FetchResult<CertificateAttributeModel>	linkAttributesToCertificate(Integer companyId, Integer id, ArrayList<CertificateAttributeModel> model)	Link attributes to a certificate Link one or many attributes to a certificate.
Future<FetchResult<CertificateAttributeModel>>	linkAttributesToCertificateAsync(Integer companyId, Integer id, ArrayList<CertificateAttributeModel> model)	Link attributes to a certificate Link one or many attributes to a certificate.
FetchResult<CustomerAttributeModel>	linkAttributesToCustomer(Integer companyId, String customerCode, ArrayList<CustomerAttributeModel> model)	Link attributes to a customer Link one or many attributes to a customer.
Future<FetchResult<CustomerAttributeModel>>	linkAttributesToCustomerAsync(Integer companyId, String customerCode, ArrayList<CustomerAttributeModel> model)	Link attributes to a customer Link one or many attributes to a customer.
FetchResult<CertificateModel>	linkCertificatesToCustomer(Integer companyId, String customerCode, LinkCertificatesModel model)	Link certificates to a customer Link one or more certificates to a customer.
Future<FetchResult<CertificateModel>>	linkCertificatesToCustomerAsync(Integer companyId, String customerCode, LinkCertificatesModel model)	Link certificates to a customer Link one or more certificates to a customer.
FetchResult<CustomerModel>	linkCustomersToCertificate(Integer companyId, Integer id, LinkCustomersModel model)	Link customers to a certificate Link one or more customers to an existing certificate.
Future<FetchResult<CustomerModel>>	linkCustomersToCertificateAsync(Integer companyId, Integer id, LinkCustomersModel model)	Link customers to a certificate Link one or more customers to an existing certificate.
CustomerModel	linkShipToCustomersToBillCustomer(Integer companyId, String code, LinkCustomersModel model)	Link two customer records together Links a Ship-To customer record with a Bill-To customer record.
Future<CustomerModel>	linkShipToCustomersToBillCustomerAsync(Integer companyId, String code, LinkCustomersModel model)	Link two customer records together Links a Ship-To customer record with a Bill-To customer record.
ArrayList<ACHEntryDetailModel>	listACHEntryDetailsForCompany(Integer id, Integer periodyear, Integer periodmonth)	Get ACH entry detail report for company and period This API is available by invitation only.
Future<ArrayList<ACHEntryDetailModel>>	listACHEntryDetailsForCompanyAsync(Integer id, Integer periodyear, Integer periodmonth)	Get ACH entry detail report for company and period This API is available by invitation only.
FetchResult<MarketplaceModel>	listAllMarketplaceLocations(String filter, Integer top, Integer skip, String orderBy)	List all market place locations.
Future<FetchResult<MarketplaceModel>>	listAllMarketplaceLocationsAsync(String filter, Integer top, Integer skip, String orderBy)	List all market place locations.
FetchResult<CertificateAttributeModel>	listAttributesForCertificate(Integer companyId, Integer id)	List all attributes applied to this certificate Retrieve the list of attributes that are linked to this certificate.
Future<FetchResult<CertificateAttributeModel>>	listAttributesForCertificateAsync(Integer companyId, Integer id)	List all attributes applied to this certificate Retrieve the list of attributes that are linked to this certificate.
FetchResult<CustomerAttributeModel>	listAttributesForCustomer(Integer companyId, String customerCode)	Retrieve a customer's attributes Retrieve the attributes linked to the customer identified by this URL.
Future<FetchResult<CustomerAttributeModel>>	listAttributesForCustomerAsync(Integer companyId, String customerCode)	Retrieve a customer's attributes Retrieve the attributes linked to the customer identified by this URL.
FetchResult<AvaFileFormModel>	listAvaFileForms(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of the AvaFile Forms available This API is deprecated.
Future<FetchResult<AvaFileFormModel>>	listAvaFileFormsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of the AvaFile Forms available This API is deprecated.
FetchResult<BatchModel>	listBatchesByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all batches for this company List all batch objects attached to the specified company.
Future<FetchResult<BatchModel>>	listBatchesByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all batches for this company List all batch objects attached to the specified company.
FetchResult<CertExpressInvitationModel>	listCertExpressInvitations(Integer companyId, String include, String filter, Integer top, Integer skip, String orderBy)	List CertExpress invitations Retrieve CertExpress invitations sent by this company.
Future<FetchResult<CertExpressInvitationModel>>	listCertExpressInvitationsAsync(Integer companyId, String include, String filter, Integer top, Integer skip, String orderBy)	List CertExpress invitations Retrieve CertExpress invitations sent by this company.
FetchResult<CertificateAttributeModel>	listCertificateAttributes(Integer companyid, String filter, Integer top, Integer skip, String orderBy)	List certificate attributes used by a company List the certificate attributes defined by a company either specified by the user or the user's default company.
Future<FetchResult<CertificateAttributeModel>>	listCertificateAttributesAsync(Integer companyid, String filter, Integer top, Integer skip, String orderBy)	List certificate attributes used by a company List the certificate attributes defined by a company either specified by the user or the user's default company.
FetchResult<ExemptionReasonModel>	listCertificateExemptReasons(String filter, Integer top, Integer skip, String orderBy)	List the certificate exempt reasons defined by a company List the certificate exempt reasons defined by a company.
Future<FetchResult<ExemptionReasonModel>>	listCertificateExemptReasonsAsync(String filter, Integer top, Integer skip, String orderBy)	List the certificate exempt reasons defined by a company List the certificate exempt reasons defined by a company.
FetchResult<ExposureZoneModel>	listCertificateExposureZones(String filter, Integer top, Integer skip, String orderBy)	List certificate exposure zones used by a company List the certificate exposure zones defined by a company.
Future<FetchResult<ExposureZoneModel>>	listCertificateExposureZonesAsync(String filter, Integer top, Integer skip, String orderBy)	List certificate exposure zones used by a company List the certificate exposure zones defined by a company.
FetchResult<CertificateModel>	listCertificatesForCustomer(Integer companyId, String customerCode, String include, String filter, Integer top, Integer skip, String orderBy)	List certificates linked to a customer List all certificates linked to a customer.
Future<FetchResult<CertificateModel>>	listCertificatesForCustomerAsync(Integer companyId, String customerCode, String include, String filter, Integer top, Integer skip, String orderBy)	List certificates linked to a customer List all certificates linked to a customer.
FetchResult<ClassificationParameterUsageMapModel>	listClassificationParametersUsage(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
Future<FetchResult<ClassificationParameterUsageMapModel>>	listClassificationParametersUsageAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
FetchResult<CommunicationsTSPairModel>	listCommunicationsServiceTypes(Integer id, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of communications service types Swagger Name: AvaTaxClient
Future<FetchResult<CommunicationsTSPairModel>>	listCommunicationsServiceTypesAsync(Integer id, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of communications service types Swagger Name: AvaTaxClient
FetchResult<CommunicationsTransactionTypeModel>	listCommunicationsTransactionTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of communications transactiontypes Returns full list of communications transaction types which Swagger Name: AvaTaxClient
Future<FetchResult<CommunicationsTransactionTypeModel>>	listCommunicationsTransactionTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of communications transactiontypes Returns full list of communications transaction types which Swagger Name: AvaTaxClient
FetchResult<CommunicationsTSPairModel>	listCommunicationsTSPairs(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of communications transaction/service type pairs Returns full list of communications transaction/service type pairs which Swagger Name: AvaTaxClient
Future<FetchResult<CommunicationsTSPairModel>>	listCommunicationsTSPairsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of communications transaction/service type pairs Returns full list of communications transaction/service type pairs which Swagger Name: AvaTaxClient
FetchResult<CompanyParameterDetailModel>	listCompanyParameterDetails(Integer companyId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for a company Retrieve all parameters of a company.
Future<FetchResult<CompanyParameterDetailModel>>	listCompanyParameterDetailsAsync(Integer companyId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for a company Retrieve all parameters of a company.
FetchResult<ContactModel>	listContactsByCompany(Integer companyId, String filter, Integer top, Integer skip, String orderBy)	Retrieve contacts for this company List all contact objects assigned to this company.
Future<FetchResult<ContactModel>>	listContactsByCompanyAsync(Integer companyId, String filter, Integer top, Integer skip, String orderBy)	Retrieve contacts for this company List all contact objects assigned to this company.
FetchResult<IsoCountryModel>	listCountries(String filter, Integer top, Integer skip, String orderBy)	List all ISO 3166 countries Returns a list of all ISO 3166 country codes, and their US English friendly names.
Future<FetchResult<IsoCountryModel>>	listCountriesAsync(String filter, Integer top, Integer skip, String orderBy)	List all ISO 3166 countries Returns a list of all ISO 3166 country codes, and their US English friendly names.
FetchResult<CoverLetterModel>	listCoverLetters(String filter, Integer top, Integer skip, String orderBy)	List certificate exposure zones used by a company List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
Future<FetchResult<CoverLetterModel>>	listCoverLettersAsync(String filter, Integer top, Integer skip, String orderBy)	List certificate exposure zones used by a company List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
FetchResult<HsCodeModel>	listCrossBorderCodes(String country, String hsCode, String filter, Integer top, Integer skip, String orderBy)	Lists the next level of HS Codes given a destination country and HS Code prefix.
Future<FetchResult<HsCodeModel>>	listCrossBorderCodesAsync(String country, String hsCode, String filter, Integer top, Integer skip, String orderBy)	Lists the next level of HS Codes given a destination country and HS Code prefix.
FetchResult<HsCodeModel>	listCrossBorderSections()	List top level HS Code Sections.
Future<FetchResult<HsCodeModel>>	listCrossBorderSectionsAsync()	List top level HS Code Sections.
FetchResult<CurrencyModel>	listCurrencies(String filter, Integer top, Integer skip, String orderBy)	List all ISO 4217 currencies supported by AvaTax.
Future<FetchResult<CurrencyModel>>	listCurrenciesAsync(String filter, Integer top, Integer skip, String orderBy)	List all ISO 4217 currencies supported by AvaTax.
FetchResult<CustomerModel>	listCustomersForCertificate(Integer companyId, Integer id, String include)	List customers linked to this certificate List all customers linked to this certificate.
Future<FetchResult<CustomerModel>>	listCustomersForCertificateAsync(Integer companyId, Integer id, String include)	List customers linked to this certificate List all customers linked to this certificate.
FetchResult<DataSourceModel>	listDataSources(Integer companyId, String filter, Integer top, Integer skip, String orderBy)	Retrieve all datasources for this company Gets multiple datasource objects for a given company.
Future<FetchResult<DataSourceModel>>	listDataSourcesAsync(Integer companyId, String filter, Integer top, Integer skip, String orderBy)	Retrieve all datasources for this company Gets multiple datasource objects for a given company.
FetchResult<CompanyDistanceThresholdModel>	listDistanceThresholds(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all DistanceThresholds for this company.
Future<FetchResult<CompanyDistanceThresholdModel>>	listDistanceThresholdsAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all DistanceThresholds for this company.
FetchResult<EntityUseCodeModel>	listEntityUseCodes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported entity use codes Returns the full list of Avalara-supported entity use codes.
Future<FetchResult<EntityUseCodeModel>>	listEntityUseCodesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported entity use codes Returns the full list of Avalara-supported entity use codes.
FetchResult<FilingFrequencyModel>	listFilingFrequencies(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported filing frequencies.
Future<FetchResult<FilingFrequencyModel>>	listFilingFrequenciesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported filing frequencies.
FetchResult<FirmClientLinkageOutputModel>	listFirmClientLinkage(String filter)	List client linkages for a firm or client This API enables the firm or account users to request the associated linkages to the account.
Future<FetchResult<FirmClientLinkageOutputModel>>	listFirmClientLinkageAsync(String filter)	List client linkages for a firm or client This API enables the firm or account users to request the associated linkages to the account.
ArrayList<FundingStatusModel>	listFundingRequestsByCompany(Integer id)	Check managed returns funding status for a company This API is available by invitation only.
Future<ArrayList<FundingStatusModel>>	listFundingRequestsByCompanyAsync(Integer id)	Check managed returns funding status for a company This API is available by invitation only.
FetchResult<ItemRestrictionOutputModel>	listImportRestrictions(Integer companyId, String itemCode, String countryOfImport, Integer top, Integer skip, String orderBy)	Retrieve Restrictions for Item by CountryOfImport Retrieve Restrictions for Item by CountryOfImport.
Future<FetchResult<ItemRestrictionOutputModel>>	listImportRestrictionsAsync(Integer companyId, String itemCode, String countryOfImport, Integer top, Integer skip, String orderBy)	Retrieve Restrictions for Item by CountryOfImport Retrieve Restrictions for Item by CountryOfImport.
FetchResult<ItemClassificationOutputModel>	listItemClassifications(Integer companyId, Long itemId, String filter, Integer top, Integer skip, String orderBy)	Retrieve classifications for an item.
Future<FetchResult<ItemClassificationOutputModel>>	listItemClassificationsAsync(Integer companyId, Long itemId, String filter, Integer top, Integer skip, String orderBy)	Retrieve classifications for an item.
FetchResult<ItemParameterModel>	listItemParameters(Integer companyId, Long itemId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for an item List parameters for an item.
Future<FetchResult<ItemParameterModel>>	listItemParametersAsync(Integer companyId, Long itemId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for an item List parameters for an item.
FetchResult<ItemModel>	listItemsByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy, String tagName)	Retrieve items for this company List all items defined for the current company.
Future<FetchResult<ItemModel>>	listItemsByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy, String tagName)	Retrieve items for this company List all items defined for the current company.
FetchResult<JurisdictionOverrideModel>	listJurisdictionOverridesByAccount(Integer accountId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve overrides for this account List all jurisdiction override objects defined for this account.
Future<FetchResult<JurisdictionOverrideModel>>	listJurisdictionOverridesByAccountAsync(Integer accountId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve overrides for this account List all jurisdiction override objects defined for this account.
FetchResult<JurisdictionModel>	listJurisdictions(String filter, Integer top, Integer skip, String orderBy)	List jurisdictions based on the filter provided Returns a list of all Avalara-supported taxing jurisdictions.
Future<FetchResult<JurisdictionModel>>	listJurisdictionsAsync(String filter, Integer top, Integer skip, String orderBy)	List jurisdictions based on the filter provided Returns a list of all Avalara-supported taxing jurisdictions.
FetchResult<JurisdictionOverrideModel>	listJurisdictionsByAddress(String line1, String line2, String line3, String city, String region, String postalCode, String country, String filter, Integer top, Integer skip, String orderBy)	List jurisdictions near a specific address Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
Future<FetchResult<JurisdictionOverrideModel>>	listJurisdictionsByAddressAsync(String line1, String line2, String line3, String city, String region, String postalCode, String country, String filter, Integer top, Integer skip, String orderBy)	List jurisdictions near a specific address Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
FetchResult<JurisdictionRateTypeTaxTypeMappingModel>	listJurisdictionsByRateTypeTaxTypeMapping(String country, String taxTypeId, String taxSubTypeId, String rateTypeId, String filter, Integer top, Integer skip, String orderBy)	List jurisdictions based on the TaxType, TaxSubType and RateType provided Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType.
Future<FetchResult<JurisdictionRateTypeTaxTypeMappingModel>>	listJurisdictionsByRateTypeTaxTypeMappingAsync(String country, String taxTypeId, String taxSubTypeId, String rateTypeId, String filter, Integer top, Integer skip, String orderBy)	List jurisdictions based on the TaxType, TaxSubType and RateType provided Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType.
FetchResult<LocationParameterModel>	listLocationParameters(Integer companyId, Integer locationId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for a location List parameters for a location.
Future<FetchResult<LocationParameterModel>>	listLocationParametersAsync(Integer companyId, Integer locationId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for a location List parameters for a location.
FetchResult<LocationQuestionModel>	listLocationQuestionsByAddress(String line1, String line2, String line3, String city, String region, String postalCode, String country, BigDecimal latitude, BigDecimal longitude, String filter, Integer top, Integer skip, String orderBy)	Retrieve the list of questions that are required for a tax location Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
Future<FetchResult<LocationQuestionModel>>	listLocationQuestionsByAddressAsync(String line1, String line2, String line3, String city, String region, String postalCode, String country, BigDecimal latitude, BigDecimal longitude, String filter, Integer top, Integer skip, String orderBy)	Retrieve the list of questions that are required for a tax location Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
FetchResult<LocationModel>	listLocationsByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve locations for this company List all location objects defined for this company.
Future<FetchResult<LocationModel>>	listLocationsByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve locations for this company List all location objects defined for this company.
FetchResult<SkyscraperStatusModel>	listLoginVerifiers(String filter, Integer top, Integer skip, String orderBy)	List all forms where logins can be verified automatically List all forms where logins can be verified automatically.
Future<FetchResult<SkyscraperStatusModel>>	listLoginVerifiersAsync(String filter, Integer top, Integer skip, String orderBy)	List all forms where logins can be verified automatically List all forms where logins can be verified automatically.
FetchResult<MarketplaceLocationModel>	listMarketplaceLocations(String marketplaceId, Integer top, Integer skip, String orderBy)	Retrieve the list of locations for a marketplace.
Future<FetchResult<MarketplaceLocationModel>>	listMarketplaceLocationsAsync(String marketplaceId, Integer top, Integer skip, String orderBy)	Retrieve the list of locations for a marketplace.
FetchResult<MrsCompanyModel>	listMrsCompanies()	Retrieve a list of MRS Companies with account This API is available by invitation only.
Future<FetchResult<MrsCompanyModel>>	listMrsCompaniesAsync()	Retrieve a list of MRS Companies with account This API is available by invitation only.
FetchResult<MultiDocumentModel>	listMultiDocumentTransactions(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all MultiDocument transactions List all MultiDocument transactions within this account.
Future<FetchResult<MultiDocumentModel>>	listMultiDocumentTransactionsAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all MultiDocument transactions List all MultiDocument transactions within this account.
FetchResult<SubscriptionModel>	listMySubscriptions()	List all services to which the current user is subscribed Returns the list of all subscriptions enabled for the currently logged in user.
Future<FetchResult<SubscriptionModel>>	listMySubscriptionsAsync()	List all services to which the current user is subscribed Returns the list of all subscriptions enabled for the currently logged in user.
FetchResult<NexusModel>	listNexus(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for all countries and regions.
Future<FetchResult<NexusModel>>	listNexusAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for all countries and regions.
FetchResult<NexusModel>	listNexusByAddress(String line1, String line2, String line3, String city, String region, String postalCode, String country, String filter, Integer top, Integer skip, String orderBy)	List all nexus that apply to a specific address.
Future<FetchResult<NexusModel>>	listNexusByAddressAsync(String line1, String line2, String line3, String city, String region, String postalCode, String country, String filter, Integer top, Integer skip, String orderBy)	List all nexus that apply to a specific address.
FetchResult<NexusModel>	listNexusByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve nexus for this company List all nexus objects defined for this company.
FetchResult<NexusModel>	listNexusByCompanyAndTaxTypeGroup(Integer companyId, String taxTypeGroup, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve nexus for this company By TaxTypeGroup List all nexus objects defined for this company filtered by TaxTypeGroup.
Future<FetchResult<NexusModel>>	listNexusByCompanyAndTaxTypeGroupAsync(Integer companyId, String taxTypeGroup, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve nexus for this company By TaxTypeGroup List all nexus objects defined for this company filtered by TaxTypeGroup.
Future<FetchResult<NexusModel>>	listNexusByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve nexus for this company List all nexus objects defined for this company.
FetchResult<NexusModel>	listNexusByCountry(String country, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for a country.
FetchResult<NexusModel>	listNexusByCountryAndRegion(String country, String region, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for a country and region.
Future<FetchResult<NexusModel>>	listNexusByCountryAndRegionAsync(String country, String region, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for a country and region.
Future<FetchResult<NexusModel>>	listNexusByCountryAsync(String country, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for a country.
NexusByTaxFormModel	listNexusByFormCode(String formCode)	List nexus related to a tax form Retrieves a list of nexus related to a tax form.
Future<NexusByTaxFormModel>	listNexusByFormCodeAsync(String formCode)	List nexus related to a tax form Retrieves a list of nexus related to a tax form.
FetchResult<NexusModel>	listNexusByTaxTypeGroup(String taxTypeGroup, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for a tax type group.
Future<FetchResult<NexusModel>>	listNexusByTaxTypeGroupAsync(String taxTypeGroup, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported nexus for a tax type group.
FetchResult<NexusParameterDetailModel>	listNexusParameters(Integer companyId, Integer nexusId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for a nexus List parameters for a nexus.
Future<FetchResult<NexusParameterDetailModel>>	listNexusParametersAsync(Integer companyId, Integer nexusId, String filter, Integer top, Integer skip, String orderBy)	Retrieve parameters for a nexus List parameters for a nexus.
FetchResult<NexusTaxTypeGroupModel>	listNexusTaxTypeGroups(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of nexus tax type groups Returns the full list of Avalara-supported nexus tax type groups Swagger Name: AvaTaxClient
Future<FetchResult<NexusTaxTypeGroupModel>>	listNexusTaxTypeGroupsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of nexus tax type groups Returns the full list of Avalara-supported nexus tax type groups Swagger Name: AvaTaxClient
FetchResult<NoticeCustomerFundingOptionModel>	listNoticeCustomerFundingOptions(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice customer funding options.
Future<FetchResult<NoticeCustomerFundingOptionModel>>	listNoticeCustomerFundingOptionsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice customer funding options.
FetchResult<NoticeCustomerTypeModel>	listNoticeCustomerTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice customer types.
Future<FetchResult<NoticeCustomerTypeModel>>	listNoticeCustomerTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice customer types.
FetchResult<NoticeFilingTypeModel>	listNoticeFilingtypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice filing types.
Future<FetchResult<NoticeFilingTypeModel>>	listNoticeFilingtypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice filing types.
FetchResult<NoticePriorityModel>	listNoticePriorities(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice priorities.
Future<FetchResult<NoticePriorityModel>>	listNoticePrioritiesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice priorities.
FetchResult<NoticeReasonModel>	listNoticeReasons(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice reasons.
Future<FetchResult<NoticeReasonModel>>	listNoticeReasonsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice reasons.
FetchResult<NoticeResponsibilityModel>	listNoticeResponsibilities(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice responsibility ids Returns the full list of Avalara-supported tax notice responsibility ids Swagger Name: AvaTaxClient
Future<FetchResult<NoticeResponsibilityModel>>	listNoticeResponsibilitiesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice responsibility ids Returns the full list of Avalara-supported tax notice responsibility ids Swagger Name: AvaTaxClient
FetchResult<NoticeRootCauseModel>	listNoticeRootCauses(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice root causes Returns the full list of Avalara-supported tax notice root causes Swagger Name: AvaTaxClient
Future<FetchResult<NoticeRootCauseModel>>	listNoticeRootCausesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice root causes Returns the full list of Avalara-supported tax notice root causes Swagger Name: AvaTaxClient
FetchResult<NoticeStatusModel>	listNoticeStatuses(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice statuses.
Future<FetchResult<NoticeStatusModel>>	listNoticeStatusesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice statuses.
FetchResult<NoticeTypeModel>	listNoticeTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice types.
Future<FetchResult<NoticeTypeModel>>	listNoticeTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax notice types.
FetchResult<NotificationModel>	listNotifications(String filter, Integer top, Integer skip, String orderBy)	List all notifications.
Future<FetchResult<NotificationModel>>	listNotificationsAsync(String filter, Integer top, Integer skip, String orderBy)	List all notifications.
FetchResult<ParameterModel>	listParameters(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported extra parameters for creating transactions.
Future<FetchResult<ParameterModel>>	listParametersAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported extra parameters for creating transactions.
FetchResult<ParameterModel>	listParametersByItem(String companyCode, String itemCode, String filter, Integer top, Integer skip, String orderBy)	Retrieve the parameters by companyCode and itemCode.
Future<FetchResult<ParameterModel>>	listParametersByItemAsync(String companyCode, String itemCode, String filter, Integer top, Integer skip, String orderBy)	Retrieve the parameters by companyCode and itemCode.
FetchResult<ParameterUsageModel>	listParametersUsage(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
Future<FetchResult<ParameterUsageModel>>	listParametersUsageAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
FetchResult<String>	listPermissions(Integer top, Integer skip)	Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types.
Future<FetchResult<String>>	listPermissionsAsync(Integer top, Integer skip)	Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types.
FetchResult<PostalCodeModel>	listPostalCodes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported postal codes.
Future<FetchResult<PostalCodeModel>>	listPostalCodesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported postal codes.
FetchResult<PreferredProgramModel>	listPreferredPrograms(String filter, Integer top, Integer skip, String orderBy)	List all customs duty programs recognized by AvaTax List all preferred customs duty programs recognized by AvaTax.
Future<FetchResult<PreferredProgramModel>>	listPreferredProgramsAsync(String filter, Integer top, Integer skip, String orderBy)	List all customs duty programs recognized by AvaTax List all preferred customs duty programs recognized by AvaTax.
FetchResult<ProductClassificationSystemModel>	listProductClassificationSystems(String filter, Integer top, Integer skip, String orderBy, String countryCode)	List all available product classification systems.
Future<FetchResult<ProductClassificationSystemModel>>	listProductClassificationSystemsAsync(String filter, Integer top, Integer skip, String orderBy, String countryCode)	List all available product classification systems.
FetchResult<ProductClassificationSystemModel>	listProductClassificationSystemsByCompany(String companyCode, String filter, Integer top, Integer skip, String orderBy, String countryCode)	List all product classification systems available to a company based on its nexus.
Future<FetchResult<ProductClassificationSystemModel>>	listProductClassificationSystemsByCompanyAsync(String companyCode, String filter, Integer top, Integer skip, String orderBy, String countryCode)	List all product classification systems available to a company based on its nexus.
FetchResult<RateTypeModel>	listRateTypesByCountry(String country, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of rate types for each country Returns the full list of Avalara-supported rate type file types Swagger Name: AvaTaxClient
Future<FetchResult<RateTypeModel>>	listRateTypesByCountryAsync(String country, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of rate types for each country Returns the full list of Avalara-supported rate type file types Swagger Name: AvaTaxClient
FetchResult<RateTypesModel>	listRateTypesByCountryTaxTypeTaxSubType(String country, String taxTypeId, String taxSubTypeId, String filter, Integer top, Integer skip, String orderBy)	Retrieve the list of rate types by country, TaxType and by TaxSubType Returns the list of Avalara-supported rate type file types Swagger Name: AvaTaxClient
Future<FetchResult<RateTypesModel>>	listRateTypesByCountryTaxTypeTaxSubTypeAsync(String country, String taxTypeId, String taxSubTypeId, String filter, Integer top, Integer skip, String orderBy)	Retrieve the list of rate types by country, TaxType and by TaxSubType Returns the list of Avalara-supported rate type file types Swagger Name: AvaTaxClient
FetchResult<IsoRegionModel>	listRegions(String filter, Integer top, Integer skip, String orderBy)	List all ISO 3166 regions Returns a list of all ISO 3166 region codes and their US English friendly names.
Future<FetchResult<IsoRegionModel>>	listRegionsAsync(String filter, Integer top, Integer skip, String orderBy)	List all ISO 3166 regions Returns a list of all ISO 3166 region codes and their US English friendly names.
FetchResult<IsoRegionModel>	listRegionsByCountry(String country, String filter, Integer top, Integer skip, String orderBy)	List all ISO 3166 regions for a country Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
Future<FetchResult<IsoRegionModel>>	listRegionsByCountryAsync(String country, String filter, Integer top, Integer skip, String orderBy)	List all ISO 3166 regions for a country Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
FetchResult<ReportModel>	listReports(Integer companyId, String pageKey, Integer skip, Integer top)	List all report tasks for account List all report tasks for your account.
Future<FetchResult<ReportModel>>	listReportsAsync(Integer companyId, String pageKey, Integer skip, Integer top)	List all report tasks for account List all report tasks for your account.
FetchResult<ResourceFileTypeModel>	listResourceFileTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported resource file types Returns the full list of Avalara-supported resource file types Swagger Name: AvaTaxClient
Future<FetchResult<ResourceFileTypeModel>>	listResourceFileTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported resource file types Returns the full list of Avalara-supported resource file types Swagger Name: AvaTaxClient
FetchResult<ReturnsParameterUsageModel>	listReturnsParametersUsage(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported usage of parameters used for returns.
Future<FetchResult<ReturnsParameterUsageModel>>	listReturnsParametersUsageAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported usage of parameters used for returns.
FetchResult<SecurityRoleModel>	listSecurityRoles(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types.
Future<FetchResult<SecurityRoleModel>>	listSecurityRolesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types.
FetchResult<SettingModel>	listSettingsByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all settings for this company List all setting objects attached to this company.
Future<FetchResult<SettingModel>>	listSettingsByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all settings for this company List all setting objects attached to this company.
FetchResult<SubscriptionModel>	listSubscriptionsByAccount(Integer accountId, String filter, Integer top, Integer skip, String orderBy)	Retrieve subscriptions for this account List all subscription objects attached to this account.
Future<FetchResult<SubscriptionModel>>	listSubscriptionsByAccountAsync(Integer accountId, String filter, Integer top, Integer skip, String orderBy)	Retrieve subscriptions for this account List all subscription objects attached to this account.
FetchResult<SubscriptionTypeModel>	listSubscriptionTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported subscription types Returns the full list of Avalara-supported subscription types.
Future<FetchResult<SubscriptionTypeModel>>	listSubscriptionTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported subscription types Returns the full list of Avalara-supported subscription types.
FetchResult<TagsModel>	listTags(String filter, Integer top, Integer skip, String orderBy)	Retrieve the list all tags supported by avalara Swagger Name: AvaTaxClient
Future<FetchResult<TagsModel>>	listTagsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the list all tags supported by avalara Swagger Name: AvaTaxClient
FetchResult<TaxAuthorityModel>	listTaxAuthorities(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax authorities.
Future<FetchResult<TaxAuthorityModel>>	listTaxAuthoritiesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax authorities.
FetchResult<TaxAuthorityFormModel>	listTaxAuthorityForms(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported forms for each tax authority.
Future<FetchResult<TaxAuthorityFormModel>>	listTaxAuthorityFormsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported forms for each tax authority.
FetchResult<TaxAuthorityTypeModel>	listTaxAuthorityTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax authority types.
Future<FetchResult<TaxAuthorityTypeModel>>	listTaxAuthorityTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax authority types.
FetchResult<TaxCodeModel>	listTaxCodes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax codes.
Future<FetchResult<TaxCodeModel>>	listTaxCodesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of Avalara-supported tax codes.
FetchResult<TaxCodeModel>	listTaxCodesByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve tax codes for this company List all taxcode objects attached to this company.
Future<FetchResult<TaxCodeModel>>	listTaxCodesByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve tax codes for this company List all taxcode objects attached to this company.
TaxCodeTypesModel	listTaxCodeTypes(Integer top, Integer skip)	Retrieve the full list of Avalara-supported tax code types.
Future<TaxCodeTypesModel>	listTaxCodeTypesAsync(Integer top, Integer skip)	Retrieve the full list of Avalara-supported tax code types.
FetchResult<FormMasterModel>	listTaxForms(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of the Tax Forms available Returns the full list of Avalara-supported Tax Forms Swagger Name: AvaTaxClient
Future<FetchResult<FormMasterModel>>	listTaxFormsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of the Tax Forms available Returns the full list of Avalara-supported Tax Forms Swagger Name: AvaTaxClient
FetchResult<TaxRuleModel>	listTaxRules(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve tax rules for this company List all taxrule objects attached to this company.
Future<FetchResult<TaxRuleModel>>	listTaxRulesAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve tax rules for this company List all taxrule objects attached to this company.
FetchResult<TaxSubTypeModel>	listTaxSubTypes(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax sub types Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient
Future<FetchResult<TaxSubTypeModel>>	listTaxSubTypesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax sub types Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient
FetchResult<TaxSubTypeModel>	listTaxSubTypesByCountryAndTaxType(String country, String taxTypeId, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax sub types by Country and TaxType Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient
Future<FetchResult<TaxSubTypeModel>>	listTaxSubTypesByCountryAndTaxTypeAsync(String country, String taxTypeId, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax sub types by Country and TaxType Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient
FetchResult<TaxSubTypeModel>	listTaxSubTypesByJurisdictionAndRegion(String jurisdictionCode, String region, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax sub types by jurisdiction code and region Returns the full list of Avalara-supported tax sub-types by jurisdiction and region Swagger Name: AvaTaxClient
Future<FetchResult<TaxSubTypeModel>>	listTaxSubTypesByJurisdictionAndRegionAsync(String jurisdictionCode, String region, String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax sub types by jurisdiction code and region Returns the full list of Avalara-supported tax sub-types by jurisdiction and region Swagger Name: AvaTaxClient
FetchResult<TaxTypeGroupModel>	listTaxTypeGroups(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax type groups Returns the full list of Avalara-supported tax type groups Swagger Name: AvaTaxClient
Future<FetchResult<TaxTypeGroupModel>>	listTaxTypeGroupsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve the full list of tax type groups Returns the full list of Avalara-supported tax type groups Swagger Name: AvaTaxClient
FetchResult<TaxTypeModel>	listTaxTypesByNexusAndCountry(String country, Integer companyId, Integer top, Integer skip, String orderBy)	Retrieve the list of applicable TaxTypes Swagger Name: AvaTaxClient
Future<FetchResult<TaxTypeModel>>	listTaxTypesByNexusAndCountryAsync(String country, Integer companyId, Integer top, Integer skip, String orderBy)	Retrieve the list of applicable TaxTypes Swagger Name: AvaTaxClient
FetchResult<TransactionModel>	listTransactionsByCompany(String companyCode, Integer dataSourceId, String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all transactions List all transactions attached to this company.
Future<FetchResult<TransactionModel>>	listTransactionsByCompanyAsync(String companyCode, Integer dataSourceId, String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all transactions List all transactions attached to this company.
FetchResult<UnitOfBasisModel>	listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType(String country, String taxTypeId, String taxSubTypeId, String rateTypeId, Integer top, Integer skip, String orderBy)	Retrieve the list of applicable UnitOfBasis Swagger Name: AvaTaxClient
Future<FetchResult<UnitOfBasisModel>>	listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateTypeAsync(String country, String taxTypeId, String taxSubTypeId, String rateTypeId, Integer top, Integer skip, String orderBy)	Retrieve the list of applicable UnitOfBasis Swagger Name: AvaTaxClient
FetchResult<UomModel>	listUnitOfMeasurement(String filter, Integer top, Integer skip, String orderBy)	List all defined units of measurement List all units of measurement systems defined by Avalara.
Future<FetchResult<UomModel>>	listUnitOfMeasurementAsync(String filter, Integer top, Integer skip, String orderBy)	List all defined units of measurement List all units of measurement systems defined by Avalara.
FetchResult<UPCModel>	listUPCsByCompany(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve UPCs for this company List all UPC objects attached to this company.
Future<FetchResult<UPCModel>>	listUPCsByCompanyAsync(Integer companyId, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve UPCs for this company List all UPC objects attached to this company.
FetchResult<CompanyUserDefinedFieldModel>	listUserDefinedFieldsByCompanyId(Integer companyId, UserDefinedFieldType udfType, Boolean allowDefaults)	### Security 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.
Future<FetchResult<CompanyUserDefinedFieldModel>>	listUserDefinedFieldsByCompanyIdAsync(Integer companyId, UserDefinedFieldType udfType, Boolean allowDefaults)	### Security 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.
FetchResult<UserModel>	listUsersByAccount(Integer accountId, String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve users for this account List all user objects attached to this account.
Future<FetchResult<UserModel>>	listUsersByAccountAsync(Integer accountId, String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve users for this account List all user objects attached to this account.
ExemptionStatusModel	listValidCertificatesForCustomer(Integer companyId, String customerCode, String country, String region)	List valid certificates for a location List valid certificates linked to a customer in a particular country and region.
Future<ExemptionStatusModel>	listValidCertificatesForCustomerAsync(Integer companyId, String customerCode, String country, String region)	List valid certificates for a location List valid certificates linked to a customer in a particular country and region.
TransactionModel	lockTransaction(String companyCode, String transactionCode, DocumentType documentType, String include, LockTransactionModel model)	Lock a single transaction Lock a transaction uniquely identified by this URL.
Future<TransactionModel>	lockTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include, LockTransactionModel model)	Lock a single transaction Lock a transaction uniquely identified by this URL.
PingResultModel	ping()	Tests connectivity and version of the service Check connectivity to AvaTax and return information about the AvaTax API server.
Future<PingResultModel>	pingAsync()	Tests connectivity and version of the service Check connectivity to AvaTax and return information about the AvaTax API server.
FetchResult<AccountModel>	queryAccounts(String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all accounts List all account objects that can be seen by the current user.
Future<FetchResult<AccountModel>>	queryAccountsAsync(String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all accounts List all account objects that can be seen by the current user.
FetchResult<AvaFileFormModel>	queryAvaFileForms(String filter, Integer top, Integer skip, String orderBy)	Retrieve all AvaFileForms Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
Future<FetchResult<AvaFileFormModel>>	queryAvaFileFormsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve all AvaFileForms Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
FetchResult<BatchModel>	queryBatches(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all batches Get multiple batch objects across all companies.
Future<FetchResult<BatchModel>>	queryBatchesAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all batches Get multiple batch objects across all companies.
FetchResult<CertificateModel>	queryCertificates(Integer companyId, String include, String filter, Integer top, Integer skip, String orderBy)	List all certificates for a company List all certificates recorded by a company A certificate is a document stored in either AvaTax Exemptions or CertCapture.
Future<FetchResult<CertificateModel>>	queryCertificatesAsync(Integer companyId, String include, String filter, Integer top, Integer skip, String orderBy)	List all certificates for a company List all certificates recorded by a company A certificate is a document stored in either AvaTax Exemptions or CertCapture.
FetchResult<CompanyModel>	queryCompanies(String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all companies Get multiple company objects.
Future<FetchResult<CompanyModel>>	queryCompaniesAsync(String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all companies Get multiple company objects.
FetchResult<ContactModel>	queryContacts(String filter, Integer top, Integer skip, String orderBy)	Retrieve all contacts Get multiple contact objects across all companies.
Future<FetchResult<ContactModel>>	queryContactsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve all contacts Get multiple contact objects across all companies.
FetchResult<CustomerModel>	queryCustomers(Integer companyId, String include, String filter, Integer top, Integer skip, String orderBy)	List all customers for this company List all customers recorded by this company matching the specified criteria.
Future<FetchResult<CustomerModel>>	queryCustomersAsync(Integer companyId, String include, String filter, Integer top, Integer skip, String orderBy)	List all customers for this company List all customers recorded by this company matching the specified criteria.
FetchResult<DataSourceModel>	queryDataSources(String filter, Integer top, Integer skip, String orderBy)	Retrieve all datasources Get multiple datasource objects across all companies.
Future<FetchResult<DataSourceModel>>	queryDataSourcesAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve all datasources Get multiple datasource objects across all companies.
FetchResult<CompanyDistanceThresholdModel>	queryDistanceThresholds(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all DistanceThreshold objects Lists all DistanceThreshold objects that belong to this account.
Future<FetchResult<CompanyDistanceThresholdModel>>	queryDistanceThresholdsAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all DistanceThreshold objects Lists all DistanceThreshold objects that belong to this account.
FetchResult<ItemModel>	queryItems(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all items Get multiple item objects across all companies.
Future<FetchResult<ItemModel>>	queryItemsAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all items Get multiple item objects across all companies.
FetchResult<ItemModel>	queryItemsByTag(Integer companyId, String tag, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all items associated with given tag Get multiple item objects associated with given tag.
Future<FetchResult<ItemModel>>	queryItemsByTagAsync(Integer companyId, String tag, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all items associated with given tag Get multiple item objects associated with given tag.
FetchResult<JurisdictionOverrideModel>	queryJurisdictionOverrides(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all overrides Get multiple jurisdiction override objects across all companies.
Future<FetchResult<JurisdictionOverrideModel>>	queryJurisdictionOverridesAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all overrides Get multiple jurisdiction override objects across all companies.
FetchResult<LocationModel>	queryLocations(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all locations Get multiple location objects across all companies.
Future<FetchResult<LocationModel>>	queryLocationsAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all locations Get multiple location objects across all companies.
FetchResult<NexusModel>	queryNexus(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all nexus Get multiple nexus objects across all companies.
Future<FetchResult<NexusModel>>	queryNexusAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all nexus Get multiple nexus objects across all companies.
FetchResult<SettingModel>	querySettings(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all settings Get multiple setting objects across all companies.
Future<FetchResult<SettingModel>>	querySettingsAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all settings Get multiple setting objects across all companies.
FetchResult<SubscriptionModel>	querySubscriptions(String filter, Integer top, Integer skip, String orderBy)	Retrieve all subscriptions Get multiple subscription objects across all accounts.
Future<FetchResult<SubscriptionModel>>	querySubscriptionsAsync(String filter, Integer top, Integer skip, String orderBy)	Retrieve all subscriptions Get multiple subscription objects across all accounts.
ComplianceJurisdictionRateModel	queryTaxAuthorityJurisdictionRates(Integer taxAuthorityId, Date effectiveDate, Date endDate, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve jurisdiction rate information for tax authority This API is available by invitation only.
Future<ComplianceJurisdictionRateModel>	queryTaxAuthorityJurisdictionRatesAsync(Integer taxAuthorityId, Date effectiveDate, Date endDate, String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve jurisdiction rate information for tax authority This API is available by invitation only.
FetchResult<TaxCodeModel>	queryTaxCodes(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all tax codes Get multiple taxcode objects across all companies.
Future<FetchResult<TaxCodeModel>>	queryTaxCodesAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all tax codes Get multiple taxcode objects across all companies.
FetchResult<TaxRuleModel>	queryTaxRules(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all tax rules Get multiple taxrule objects across all companies.
Future<FetchResult<TaxRuleModel>>	queryTaxRulesAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all tax rules Get multiple taxrule objects across all companies.
FetchResult<UPCModel>	queryUPCs(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all UPCs Get multiple UPC objects across all companies.
Future<FetchResult<UPCModel>>	queryUPCsAsync(String filter, String include, Integer top, Integer skip, String orderBy)	Retrieve all UPCs Get multiple UPC objects across all companies.
FetchResult<UserModel>	queryUsers(String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all users Get multiple user objects across all accounts.
Future<FetchResult<UserModel>>	queryUsersAsync(String include, String filter, Integer top, Integer skip, String orderBy)	Retrieve all users Get multiple user objects across all accounts.
FetchResult<ECommerceTokenOutputModel>	refreshECommerceToken(Integer companyId, RefreshECommerceTokenInputModel model)	Refresh an eCommerce token.
Future<FetchResult<ECommerceTokenOutputModel>>	refreshECommerceTokenAsync(Integer companyId, RefreshECommerceTokenInputModel model)	Refresh an eCommerce token.
MultiDocumentModel	refundMultiDocumentTransaction(String code, DocumentType type, String include, RefundTransactionModel model)	Create a refund for a MultiDocument transaction Create a refund for a MultiDocument transaction.
Future<MultiDocumentModel>	refundMultiDocumentTransactionAsync(String code, DocumentType type, String include, RefundTransactionModel model)	Create a refund for a MultiDocument transaction Create a refund for a MultiDocument transaction.
TransactionModel	refundTransaction(String companyCode, String transactionCode, String include, DocumentType documentType, Boolean useTaxDateOverride, RefundTransactionModel model)	Create a refund for a transaction Create a refund for a transaction.
Future<TransactionModel>	refundTransactionAsync(String companyCode, String transactionCode, String include, DocumentType documentType, Boolean useTaxDateOverride, RefundTransactionModel model)	Create a refund for a transaction Create a refund for a transaction.
Void	registerShipment(String companyCode, String transactionCode, String documentType)
Void	registerShipment(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
Future<Void>	registerShipmentAsync(String companyCode, String transactionCode, String documentType)
Future<Void>	registerShipmentAsync(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
ShippingVerifyResult	registerShipmentIfCompliant(String companyCode, String transactionCode, String documentType)
ShippingVerifyResult	registerShipmentIfCompliant(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
Future<ShippingVerifyResult>	registerShipmentIfCompliantAsync(String companyCode, String transactionCode, String documentType)
Future<ShippingVerifyResult>	registerShipmentIfCompliantAsync(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
FirmClientLinkageOutputModel	rejectFirmClientLinkage(Integer id)	Rejects linkage to a firm for a client account This API enables the account admin of a client account to reject linkage request by a firm.
Future<FirmClientLinkageOutputModel>	rejectFirmClientLinkageAsync(Integer id)	Rejects linkage to a firm for a client account This API enables the account admin of a client account to reject linkage request by a firm.
ProvisionStatusModel	requestCertificateSetup(Integer companyId)	Request setup of exemption certificates for this company.
Future<ProvisionStatusModel>	requestCertificateSetupAsync(Integer companyId)	Request setup of exemption certificates for this company.
NewAccountModel	requestFreeTrial(FreeTrialRequestModel model)	FREE API - Request a free trial of AvaTax Call this API to obtain a free AvaTax account.
Future<NewAccountModel>	requestFreeTrialAsync(FreeTrialRequestModel model)	FREE API - Request a free trial of AvaTax Call this API to obtain a free AvaTax account.
NewAccountModel	requestNewAccount(NewAccountRequestModel model)	Request a new Avalara account This API is for use by partner provisioning services customers only.
Future<NewAccountModel>	requestNewAccountAsync(NewAccountRequestModel model)	Request a new Avalara account This API is for use by partner provisioning services customers only.
OfferModel	requestNewEntitlement(Integer id, String offer)	Request a new entitilement to an existing customer This API is for use by partner provisioning services customers only.
Future<OfferModel>	requestNewEntitlementAsync(Integer id, String offer)	Request a new entitilement to an existing customer This API is for use by partner provisioning services customers only.
FirmClientLinkageOutputModel	resetFirmClientLinkage(Integer id)	Reset linkage status between a client and firm back to requested This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
Future<FirmClientLinkageOutputModel>	resetFirmClientLinkageAsync(Integer id)	Reset linkage status between a client and firm back to requested This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
String	resetPassword(Integer userId, Boolean isUndoMigrateRequest, SetPasswordModel model)	Reset a user's password programmatically # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
Future<String>	resetPasswordAsync(Integer userId, Boolean isUndoMigrateRequest, SetPasswordModel model)	Reset a user's password programmatically # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
AddressResolutionModel	resolveAddress(String line1, String line2, String line3, String city, String region, String postalCode, String country, TextCase textCase)	Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system.
Future<AddressResolutionModel>	resolveAddressAsync(String line1, String line2, String line3, String city, String region, String postalCode, String country, TextCase textCase)	Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system.
AddressResolutionModel	resolveAddressPost(AddressValidationInfo model)	Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system.
Future<AddressResolutionModel>	resolveAddressPostAsync(AddressValidationInfo model)	Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system.
FirmClientLinkageOutputModel	revokeFirmClientLinkage(Integer id)	Revokes previously approved linkage to a firm for a client account This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
Future<FirmClientLinkageOutputModel>	revokeFirmClientLinkageAsync(Integer id)	Revokes previously approved linkage to a firm for a client account This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
ArrayList<AccountConfigurationModel>	setAccountConfiguration(Integer id, ArrayList<AccountConfigurationModel> model)	Change configuration settings for this account Update configuration settings tied to this account.
Future<ArrayList<AccountConfigurationModel>>	setAccountConfigurationAsync(Integer id, ArrayList<AccountConfigurationModel> model)	Change configuration settings for this account Update configuration settings tied to this account.
ArrayList<CompanyConfigurationModel>	setCompanyConfiguration(Integer id, ArrayList<CompanyConfigurationModel> model)	Change configuration settings for this company Update configuration settings tied to this company.
Future<ArrayList<CompanyConfigurationModel>>	setCompanyConfigurationAsync(Integer id, ArrayList<CompanyConfigurationModel> model)	Change configuration settings for this company Update configuration settings tied to this company.
TransactionModel	settleTransaction(String companyCode, String transactionCode, DocumentType documentType, String include, SettleTransactionModel model)	Perform multiple actions on a transaction Performs one or more actions against the current transaction uniquely identified by this URL.
Future<TransactionModel>	settleTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include, SettleTransactionModel model)	Perform multiple actions on a transaction Performs one or more actions against the current transaction uniquely identified by this URL.
ItemCatalogueOutputModel	syncItemCatalogue(Integer companyId, ArrayList<ItemCatalogueInputModel> model)	Create or update items from a product catalog.
Future<ItemCatalogueOutputModel>	syncItemCatalogueAsync(Integer companyId, ArrayList<ItemCatalogueInputModel> model)	Create or update items from a product catalog.
SyncItemsResponseModel	syncItems(Integer companyId, SyncItemsRequestModel model)	Sync items from a product catalog Syncs a list of items with AvaTax without waiting for them to be created.
Future<SyncItemsResponseModel>	syncItemsAsync(Integer companyId, SyncItemsRequestModel model)	Sync items from a product catalog Syncs a list of items with AvaTax without waiting for them to be created.
TaxRateModel	taxRatesByAddress(String line1, String line2, String line3, String city, String region, String postalCode, String country)	Sales tax rates for a specified address Usage of this API is subject to rate limits.
Future<TaxRateModel>	taxRatesByAddressAsync(String line1, String line2, String line3, String city, String region, String postalCode, String country)	Sales tax rates for a specified address Usage of this API is subject to rate limits.
TaxRateModel	taxRatesByPostalCode(String country, String postalCode)	Sales tax rates for a specified country and postal code.
Future<TaxRateModel>	taxRatesByPostalCodeAsync(String country, String postalCode)	Sales tax rates for a specified country and postal code.
TransactionModel	uncommitTransaction(String companyCode, String transactionCode, DocumentType documentType, String include)	Uncommit a transaction for reporting Adjusts a transaction by changing it to an uncommitted status.
Future<TransactionModel>	uncommitTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include)	Uncommit a transaction for reporting Adjusts a transaction by changing it to an uncommitted status.
FetchResult<CertificateAttributeModel>	unlinkAttributesFromCertificate(Integer companyId, Integer id, ArrayList<CertificateAttributeModel> model)	Unlink attributes from a certificate Unlink one or many attributes from a certificate.
Future<FetchResult<CertificateAttributeModel>>	unlinkAttributesFromCertificateAsync(Integer companyId, Integer id, ArrayList<CertificateAttributeModel> model)	Unlink attributes from a certificate Unlink one or many attributes from a certificate.
FetchResult<CustomerAttributeModel>	unlinkAttributesFromCustomer(Integer companyId, String customerCode, ArrayList<CustomerAttributeModel> model)	Unlink attributes from a customer Unlink one or many attributes from a customer.
Future<FetchResult<CustomerAttributeModel>>	unlinkAttributesFromCustomerAsync(Integer companyId, String customerCode, ArrayList<CustomerAttributeModel> model)	Unlink attributes from a customer Unlink one or many attributes from a customer.
FetchResult<CertificateModel>	unlinkCertificatesFromCustomer(Integer companyId, String customerCode, LinkCertificatesModel model)	Unlink certificates from a customer Remove one or more certificates to a customer.
Future<FetchResult<CertificateModel>>	unlinkCertificatesFromCustomerAsync(Integer companyId, String customerCode, LinkCertificatesModel model)	Unlink certificates from a customer Remove one or more certificates to a customer.
FetchResult<CustomerModel>	unlinkCustomersFromCertificate(Integer companyId, Integer id, LinkCustomersModel model)	Unlink customers from a certificate Unlinks one or more customers from a certificate.
Future<FetchResult<CustomerModel>>	unlinkCustomersFromCertificateAsync(Integer companyId, Integer id, LinkCustomersModel model)	Unlink customers from a certificate Unlinks one or more customers from a certificate.
TransactionModel	unvoidTransaction(String companyCode, String transactionCode, DocumentType documentType, String include)	Unvoids a transaction Unvoids a voided transaction You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
Future<TransactionModel>	unvoidTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include)	Unvoids a transaction Unvoids a voided transaction You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
AccountModel	updateAccount(Integer id, AccountModel model)	Update a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
Future<AccountModel>	updateAccountAsync(Integer id, AccountModel model)	Update a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
AvaFileFormModel	updateAvaFileForm(Integer id, AvaFileFormModel model)	Update a AvaFileForm All data from the existing object will be replaced with data in the object you PUT.
Future<AvaFileFormModel>	updateAvaFileFormAsync(Integer id, AvaFileFormModel model)	Update a AvaFileForm All data from the existing object will be replaced with data in the object you PUT.
CertificateModel	updateCertificate(Integer companyId, Integer id, CertificateModel model)	Update a single certificate Replace the certificate identified by this URL with a new one.
Future<CertificateModel>	updateCertificateAsync(Integer companyId, Integer id, CertificateModel model)	Update a single certificate Replace the certificate identified by this URL with a new one.
CompanyModel	updateCompany(Integer id, CompanyModel model)	Update a single company Replace the existing company object at this URL with an updated object.
Future<CompanyModel>	updateCompanyAsync(Integer id, CompanyModel model)	Update a single company Replace the existing company object at this URL with an updated object.
CompanyParameterDetailModel	updateCompanyParameterDetail(Integer companyId, Long id, CompanyParameterDetailModel model)	Update a company parameter Update a parameter of a company.
Future<CompanyParameterDetailModel>	updateCompanyParameterDetailAsync(Integer companyId, Long id, CompanyParameterDetailModel model)	Update a company parameter Update a parameter of a company.
ContactModel	updateContact(Integer companyId, Integer id, ContactModel model)	Update a single contact Replace the existing contact object at this URL with an updated object.
Future<ContactModel>	updateContactAsync(Integer companyId, Integer id, ContactModel model)	Update a single contact Replace the existing contact object at this URL with an updated object.
CustomerModel	updateCustomer(Integer companyId, String customerCode, CustomerModel model)	Update a single customer Replace the customer object at this URL with a new record.
Future<CustomerModel>	updateCustomerAsync(Integer companyId, String customerCode, CustomerModel model)	Update a single customer Replace the customer object at this URL with a new record.
DataSourceModel	updateDataSource(Integer companyId, Integer id, DataSourceModel model)	Update a datasource identified by id for a company Updates a datasource for a company.
Future<DataSourceModel>	updateDataSourceAsync(Integer companyId, Integer id, DataSourceModel model)	Update a datasource identified by id for a company Updates a datasource for a company.
CompanyDistanceThresholdModel	updateDistanceThreshold(Integer companyId, Long id, CompanyDistanceThresholdModel model)	Update a DistanceThreshold object Replace the existing DistanceThreshold object at this URL with an updated object.
Future<CompanyDistanceThresholdModel>	updateDistanceThresholdAsync(Integer companyId, Long id, CompanyDistanceThresholdModel model)	Update a DistanceThreshold object Replace the existing DistanceThreshold object at this URL with an updated object.
ItemModel	updateItem(Integer companyId, Long id, ItemModel model)	Update a single item Replace the existing `Item` object at this URL with an updated object.
Future<ItemModel>	updateItemAsync(Integer companyId, Long id, ItemModel model)	Update a single item Replace the existing `Item` object at this URL with an updated object.
ItemClassificationOutputModel	updateItemClassification(Integer companyId, Long itemId, Long id, ItemClassificationInputModel model)	Update an item classification.
Future<ItemClassificationOutputModel>	updateItemClassificationAsync(Integer companyId, Long itemId, Long id, ItemClassificationInputModel model)	Update an item classification.
ItemParameterModel	updateItemParameter(Integer companyId, Long itemId, Long id, ItemParameterModel model)	Update an item parameter Update an item parameter.
Future<ItemParameterModel>	updateItemParameterAsync(Integer companyId, Long itemId, Long id, ItemParameterModel model)	Update an item parameter Update an item parameter.
JurisdictionOverrideModel	updateJurisdictionOverride(Integer accountId, Integer id, JurisdictionOverrideModel model)	Update a single jurisdictionoverride Replace the existing jurisdictionoverride object at this URL with an updated object.
Future<JurisdictionOverrideModel>	updateJurisdictionOverrideAsync(Integer accountId, Integer id, JurisdictionOverrideModel model)	Update a single jurisdictionoverride Replace the existing jurisdictionoverride object at this URL with an updated object.
LocationModel	updateLocation(Integer companyId, Integer id, LocationModel model)	Update a single location Replace the existing location object at this URL with an updated object.
Future<LocationModel>	updateLocationAsync(Integer companyId, Integer id, LocationModel model)	Update a single location Replace the existing location object at this URL with an updated object.
LocationParameterModel	updateLocationParameter(Integer companyId, Integer locationId, Long id, LocationParameterModel model)	Update a location parameter Update a location parameter.
Future<LocationParameterModel>	updateLocationParameterAsync(Integer companyId, Integer locationId, Long id, LocationParameterModel model)	Update a location parameter Update a location parameter.
AdvancedRuleLookupFileModel	updateLookupFile(Integer accountId, String id, AdvancedRuleLookupFileModel model)	Update a lookup file Swagger Name: AvaTaxClient
Future<AdvancedRuleLookupFileModel>	updateLookupFileAsync(Integer accountId, String id, AdvancedRuleLookupFileModel model)	Update a lookup file Swagger Name: AvaTaxClient
NexusModel	updateNexus(Integer companyId, Integer id, NexusModel model)	Update a single nexus Replace the existing nexus declaration object at this URL with an updated object.
Future<NexusModel>	updateNexusAsync(Integer companyId, Integer id, NexusModel model)	Update a single nexus Replace the existing nexus declaration object at this URL with an updated object.
NexusParameterDetailModel	updateNexusParameter(Integer companyId, Integer nexusId, Long id, NexusParameterDetailModel model)	Update an nexus parameter Update an nexus parameter.
Future<NexusParameterDetailModel>	updateNexusParameterAsync(Integer companyId, Integer nexusId, Long id, NexusParameterDetailModel model)	Update an nexus parameter Update an nexus parameter.
NotificationModel	updateNotification(Long id, NotificationModel model)	Update a single notification.
Future<NotificationModel>	updateNotificationAsync(Long id, NotificationModel model)	Update a single notification.
SettingModel	updateSetting(Integer companyId, Integer id, SettingModel model)	Update a single setting Replace the existing setting object at this URL with an updated object.
Future<SettingModel>	updateSettingAsync(Integer companyId, Integer id, SettingModel model)	Update a single setting Replace the existing setting object at this URL with an updated object.
SubscriptionModel	updateSubscription(Integer accountId, Integer id, SubscriptionModel model)	Update a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
Future<SubscriptionModel>	updateSubscriptionAsync(Integer accountId, Integer id, SubscriptionModel model)	Update a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only.
TaxCodeModel	updateTaxCode(Integer companyId, Integer id, TaxCodeModel model)	Update a single tax code Replace the existing taxcode object at this URL with an updated object.
Future<TaxCodeModel>	updateTaxCodeAsync(Integer companyId, Integer id, TaxCodeModel model)	Update a single tax code Replace the existing taxcode object at this URL with an updated object.
TaxRuleModel	updateTaxRule(Integer companyId, Integer id, TaxRuleModel model)	Update a single tax rule Replace the existing custom tax rule object at this URL with an updated object.
Future<TaxRuleModel>	updateTaxRuleAsync(Integer companyId, Integer id, TaxRuleModel model)	Update a single tax rule Replace the existing custom tax rule object at this URL with an updated object.
UPCModel	updateUPC(Integer companyId, Integer id, UPCModel model)	Update a single UPC Replace the existing UPC object at this URL with an updated object.
Future<UPCModel>	updateUPCAsync(Integer companyId, Integer id, UPCModel model)	Update a single UPC Replace the existing UPC object at this URL with an updated object.
UserModel	updateUser(Integer id, Integer accountId, UserModel model)	Update a single user Replace the existing user object at this URL with an updated object.
Future<UserModel>	updateUserAsync(Integer id, Integer accountId, UserModel model)	Update a single user Replace the existing user object at this URL with an updated object.
CompanyUserDefinedFieldModel	updateUserDefinedField(Integer companyId, Long id, CompanyUserDefinedFieldModel model)	Update a User Defined Field identified by id for a company Updates a User Defined Field for a company.
Future<CompanyUserDefinedFieldModel>	updateUserDefinedFieldAsync(Integer companyId, Long id, CompanyUserDefinedFieldModel model)	Update a User Defined Field identified by id for a company Updates a User Defined Field for a company.
String	uploadCertificateImage(Integer companyId, Integer id, String file)	Upload an image or PDF attachment for this certificate Upload an image or PDF attachment for this certificate.
Future<String>	uploadCertificateImageAsync(Integer companyId, Integer id, String file)	Upload an image or PDF attachment for this certificate Upload an image or PDF attachment for this certificate.
LocationValidationModel	validateLocation(Integer companyId, Integer id)	Validate the location against local requirements Returns validation information for this location.
Future<LocationValidationModel>	validateLocationAsync(Integer companyId, Integer id)	Validate the location against local requirements Returns validation information for this location.
AgeVerifyResult	verifyAge(String simulatedFailureCode, AgeVerifyRequest model)	Determines whether an individual meets or exceeds the minimum legal drinking age.
Future<AgeVerifyResult>	verifyAgeAsync(String simulatedFailureCode, AgeVerifyRequest model)	Determines whether an individual meets or exceeds the minimum legal drinking age.
MultiDocumentModel	verifyMultiDocumentTransaction(VerifyMultiDocumentModel model)	Verify a MultiDocument transaction Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
Future<MultiDocumentModel>	verifyMultiDocumentTransactionAsync(VerifyMultiDocumentModel model)	Verify a MultiDocument transaction Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
ShippingVerifyResult	verifyShipment(String companyCode, String transactionCode, String documentType)
ShippingVerifyResult	verifyShipment(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Evaluates a transaction against a set of direct-to-consumer shipping regulations.
Future<ShippingVerifyResult>	verifyShipmentAsync(String companyCode, String transactionCode, String documentType)
Future<ShippingVerifyResult>	verifyShipmentAsync(String companyCode, String transactionCode, String documentType, String api_version, String x_avalara_version)	Evaluates a transaction against a set of direct-to-consumer shipping regulations.
TransactionModel	verifyTransaction(String companyCode, String transactionCode, DocumentType documentType, String include, VerifyTransactionModel model)	Verify a transaction Verifies that the transaction uniquely identified by this URL matches certain expected values.
Future<TransactionModel>	verifyTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include, VerifyTransactionModel model)	Verify a transaction Verifies that the transaction uniquely identified by this URL matches certain expected values.
MultiDocumentModel	voidMultiDocumentTransaction(String code, DocumentType type, VoidTransactionModel model)	Void a MultiDocument transaction Voids the current transaction uniquely identified by this URL.
Future<MultiDocumentModel>	voidMultiDocumentTransactionAsync(String code, DocumentType type, VoidTransactionModel model)	Void a MultiDocument transaction Voids the current transaction uniquely identified by this URL.
TransactionModel	voidTransaction(String companyCode, String transactionCode, DocumentType documentType, String include, VoidTransactionModel model)	Void a transaction Voids the current transaction uniquely identified by this URL.
Future<TransactionModel>	voidTransactionAsync(String companyCode, String transactionCode, DocumentType documentType, String include, VoidTransactionModel model)	Void a transaction Voids the current transaction uniquely identified by this URL.
AvaTaxClient	withSecurity(String securityHeader)
AvaTaxClient	withSecurity(String username, String password)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 AvaTaxEnvironment environment)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 String environmentUrl)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 AvaTaxEnvironment environment,
 String proxyHost,
 int proxyPort,
 String proxySchema)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 String environmentUrl,
 String proxyHost,
 int proxyPort,
 String proxySchema)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 AvaTaxEnvironment environment,
 ExecutorService threadPool)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 AvaTaxEnvironment environment,
 ExecutorService threadPool,
 org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 String environmentUrl,
 ExecutorService threadPool)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 String environmentUrl,
 ExecutorService threadPool,
 org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 AvaTaxEnvironment environment,
 String proxyHost,
 int proxyPort,
 String proxySchema,
 ExecutorService threadPool)

AvaTaxClient

public AvaTaxClient(String appName,
 String appVersion,
 String machineName,
 String environmentUrl,
 String proxyHost,
 int proxyPort,
 String proxySchema,
 ExecutorService threadPool)

Method Details

withSecurity

public AvaTaxClient withSecurity(String securityHeader)

withSecurity

public AvaTaxClient withSecurity(String username,
 String password)

deregisterShipment

public Void deregisterShipment(String companyCode,
 String transactionCode,
 String documentType)
                        throws Exception

Throws:

Exception

deregisterShipmentAsync

public Future<Void> deregisterShipmentAsync(String companyCode,
 String transactionCode,
 String documentType)

registerShipment

public Void registerShipment(String companyCode,
 String transactionCode,
 String documentType)
                      throws Exception

Throws:

Exception

registerShipmentAsync

public Future<Void> registerShipmentAsync(String companyCode,
 String transactionCode,
 String documentType)

registerShipmentIfCompliant

public ShippingVerifyResult registerShipmentIfCompliant(String companyCode,
 String transactionCode,
 String documentType)
                                                 throws Exception

Throws:

Exception

registerShipmentIfCompliantAsync

public Future<ShippingVerifyResult> registerShipmentIfCompliantAsync(String companyCode,
 String transactionCode,
 String documentType)

verifyShipment

public ShippingVerifyResult verifyShipment(String companyCode,
 String transactionCode,
 String documentType)
                                    throws Exception

Throws:

Exception

verifyShipmentAsync

public Future<ShippingVerifyResult> verifyShipmentAsync(String companyCode,
 String transactionCode,
 String documentType)

accountResetLicenseKey

public LicenseKeyModel accountResetLicenseKey(Integer id,
 ResetLicenseKeyModel model)
                                       throws Exception

Reset this account's license key Resets the existing license key for this account to a new key. To reset your account, you must specify the ID of the account you wish to reset and confirm the action. This API is only available to account administrators for the account in question, and may only be called after an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account please log onto the AvaTax website or call the `ActivateAccount` API. You can only reset license with 'Default' license key name. Resetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created. When you call this API, all account administrators for this account will receive an email with the newly updated license key. The email will specify which user reset the license key and it will contain the new key to use to update your connectors. Note: The reset license key functionality will only be available for existing active license key i.e. when you reset license key for the account, the Default license key will be reset.The reset license key functionality is not available for newly created license keys i.e. license keys other than Default ### Security Policies * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

model - A request confirming that you wish to reset the license key of this account.

Returns:

LicenseKeyModel

Throws:

Exception

accountResetLicenseKeyAsync

public Future<LicenseKeyModel> accountResetLicenseKeyAsync(Integer id,
 ResetLicenseKeyModel model)

Reset this account's license key Resets the existing license key for this account to a new key. To reset your account, you must specify the ID of the account you wish to reset and confirm the action. This API is only available to account administrators for the account in question, and may only be called after an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account please log onto the AvaTax website or call the `ActivateAccount` API. You can only reset license with 'Default' license key name. Resetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created. When you call this API, all account administrators for this account will receive an email with the newly updated license key. The email will specify which user reset the license key and it will contain the new key to use to update your connectors. Note: The reset license key functionality will only be available for existing active license key i.e. when you reset license key for the account, the Default license key will be reset.The reset license key functionality is not available for newly created license keys i.e. license keys other than Default ### Security Policies * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

model - A request confirming that you wish to reset the license key of this account.

Returns:

LicenseKeyModel

activateAccount

public AccountModel activateAccount(Integer id,
 ActivateAccountModel model)
                             throws Exception

Activate an account by accepting terms and conditions Activate the account specified by the unique accountId number. This activation request can only be called by account administrators. You must indicate that you have read and accepted Avalara's terms and conditions to call this API. Once you have activated your account, use the `AccountResetLicenseKey` API to generate a license key for your account. If you have not read or accepted the terms and conditions, this API call will return the unchanged account model. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to activate

model - The activation request

Returns:

AccountModel

Throws:

Exception

activateAccountAsync

public Future<AccountModel> activateAccountAsync(Integer id,
 ActivateAccountModel model)

Activate an account by accepting terms and conditions Activate the account specified by the unique accountId number. This activation request can only be called by account administrators. You must indicate that you have read and accepted Avalara's terms and conditions to call this API. Once you have activated your account, use the `AccountResetLicenseKey` API to generate a license key for your account. If you have not read or accepted the terms and conditions, this API call will return the unchanged account model. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to activate

model - The activation request

Returns:

AccountModel

auditAccount

public FetchResult<AuditModel> auditAccount(Integer id,
 Date start,
 Date end,
 Integer top,
 Integer skip)
                                     throws Exception

Retrieve audit history for an account. Retrieve audit trace history for an account. Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate problems and see exactly what information was sent back and forth between your code and AvaTax. When specifying a start and end datetime, please include a valid timezone indicator, such as the "Z" present in the examples for the start and end query parameters. You can learn more about valid time zone designators at https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators. This API enforces limits to the amount of data retrieved. These limits are subject to change. * You may request data from a maximum of a one-hour time period. * The amount of data and number of API calls returned by this API are limited and may be adjusted at any time. * Old records may be migrated out of immediately available storage. To request older data, please contact your account manager. * New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to audit.

start - The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.

end - 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 - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

FetchResult

Throws:

Exception

auditAccountAsync

public Future<FetchResult<AuditModel>> auditAccountAsync(Integer id,
 Date start,
 Date end,
 Integer top,
 Integer skip)

Retrieve audit history for an account. Retrieve audit trace history for an account. Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate problems and see exactly what information was sent back and forth between your code and AvaTax. When specifying a start and end datetime, please include a valid timezone indicator, such as the "Z" present in the examples for the start and end query parameters. You can learn more about valid time zone designators at https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators. This API enforces limits to the amount of data retrieved. These limits are subject to change. * You may request data from a maximum of a one-hour time period. * The amount of data and number of API calls returned by this API are limited and may be adjusted at any time. * Old records may be migrated out of immediately available storage. To request older data, please contact your account manager. * New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to audit.

start - The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.

end - 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 - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

FetchResult

createLicenseKey

public LicenseKeyModel createLicenseKey(Integer id,
 AccountLicenseKeyModel model)
                                 throws Exception

Create license key for this account Creates a new license key for this account. To create a license key for your account, you must specify the ID of the account and license key name. This API is only available to account administrators for the account in question, and may only be called after an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account please log onto the AvaTax website or call the `ActivateAccount` API. You will reference this key using license key name. The existing license key will be using 'Default' as license key name. Hence make sure that the license key name is unique per account considering the existing license key name 'Default' ### Security Policies * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

model -

Returns:

LicenseKeyModel

Throws:

Exception

createLicenseKeyAsync

public Future<LicenseKeyModel> createLicenseKeyAsync(Integer id,
 AccountLicenseKeyModel model)

Create license key for this account Creates a new license key for this account. To create a license key for your account, you must specify the ID of the account and license key name. This API is only available to account administrators for the account in question, and may only be called after an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account please log onto the AvaTax website or call the `ActivateAccount` API. You will reference this key using license key name. The existing license key will be using 'Default' as license key name. Hence make sure that the license key name is unique per account considering the existing license key name 'Default' ### Security Policies * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

model -

Returns:

LicenseKeyModel

deleteLicenseKey

public ArrayList<ErrorDetail> deleteLicenseKey(Integer id,
 String licensekeyname)
                                        throws Exception

Delete license key for this account by license key name Deletes the license key for this account using license key name. To delete a license key for your account, you must specify the accountID of the account and license key name. This API is only available to account administrators for the account in question. ### Security Policies * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

licensekeyname - The license key name you wish to update.

Returns:

ArrayList

Throws:

Exception

deleteLicenseKeyAsync

public Future<ArrayList<ErrorDetail>> deleteLicenseKeyAsync(Integer id,
 String licensekeyname)

Delete license key for this account by license key name Deletes the license key for this account using license key name. To delete a license key for your account, you must specify the accountID of the account and license key name. This API is only available to account administrators for the account in question. ### Security Policies * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

licensekeyname - The license key name you wish to update.

Returns:

ArrayList

getAccount

public AccountModel getAccount(Integer id,
 String include)
                        throws Exception

Retrieve a single account Get the account object identified by this URL. You may use the '$include' parameter to fetch additional nested data: * Subscriptions * Users ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to retrieve

include - A comma separated list of special fetch options

Returns:

AccountModel

Throws:

Exception

getAccountAsync

public Future<AccountModel> getAccountAsync(Integer id,
 String include)

Retrieve a single account Get the account object identified by this URL. You may use the '$include' parameter to fetch additional nested data: * Subscriptions * Users ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to retrieve

include - A comma separated list of special fetch options

Returns:

AccountModel

getAccountConfiguration

public ArrayList<AccountConfigurationModel> getAccountConfiguration(Integer id)
                                                             throws Exception

Get configuration settings for this account Retrieve a list of all configuration settings tied to this account. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for Avalara internal software configuration values; to store your own account-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Account settings are permanent settings that cannot be deleted. You can set the value of an account setting to null if desired. Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's tax calculation and address resolution, and should only be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

ArrayList

Throws:

Exception

getAccountConfigurationAsync

public Future<ArrayList<AccountConfigurationModel>> getAccountConfigurationAsync(Integer id)

Get configuration settings for this account Retrieve a list of all configuration settings tied to this account. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for Avalara internal software configuration values; to store your own account-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Account settings are permanent settings that cannot be deleted. You can set the value of an account setting to null if desired. Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's tax calculation and address resolution, and should only be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

ArrayList

getLicenseKey

public AccountLicenseKeyModel getLicenseKey(Integer id,
 String licensekeyname)
                                     throws Exception

Retrieve license key by license key name ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to retrieve

licensekeyname - The ID of the account to retrieve

Returns:

AccountLicenseKeyModel

Throws:

Exception

getLicenseKeyAsync

public Future<AccountLicenseKeyModel> getLicenseKeyAsync(Integer id,
 String licensekeyname)

Retrieve license key by license key name ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to retrieve

licensekeyname - The ID of the account to retrieve

Returns:

AccountLicenseKeyModel

getLicenseKeys

public ArrayList<AccountLicenseKeyModel> getLicenseKeys(Integer id)
                                                 throws Exception

Retrieve all license keys for this account Gets list of all the license keys used by the account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to retrieve

Returns:

ArrayList

Throws:

Exception

getLicenseKeysAsync

public Future<ArrayList<AccountLicenseKeyModel>> getLicenseKeysAsync(Integer id)

Retrieve all license keys for this account Gets list of all the license keys used by the account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account to retrieve

Returns:

ArrayList

queryAccounts

public FetchResult<AccountModel> queryAccounts(String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

Retrieve all accounts List all account objects that can be seen by the current user. This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Subscriptions * Users For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ . ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptions, users

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryAccountsAsync

public Future<FetchResult<AccountModel>> queryAccountsAsync(String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all accounts List all account objects that can be seen by the current user. This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Subscriptions * Users For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ . ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptions, users

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

setAccountConfiguration

public ArrayList<AccountConfigurationModel> setAccountConfiguration(Integer id,
 ArrayList<AccountConfigurationModel> model)
                                                             throws Exception

Change configuration settings for this account Update configuration settings tied to this account. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for Avalara internal software configuration values; to store your own account-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Account settings are permanent settings that cannot be deleted. You can set the value of an account setting to null if desired. Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's tax calculation and address resolution, and should only be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

model -

Returns:

ArrayList

Throws:

Exception

setAccountConfigurationAsync

public Future<ArrayList<AccountConfigurationModel>> setAccountConfigurationAsync(Integer id,
 ArrayList<AccountConfigurationModel> model)

Change configuration settings for this account Update configuration settings tied to this account. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for Avalara internal software configuration values; to store your own account-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Account settings are permanent settings that cannot be deleted. You can set the value of an account setting to null if desired. Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's tax calculation and address resolution, and should only be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

model -

Returns:

ArrayList

resolveAddress

public AddressResolutionModel resolveAddress(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 TextCase textCase)
                                      throws Exception

Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system. If the address can be resolved, this API provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used to identify how closely this address can be located. If the address cannot be clearly located, use the 'messages' structure to learn more about problems with this address. This is the same API as the POST /api/v2/addresses/resolve endpoint. Both verbs are supported to provide for flexible implementation. In order to get any evaluation for an address, please provide at least one of the following fields/pairs: 1. postal code 2. line1 + city + region 3. line1 + postal code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AutoAddress. Swagger Name: AvaTaxClient

Parameters:

line1 - Line 1

line2 - Line 2

line3 - Line 3

city - City

region - State / Province / Region

postalCode - Postal Code / Zip Code

country - Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)

textCase - selectable text case for address validation (See TextCase::* for a list of allowable values)

Returns:

AddressResolutionModel

Throws:

Exception

resolveAddressAsync

public Future<AddressResolutionModel> resolveAddressAsync(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 TextCase textCase)

Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system. If the address can be resolved, this API provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used to identify how closely this address can be located. If the address cannot be clearly located, use the 'messages' structure to learn more about problems with this address. This is the same API as the POST /api/v2/addresses/resolve endpoint. Both verbs are supported to provide for flexible implementation. In order to get any evaluation for an address, please provide at least one of the following fields/pairs: 1. postal code 2. line1 + city + region 3. line1 + postal code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AutoAddress. Swagger Name: AvaTaxClient

Parameters:

line1 - Line 1

line2 - Line 2

line3 - Line 3

city - City

region - State / Province / Region

postalCode - Postal Code / Zip Code

country - Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)

textCase - selectable text case for address validation (See TextCase::* for a list of allowable values)

Returns:

AddressResolutionModel

resolveAddressPost

public AddressResolutionModel resolveAddressPost(AddressValidationInfo model)
                                          throws Exception

Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system. If the address can be resolved, this API provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used to identify how closely this address can be located. If the address cannot be clearly located, use the 'messages' structure to learn more about problems with this address. This is the same API as the GET /api/v2/addresses/resolve endpoint. Both verbs are supported to provide for flexible implementation. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AutoAddress. Swagger Name: AvaTaxClient

Parameters:

model - The address to resolve

Returns:

AddressResolutionModel

Throws:

Exception

resolveAddressPostAsync

public Future<AddressResolutionModel> resolveAddressPostAsync(AddressValidationInfo model)

Retrieve geolocation information for a specified address Resolve an address against Avalara's address-validation system. If the address can be resolved, this API provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used to identify how closely this address can be located. If the address cannot be clearly located, use the 'messages' structure to learn more about problems with this address. This is the same API as the GET /api/v2/addresses/resolve endpoint. Both verbs are supported to provide for flexible implementation. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AutoAddress. Swagger Name: AvaTaxClient

Parameters:

model - The address to resolve

Returns:

AddressResolutionModel

createCompanyLookupFile

public AdvancedRuleLookupFileModel createCompanyLookupFile(Integer accountId,
 Integer companyId,
 AdvancedRuleLookupFileModel model)
                                                    throws Exception

Create a lookup file for a company Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the company

companyId - The ID of the company for which the lookup file is to be created

model - The lookup file you wish to create

Returns:

AdvancedRuleLookupFileModel

Throws:

Exception

createCompanyLookupFileAsync

public Future<AdvancedRuleLookupFileModel> createCompanyLookupFileAsync(Integer accountId,
 Integer companyId,
 AdvancedRuleLookupFileModel model)

Create a lookup file for a company Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the company

companyId - The ID of the company for which the lookup file is to be created

model - The lookup file you wish to create

Returns:

AdvancedRuleLookupFileModel

deleteLookupFile

public ArrayList<ErrorDetail> deleteLookupFile(Integer accountId,
 String id)
                                        throws Exception

Delete a lookup file Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the company the lookup file is for

id - The unique ID/GUID for the company lookup file to be deleted

Returns:

ArrayList

Throws:

Exception

deleteLookupFileAsync

public Future<ArrayList<ErrorDetail>> deleteLookupFileAsync(Integer accountId,
 String id)

Delete a lookup file Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the company the lookup file is for

id - The unique ID/GUID for the company lookup file to be deleted

Returns:

ArrayList

getCompanyLookupFiles

public FetchResult<AdvancedRuleLookupFileModel> getCompanyLookupFiles(Integer accountId,
 Integer companyId)
                                                               throws Exception

Get the lookup files for a company Swagger Name: AvaTaxClient

Parameters:

accountId - The account ID for the company

companyId - The ID of the company for which to retrieve lookup files

Returns:

FetchResult

Throws:

Exception

getCompanyLookupFilesAsync

public Future<FetchResult<AdvancedRuleLookupFileModel>> getCompanyLookupFilesAsync(Integer accountId,
 Integer companyId)

Get the lookup files for a company Swagger Name: AvaTaxClient

Parameters:

accountId - The account ID for the company

companyId - The ID of the company for which to retrieve lookup files

Returns:

FetchResult

getLookupFile

public AdvancedRuleLookupFileModel getLookupFile(Integer accountId,
 String id)
                                          throws Exception

Get a lookup file for an accountId and companyLookupFileId Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the lookup file

id - The unique ID/GUID of the company lookup file to return

Returns:

AdvancedRuleLookupFileModel

Throws:

Exception

getLookupFileAsync

public Future<AdvancedRuleLookupFileModel> getLookupFileAsync(Integer accountId,
 String id)

Get a lookup file for an accountId and companyLookupFileId Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the lookup file

id - The unique ID/GUID of the company lookup file to return

Returns:

AdvancedRuleLookupFileModel

updateLookupFile

public AdvancedRuleLookupFileModel updateLookupFile(Integer accountId,
 String id,
 AdvancedRuleLookupFileModel model)
                                             throws Exception

Update a lookup file Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the company the lookup file is for

id - The unique ID/GUID of the company lookup file to be updated

model - The new values to update the lookup file

Returns:

AdvancedRuleLookupFileModel

Throws:

Exception

updateLookupFileAsync

public Future<AdvancedRuleLookupFileModel> updateLookupFileAsync(Integer accountId,
 String id,
 AdvancedRuleLookupFileModel model)

Update a lookup file Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account for the company the lookup file is for

id - The unique ID/GUID of the company lookup file to be updated

model - The new values to update the lookup file

Returns:

AdvancedRuleLookupFileModel

createAvaFileForms

public ArrayList<AvaFileFormModel> createAvaFileForms(ArrayList<AvaFileFormModel> model)
                                               throws Exception

Create a new AvaFileForm Create one or more AvaFileForms A 'AvaFileForm' represents a form supported by our returns team ### Security Policies * This API requires the user role Compliance Root User. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - The AvaFileForm you wish to create.

Returns:

ArrayList

Throws:

Exception

createAvaFileFormsAsync

public Future<ArrayList<AvaFileFormModel>> createAvaFileFormsAsync(ArrayList<AvaFileFormModel> model)

Create a new AvaFileForm Create one or more AvaFileForms A 'AvaFileForm' represents a form supported by our returns team ### Security Policies * This API requires the user role Compliance Root User. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - The AvaFileForm you wish to create.

Returns:

ArrayList

deleteAvaFileForm

public ArrayList<ErrorDetail> deleteAvaFileForm(Integer id)
                                         throws Exception

Delete a single AvaFileForm Marks the existing AvaFileForm object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the AvaFileForm you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteAvaFileFormAsync

public Future<ArrayList<ErrorDetail>> deleteAvaFileFormAsync(Integer id)

Delete a single AvaFileForm Marks the existing AvaFileForm object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the AvaFileForm you wish to delete.

Returns:

ArrayList

getAvaFileForm

public AvaFileFormModel getAvaFileForm(Integer id)
                                throws Exception

Retrieve a single AvaFileForm Get the AvaFileForm object identified by this URL. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The primary key of this AvaFileForm

Returns:

AvaFileFormModel

Throws:

Exception

getAvaFileFormAsync

public Future<AvaFileFormModel> getAvaFileFormAsync(Integer id)

Retrieve a single AvaFileForm Get the AvaFileForm object identified by this URL. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The primary key of this AvaFileForm

Returns:

AvaFileFormModel

queryAvaFileForms

public FetchResult<AvaFileFormModel> queryAvaFileForms(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                throws Exception

Retrieve all AvaFileForms Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryAvaFileFormsAsync

public Future<FetchResult<AvaFileFormModel>> queryAvaFileFormsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all AvaFileForms Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateAvaFileForm

public AvaFileFormModel updateAvaFileForm(Integer id,
 AvaFileFormModel model)
                                   throws Exception

Update a AvaFileForm All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires the user role Compliance Root User. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the AvaFileForm you wish to update

model - The AvaFileForm model you wish to update.

Returns:

AvaFileFormModel

Throws:

Exception

updateAvaFileFormAsync

public Future<AvaFileFormModel> updateAvaFileFormAsync(Integer id,
 AvaFileFormModel model)

Update a AvaFileForm All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires the user role Compliance Root User. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the AvaFileForm you wish to update

model - The AvaFileForm model you wish to update.

Returns:

AvaFileFormModel

cancelBatch

public BatchModel cancelBatch(Integer companyId,
 Integer id)
                       throws Exception

Cancel an in progress batch Marks the in progress batch identified by this URL as cancelled. Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message. Only in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message. Cancelling an in progress batch does not delete any transactions that were created before the cancellation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

id - The ID of the batch to cancel.

Returns:

BatchModel

Throws:

Exception

cancelBatchAsync

public Future<BatchModel> cancelBatchAsync(Integer companyId,
 Integer id)

Cancel an in progress batch Marks the in progress batch identified by this URL as cancelled. Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message. Only in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message. Cancelling an in progress batch does not delete any transactions that were created before the cancellation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

id - The ID of the batch to cancel.

Returns:

BatchModel

createBatches

public ArrayList<BatchModel> createBatches(Integer companyId,
 ArrayList<BatchModel> model)
                                    throws Exception

Create a new batch Create one or more new batch objects attached to this company. Each batch object may have one or more file objects (currently only one file is supported). When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). The maximum content length of the request body is limited to 28.6 MB. If this limit is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if the API is called from a browser). In this situation, please split the request into smaller batches. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

model - The batch you wish to create.

Returns:

ArrayList

Throws:

Exception

createBatchesAsync

public Future<ArrayList<BatchModel>> createBatchesAsync(Integer companyId,
 ArrayList<BatchModel> model)

Create a new batch Create one or more new batch objects attached to this company. Each batch object may have one or more file objects (currently only one file is supported). When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). The maximum content length of the request body is limited to 28.6 MB. If this limit is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if the API is called from a browser). In this situation, please split the request into smaller batches. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

model - The batch you wish to create.

Returns:

ArrayList

createTransactionBatch

public CreateTransactionBatchResponseModel createTransactionBatch(Integer companyId,
 CreateTransactionBatchRequestModel model)
                                                           throws Exception

Create a new transaction batch Create a new transaction batch objects attached to this company. When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). The maximum content length of the request body is limited to 28.6 MB. If this limit is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if the API is called from a browser). In this situation, please split the request into smaller batches. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

model - The transaction batch you wish to create.

Returns:

CreateTransactionBatchResponseModel

Throws:

Exception

createTransactionBatchAsync

public Future<CreateTransactionBatchResponseModel> createTransactionBatchAsync(Integer companyId,
 CreateTransactionBatchRequestModel model)

Create a new transaction batch Create a new transaction batch objects attached to this company. When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). The maximum content length of the request body is limited to 28.6 MB. If this limit is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if the API is called from a browser). In this situation, please split the request into smaller batches. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

model - The transaction batch you wish to create.

Returns:

CreateTransactionBatchResponseModel

deleteBatch

public ArrayList<ErrorDetail> deleteBatch(Integer companyId,
 Integer id)
                                   throws Exception

Delete a single batch Marks the batch identified by this URL as deleted. If you attempt to delete a batch that is being processed, you will receive an error message. Deleting a batch does not delete any transactions that were created by importing the batch. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

id - The ID of the batch to delete.

Returns:

ArrayList

Throws:

Exception

deleteBatchAsync

public Future<ArrayList<ErrorDetail>> deleteBatchAsync(Integer companyId,
 Integer id)

Delete a single batch Marks the batch identified by this URL as deleted. If you attempt to delete a batch that is being processed, you will receive an error message. Deleting a batch does not delete any transactions that were created by importing the batch. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch.

id - The ID of the batch to delete.

Returns:

ArrayList

downloadBatch

public String downloadBatch(Integer companyId,
 Integer batchId,
 Integer id)
                     throws Exception

Download a single batch file Download a single batch file identified by this URL. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch

batchId - The ID of the batch object

id - The primary key of this batch file object

Returns:

String

Throws:

Exception

downloadBatchAsync

public Future<String> downloadBatchAsync(Integer companyId,
 Integer batchId,
 Integer id)

Download a single batch file Download a single batch file identified by this URL. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch

batchId - The ID of the batch object

id - The primary key of this batch file object

Returns:

String

getBatch

public BatchModel getBatch(Integer companyId,
 Integer id)
                    throws Exception

Retrieve a single batch Get the batch object identified by this URL. A batch object is a large collection of API calls stored in a compact file. Use this endpoint to retrieve the results or check the status of a batch. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch

id - The primary key of this batch

Returns:

BatchModel

Throws:

Exception

getBatchAsync

public Future<BatchModel> getBatchAsync(Integer companyId,
 Integer id)

Retrieve a single batch Get the batch object identified by this URL. A batch object is a large collection of API calls stored in a compact file. Use this endpoint to retrieve the results or check the status of a batch. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this batch

id - The primary key of this batch

Returns:

BatchModel

listBatchesByCompany

public FetchResult<BatchModel> listBatchesByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                             throws Exception

Retrieve all batches for this company List all batch objects attached to the specified company. A batch object is a large collection of API calls stored in a compact file. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate results using the `$top`, `$skip`, and `$orderby` parameters. Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/) to retrieve the results, or check the status, of an individual batch. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these batches

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listBatchesByCompanyAsync

public Future<FetchResult<BatchModel>> listBatchesByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all batches for this company List all batch objects attached to the specified company. A batch object is a large collection of API calls stored in a compact file. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate results using the `$top`, `$skip`, and `$orderby` parameters. Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/) to retrieve the results, or check the status, of an individual batch. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these batches

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryBatches

public FetchResult<BatchModel> queryBatches(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                     throws Exception

Retrieve all batches Get multiple batch objects across all companies. A batch object is a large collection of API calls stored in a compact file. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate results using the `$top`, `$skip`, and `$orderby` parameters. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryBatchesAsync

public Future<FetchResult<BatchModel>> queryBatchesAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all batches Get multiple batch objects across all companies. A batch object is a large collection of API calls stored in a compact file. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate results using the `$top`, `$skip`, and `$orderby` parameters. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation. Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

createCertExpressInvitation

public ArrayList<CertExpressInvitationStatusModel> createCertExpressInvitation(Integer companyId,
 String customerCode,
 ArrayList<CreateCertExpressInvitationModel> model)
                                                                        throws Exception

Create a CertExpress invitation Creates an invitation for a customer to self-report certificates using the CertExpress website. 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. The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time. Using CertExpress with this API will ensure that your certificates are automatically linked correctly into your company so that they can be used for tax exemptions. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that will record certificates

customerCode - The number of the customer where the request is sent to

model - the requests to send out to customers

Returns:

ArrayList

Throws:

Exception

createCertExpressInvitationAsync

public Future<ArrayList<CertExpressInvitationStatusModel>> createCertExpressInvitationAsync(Integer companyId,
 String customerCode,
 ArrayList<CreateCertExpressInvitationModel> model)

Create a CertExpress invitation Creates an invitation for a customer to self-report certificates using the CertExpress website. 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. The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time. Using CertExpress with this API will ensure that your certificates are automatically linked correctly into your company so that they can be used for tax exemptions. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that will record certificates

customerCode - The number of the customer where the request is sent to

model - the requests to send out to customers

Returns:

ArrayList

getCertExpressInvitation

public CertExpressInvitationModel getCertExpressInvitation(Integer companyId,
 String customerCode,
 Integer id,
 String include)
                                                    throws Exception

Retrieve a single CertExpress invitation Retrieve an existing CertExpress invitation sent to a customer. A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information about their certificates. This step by step guide allows the customer to complete and upload the full certificate in a convenient, friendly web browser experience. When the customer completes their certificates, they will automatically be recorded to your company and linked to the customer record. The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time. Using CertExpress with this API will ensure that your certificates are automatically linked correctly into your company so that they can be used for tax exemptions. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that issued this invitation

customerCode - The number of the customer where the request is sent to

id - The unique ID number of this CertExpress invitation

include - OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.

Returns:

CertExpressInvitationModel

Throws:

Exception

getCertExpressInvitationAsync

public Future<CertExpressInvitationModel> getCertExpressInvitationAsync(Integer companyId,
 String customerCode,
 Integer id,
 String include)

Retrieve a single CertExpress invitation Retrieve an existing CertExpress invitation sent to a customer. A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information about their certificates. This step by step guide allows the customer to complete and upload the full certificate in a convenient, friendly web browser experience. When the customer completes their certificates, they will automatically be recorded to your company and linked to the customer record. The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time. Using CertExpress with this API will ensure that your certificates are automatically linked correctly into your company so that they can be used for tax exemptions. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that issued this invitation

customerCode - The number of the customer where the request is sent to

id - The unique ID number of this CertExpress invitation

include - OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.

Returns:

CertExpressInvitationModel

listCertExpressInvitations

public FetchResult<CertExpressInvitationModel> listCertExpressInvitations(Integer companyId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                   throws Exception

List CertExpress invitations Retrieve CertExpress invitations sent by this company. A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information about their certificates. This step by step guide allows the customer to complete and upload the full certificate in a convenient, friendly web browser experience. When the customer completes their certificates, they will automatically be recorded to your company and linked to the customer record. The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time. Using CertExpress with this API will ensure that your certificates are automatically linked correctly into your company so that they can be used for tax exemptions. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that issued this invitation

include - OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCertExpressInvitationsAsync

public Future<FetchResult<CertExpressInvitationModel>> listCertExpressInvitationsAsync(Integer companyId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List CertExpress invitations Retrieve CertExpress invitations sent by this company. A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information about their certificates. This step by step guide allows the customer to complete and upload the full certificate in a convenient, friendly web browser experience. When the customer completes their certificates, they will automatically be recorded to your company and linked to the customer record. The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time. Using CertExpress with this API will ensure that your certificates are automatically linked correctly into your company so that they can be used for tax exemptions. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that issued this invitation

include - OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

createCertificates

public ArrayList<CertificateModel> createCertificates(Integer companyId,
 Boolean preValidatedExemptionReason,
 ArrayList<CertificateModel> model)
                                               throws Exception

Create certificates for this company Record one or more certificates document for this company. 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. When you create a certificate, it will be processed by Avalara and will become available for use in calculating tax exemptions when processing is complete. For a certificate to be used in calculating exemptions, it must have the following: * An exposure zone indicating where the certificate is valid * A link to the customer that is allowed to use this certificate * Your tax transaction must contain the correct customer code Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. If the users specified in the certificates do not exist, the API will create the user and link them to the certificate ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company recording this certificate

preValidatedExemptionReason - If set to true, the certificate will bypass the human verification process.

model - Certificates to be created

Returns:

ArrayList

Throws:

Exception

createCertificatesAsync

public Future<ArrayList<CertificateModel>> createCertificatesAsync(Integer companyId,
 Boolean preValidatedExemptionReason,
 ArrayList<CertificateModel> model)

Create certificates for this company Record one or more certificates document for this company. 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. When you create a certificate, it will be processed by Avalara and will become available for use in calculating tax exemptions when processing is complete. For a certificate to be used in calculating exemptions, it must have the following: * An exposure zone indicating where the certificate is valid * A link to the customer that is allowed to use this certificate * Your tax transaction must contain the correct customer code Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. If the users specified in the certificates do not exist, the API will create the user and link them to the certificate ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company recording this certificate

preValidatedExemptionReason - If set to true, the certificate will bypass the human verification process.

model - Certificates to be created

Returns:

ArrayList

deleteCertificate

public ArrayList<ErrorDetail> deleteCertificate(Integer companyId,
 Integer id)
                                         throws Exception

Revoke and delete a certificate Revoke the certificate identified by this URL, then delete it. 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. Revoked certificates can no longer be used. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

Returns:

ArrayList

Throws:

Exception

deleteCertificateAsync

public Future<ArrayList<ErrorDetail>> deleteCertificateAsync(Integer companyId,
 Integer id)

Revoke and delete a certificate Revoke the certificate identified by this URL, then delete it. 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. Revoked certificates can no longer be used. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

Returns:

ArrayList

downloadCertificateImage

public String downloadCertificateImage(Integer companyId,
 Integer id,
 Integer page,
 CertificatePreviewType type)
                                throws Exception

Download an image for this certificate Download an image or PDF file for this certificate. This API can be used to download either a single-page preview of the certificate or a full PDF document. To retrieve a preview image, set the `$type` parameter to `Jpeg` and the `$page` parameter to `1`. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

page - If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.

type - The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)

Returns:

String

Throws:

Exception

downloadCertificateImageAsync

public Future<String> downloadCertificateImageAsync(Integer companyId,
 Integer id,
 Integer page,
 CertificatePreviewType type)

Download an image for this certificate Download an image or PDF file for this certificate. This API can be used to download either a single-page preview of the certificate or a full PDF document. To retrieve a preview image, set the `$type` parameter to `Jpeg` and the `$page` parameter to `1`. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

page - If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.

type - The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)

Returns:

String

getCertificate

public CertificateModel getCertificate(Integer companyId,
 Integer id,
 String include)
                                throws Exception

Retrieve a single certificate Get the current certificate identified by this URL. 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. You can use the `$include` parameter to fetch the following additional objects for expansion: * 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company that recorded this certificate

id - The unique ID number of this certificate

include - 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.

Returns:

CertificateModel

Throws:

Exception

getCertificateAsync

public Future<CertificateModel> getCertificateAsync(Integer companyId,
 Integer id,
 String include)

Retrieve a single certificate Get the current certificate identified by this URL. 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. You can use the `$include` parameter to fetch the following additional objects for expansion: * 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company that recorded this certificate

id - The unique ID number of this certificate

include - 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.

Returns:

CertificateModel

getCertificateSetup

public ProvisionStatusModel getCertificateSetup(Integer companyId)
                                         throws Exception

Check a company's exemption certificate status. Checks whether this company is configured to use exemption certificates in AvaTax. Exemption certificates are tracked through a different auditable data store than the one that holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call `GetCertificateSetup` to see if your company is configured to use the exemption certificate document store. To request setup, please call `RequestCertificateSetup` and your company will be configured with data storage in the auditable certificate system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The company ID to check

Returns:

ProvisionStatusModel

Throws:

Exception

getCertificateSetupAsync

public Future<ProvisionStatusModel> getCertificateSetupAsync(Integer companyId)

Check a company's exemption certificate status. Checks whether this company is configured to use exemption certificates in AvaTax. Exemption certificates are tracked through a different auditable data store than the one that holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call `GetCertificateSetup` to see if your company is configured to use the exemption certificate document store. To request setup, please call `RequestCertificateSetup` and your company will be configured with data storage in the auditable certificate system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The company ID to check

Returns:

ProvisionStatusModel

linkAttributesToCertificate

public FetchResult<CertificateAttributeModel> linkAttributesToCertificate(Integer companyId,
 Integer id,
 ArrayList<CertificateAttributeModel> model)
                                                                   throws Exception

Link attributes to a certificate Link one or many attributes to a certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of attributes to link to this certificate.

Returns:

FetchResult

Throws:

Exception

linkAttributesToCertificateAsync

public Future<FetchResult<CertificateAttributeModel>> linkAttributesToCertificateAsync(Integer companyId,
 Integer id,
 ArrayList<CertificateAttributeModel> model)

Link attributes to a certificate Link one or many attributes to a certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of attributes to link to this certificate.

Returns:

FetchResult

linkCustomersToCertificate

public FetchResult<CustomerModel> linkCustomersToCertificate(Integer companyId,
 Integer id,
 LinkCustomersModel model)
                                                      throws Exception

Link customers to a certificate Link one or more customers to an existing certificate. Customers and certificates must be linked before a customer can make use of a certificate to obtain a tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate can be connected to multiple customer records using the `LinkCustomersToCertificate` API. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of customers needed be added to the Certificate for exemption

Returns:

FetchResult

Throws:

Exception

linkCustomersToCertificateAsync

public Future<FetchResult<CustomerModel>> linkCustomersToCertificateAsync(Integer companyId,
 Integer id,
 LinkCustomersModel model)

Link customers to a certificate Link one or more customers to an existing certificate. Customers and certificates must be linked before a customer can make use of a certificate to obtain a tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate can be connected to multiple customer records using the `LinkCustomersToCertificate` API. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of customers needed be added to the Certificate for exemption

Returns:

FetchResult

listAttributesForCertificate

public FetchResult<CertificateAttributeModel> listAttributesForCertificate(Integer companyId,
 Integer id)
                                                                    throws Exception

List all attributes applied to this certificate Retrieve the list of attributes that are linked to this certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

Returns:

FetchResult

Throws:

Exception

listAttributesForCertificateAsync

public Future<FetchResult<CertificateAttributeModel>> listAttributesForCertificateAsync(Integer companyId,
 Integer id)

List all attributes applied to this certificate Retrieve the list of attributes that are linked to this certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

Returns:

FetchResult

listCustomersForCertificate

public FetchResult<CustomerModel> listCustomersForCertificate(Integer companyId,
 Integer id,
 String include)
                                                       throws Exception

List customers linked to this certificate List all customers linked to this certificate. Customers must be linked to a certificate in order to make use of its tax exemption features. You can link or unlink customers to a certificate at any time. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

include - OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.

Returns:

FetchResult

Throws:

Exception

listCustomersForCertificateAsync

public Future<FetchResult<CustomerModel>> listCustomersForCertificateAsync(Integer companyId,
 Integer id,
 String include)

List customers linked to this certificate List all customers linked to this certificate. Customers must be linked to a certificate in order to make use of its tax exemption features. You can link or unlink customers to a certificate at any time. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

include - OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.

Returns:

FetchResult

queryCertificates

public FetchResult<CertificateModel> queryCertificates(Integer companyId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                throws Exception

List all certificates for a company List all certificates recorded by a company 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. You can use the `$include` parameter to fetch the following additional objects for expansion: * 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company to search

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryCertificatesAsync

public Future<FetchResult<CertificateModel>> queryCertificatesAsync(Integer companyId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all certificates for a company List all certificates recorded by a company 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. You can use the `$include` parameter to fetch the following additional objects for expansion: * 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company to search

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

requestCertificateSetup

public ProvisionStatusModel requestCertificateSetup(Integer companyId)
                                             throws Exception

Request setup of exemption certificates for this company. Requests the setup of exemption certificates for this company. Exemption certificates are tracked through a different auditable data store than the one that holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call `GetCertificateSetup` to see if your company is configured to use the exemption certificate document store. To request setup, please call `RequestCertificateSetup` and your company will be configured with data storage in the auditable certificate system. This API will return the current status of exemption certificate setup for this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId -

Returns:

ProvisionStatusModel

Throws:

Exception

requestCertificateSetupAsync

public Future<ProvisionStatusModel> requestCertificateSetupAsync(Integer companyId)

Request setup of exemption certificates for this company. Requests the setup of exemption certificates for this company. Exemption certificates are tracked through a different auditable data store than the one that holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call `GetCertificateSetup` to see if your company is configured to use the exemption certificate document store. To request setup, please call `RequestCertificateSetup` and your company will be configured with data storage in the auditable certificate system. This API will return the current status of exemption certificate setup for this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId -

Returns:

ProvisionStatusModel

unlinkAttributesFromCertificate

public FetchResult<CertificateAttributeModel> unlinkAttributesFromCertificate(Integer companyId,
 Integer id,
 ArrayList<CertificateAttributeModel> model)
                                                                       throws Exception

Unlink attributes from a certificate Unlink one or many attributes from a certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of attributes to unlink from this certificate.

Returns:

FetchResult

Throws:

Exception

unlinkAttributesFromCertificateAsync

public Future<FetchResult<CertificateAttributeModel>> unlinkAttributesFromCertificateAsync(Integer companyId,
 Integer id,
 ArrayList<CertificateAttributeModel> model)

Unlink attributes from a certificate Unlink one or many attributes from a certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of attributes to unlink from this certificate.

Returns:

FetchResult

unlinkCustomersFromCertificate

public FetchResult<CustomerModel> unlinkCustomersFromCertificate(Integer companyId,
 Integer id,
 LinkCustomersModel model)
                                                          throws Exception

Unlink customers from a certificate Unlinks one or more customers from a certificate. Unlinking a certificate from a customer will prevent the certificate from being used to generate tax exemptions for the customer in the future. If any previous transactions for this customer had used this linked certificate, those transactions will be unchanged and will still have a link to the exemption certificate in question. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of customers to unlink from this certificate

Returns:

FetchResult

Throws:

Exception

unlinkCustomersFromCertificateAsync

public Future<FetchResult<CustomerModel>> unlinkCustomersFromCertificateAsync(Integer companyId,
 Integer id,
 LinkCustomersModel model)

Unlink customers from a certificate Unlinks one or more customers from a certificate. Unlinking a certificate from a customer will prevent the certificate from being used to generate tax exemptions for the customer in the future. If any previous transactions for this customer had used this linked certificate, those transactions will be unchanged and will still have a link to the exemption certificate in question. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The list of customers to unlink from this certificate

Returns:

FetchResult

updateCertificate

public CertificateModel updateCertificate(Integer companyId,
 Integer id,
 CertificateModel model)
                                   throws Exception

Update a single certificate Replace the certificate identified by this URL with a new one. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The new certificate object that will replace the existing one

Returns:

CertificateModel

Throws:

Exception

updateCertificateAsync

public Future<CertificateModel> updateCertificateAsync(Integer companyId,
 Integer id,
 CertificateModel model)

Update a single certificate Replace the certificate identified by this URL with a new one. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company that recorded this certificate

id - The unique ID number of this certificate

model - The new certificate object that will replace the existing one

Returns:

CertificateModel

uploadCertificateImage

public String uploadCertificateImage(Integer companyId,
 Integer id,
 String file)
                              throws Exception

Upload an image or PDF attachment for this certificate Upload an image or PDF attachment for this certificate. Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please use the `PDF` data type. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

file - The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.

Returns:

String

Throws:

Exception

uploadCertificateImageAsync

public Future<String> uploadCertificateImageAsync(Integer companyId,
 Integer id,
 String file)

Upload an image or PDF attachment for this certificate Upload an image or PDF attachment for this certificate. Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please use the `PDF` data type. 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. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this certificate

id - The unique ID number of this certificate

file - The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.

Returns:

String

certifyIntegration

public String certifyIntegration(Integer id)
                          throws Exception

Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations. For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the written integrations for a company are sufficient enough to be delivered to the respective customers to start using it. This API provides messages specific enough (through predefined checks) to guide the partner on what integrations are still missing from the company to get fully certified. The API makes the following checks to conclude if the company is NOT fully certified: 1. Any past month items contains generic tax code of P0000000. 2. All the companies on the requesting account are test companies. 3. No Voided/Cancelled documents in the past 30 days. 4. There are less than 2 committed documents. 5. Any documentCode is a generic GUID string. 6. Any customerCode on document is a generic GUID string. 7. No document has more than 1 documentLine. 8. All of the documents have missing exemptionNo, customerUsageType, taxDateOverride or negative amount. 9. Any document quantity is a negative number. 10. Any document have repeated lines. 11. No document has shipping charge. 12. All documents have same ItemCodes, descriptions and taxCodes. 13. Less than 2 addresses used across all documents. 14. Whether locationCode was used in documents. 15. Account with AvaGlobal subscription and no documents have VATBuyerId. 16. Any document has currencyCode not being USD for accounts with AvaGlobal subscription. 17. All documents have countryCode used for accounts with AvaGlobal subscription. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company to check if its integration is certified.

Returns:

String

Throws:

Exception

certifyIntegrationAsync

public Future<String> certifyIntegrationAsync(Integer id)

Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations. For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the written integrations for a company are sufficient enough to be delivered to the respective customers to start using it. This API provides messages specific enough (through predefined checks) to guide the partner on what integrations are still missing from the company to get fully certified. The API makes the following checks to conclude if the company is NOT fully certified: 1. Any past month items contains generic tax code of P0000000. 2. All the companies on the requesting account are test companies. 3. No Voided/Cancelled documents in the past 30 days. 4. There are less than 2 committed documents. 5. Any documentCode is a generic GUID string. 6. Any customerCode on document is a generic GUID string. 7. No document has more than 1 documentLine. 8. All of the documents have missing exemptionNo, customerUsageType, taxDateOverride or negative amount. 9. Any document quantity is a negative number. 10. Any document have repeated lines. 11. No document has shipping charge. 12. All documents have same ItemCodes, descriptions and taxCodes. 13. Less than 2 addresses used across all documents. 14. Whether locationCode was used in documents. 15. Account with AvaGlobal subscription and no documents have VATBuyerId. 16. Any document has currencyCode not being USD for accounts with AvaGlobal subscription. 17. All documents have countryCode used for accounts with AvaGlobal subscription. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company to check if its integration is certified.

Returns:

String

changeFilingStatus

public String changeFilingStatus(Integer id,
 FilingStatusChangeModel model)
                          throws Exception

Change the filing status of this company Changes the current filing status of this company. For customers using Avalara's Managed Returns Service, each company within their account can request for Avalara to file tax returns on their behalf. Avalara compliance team members will review all requested filing calendars prior to beginning filing tax returns on behalf of this company. The following changes may be requested through this API: * If a company is in `NotYetFiling` status, the customer may request this be changed to `FilingRequested`. * Avalara compliance team members may change a company from `FilingRequested` to `FirstFiling`. * Avalara compliance team members may change a company from `FirstFiling` to `Active`. All other status changes must be requested through the Avalara customer support team. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id -

model -

Returns:

String

Throws:

Exception

changeFilingStatusAsync

public Future<String> changeFilingStatusAsync(Integer id,
 FilingStatusChangeModel model)

Change the filing status of this company Changes the current filing status of this company. For customers using Avalara's Managed Returns Service, each company within their account can request for Avalara to file tax returns on their behalf. Avalara compliance team members will review all requested filing calendars prior to beginning filing tax returns on behalf of this company. The following changes may be requested through this API: * If a company is in `NotYetFiling` status, the customer may request this be changed to `FilingRequested`. * Avalara compliance team members may change a company from `FilingRequested` to `FirstFiling`. * Avalara compliance team members may change a company from `FirstFiling` to `Active`. All other status changes must be requested through the Avalara customer support team. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id -

model -

Returns:

String

companyInitialize

public CompanyModel companyInitialize(CompanyInitializationModel model)
                               throws Exception

Quick setup for a company with a single physical address Shortcut to quickly setup a single-physical-location company with critical information and activate it. This API provides quick and simple company setup functionality and does the following things: * Create a company object with its own tax profile * Add a key contact person for the company * Set up one physical location for the main office * Declare nexus in all taxing jurisdictions for that main office address * Activate the company This API only provides a limited subset of functionality compared to the 'Create Company' API call. If you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead. Please allow 1 minute before making transactions using the company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - Information about the company you wish to create.

Returns:

CompanyModel

Throws:

Exception

companyInitializeAsync

public Future<CompanyModel> companyInitializeAsync(CompanyInitializationModel model)

Quick setup for a company with a single physical address Shortcut to quickly setup a single-physical-location company with critical information and activate it. This API provides quick and simple company setup functionality and does the following things: * Create a company object with its own tax profile * Add a key contact person for the company * Set up one physical location for the main office * Declare nexus in all taxing jurisdictions for that main office address * Activate the company This API only provides a limited subset of functionality compared to the 'Create Company' API call. If you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead. Please allow 1 minute before making transactions using the company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - Information about the company you wish to create.

Returns:

CompanyModel

createCompanies

public ArrayList<CompanyModel> createCompanies(ArrayList<CompanyModel> model)
                                        throws Exception

Create new companies Create one or more new company objects. A 'company' represents a single corporation or individual that is registered to handle transactional taxes. You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company. NOTE: Please do not use these blacklisted characters in company name and code: ';', '\', '|'. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - Either a single company object or an array of companies to create

Returns:

ArrayList

Throws:

Exception

createCompaniesAsync

public Future<ArrayList<CompanyModel>> createCompaniesAsync(ArrayList<CompanyModel> model)

Create new companies Create one or more new company objects. A 'company' represents a single corporation or individual that is registered to handle transactional taxes. You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company. NOTE: Please do not use these blacklisted characters in company name and code: ';', '\', '|'. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - Either a single company object or an array of companies to create

Returns:

ArrayList

createCompanyParameters

public ArrayList<CompanyParameterDetailModel> createCompanyParameters(Integer companyId,
 ArrayList<CompanyParameterDetailModel> model)
                                                               throws Exception

Add parameters to a company. Add parameters to a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. To see available parameters for this company, call `/api/v2/definitions/parameters?$filter=attributeType eq Company` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this company parameter.

model - The company parameters you wish to create.

Returns:

ArrayList

Throws:

Exception

createCompanyParametersAsync

public Future<ArrayList<CompanyParameterDetailModel>> createCompanyParametersAsync(Integer companyId,
 ArrayList<CompanyParameterDetailModel> model)

Add parameters to a company. Add parameters to a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. To see available parameters for this company, call `/api/v2/definitions/parameters?$filter=attributeType eq Company` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this company parameter.

model - The company parameters you wish to create.

Returns:

ArrayList

createFundingRequest

public FundingStatusModel createFundingRequest(Integer id,
 FundingInitiateModel model)
                                        throws Exception

Request managed returns funding setup for a company This API is available by invitation only. Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are required to setup their funding configuration before Avalara can begin filing tax returns on their behalf. Funding configuration for each company is set up by submitting a funding setup request, which can be sent either via email or via an embedded HTML widget. When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members before approval. This API records that an ambedded HTML funding setup widget was activated. This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * 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. Swagger Name: AvaTaxClient

Parameters:

id - The unique identifier of the company

model - The funding initialization request

Returns:

FundingStatusModel

Throws:

Exception

createFundingRequestAsync

public Future<FundingStatusModel> createFundingRequestAsync(Integer id,
 FundingInitiateModel model)

Request managed returns funding setup for a company This API is available by invitation only. Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are required to setup their funding configuration before Avalara can begin filing tax returns on their behalf. Funding configuration for each company is set up by submitting a funding setup request, which can be sent either via email or via an embedded HTML widget. When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members before approval. This API records that an ambedded HTML funding setup widget was activated. This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * 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. Swagger Name: AvaTaxClient

Parameters:

id - The unique identifier of the company

model - The funding initialization request

Returns:

FundingStatusModel

deleteCompany

public ArrayList<ErrorDetail> deleteCompany(Integer id)
                                     throws Exception

Delete a single company Deleting a company will delete all child companies, and all users attached to this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteCompanyAsync

public Future<ArrayList<ErrorDetail>> deleteCompanyAsync(Integer id)

Delete a single company Deleting a company will delete all child companies, and all users attached to this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company you wish to delete.

Returns:

ArrayList

deleteCompanyParameter

public ArrayList<ErrorDetail> deleteCompanyParameter(Integer companyId,
 Long id)
                                              throws Exception

Delete a single company parameter Delete a parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

id - The parameter id

Returns:

ArrayList

Throws:

Exception

deleteCompanyParameterAsync

public Future<ArrayList<ErrorDetail>> deleteCompanyParameterAsync(Integer companyId,
 Long id)

Delete a single company parameter Delete a parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

id - The parameter id

Returns:

ArrayList

fundingConfigurationByCompany

public FundingConfigurationModel fundingConfigurationByCompany(Integer companyId)
                                                        throws Exception

Check the funding configuration of a company This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns the funding configuration of the requested company. . ### Security 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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique identifier of the company

Returns:

FundingConfigurationModel

Throws:

Exception

fundingConfigurationByCompanyAsync

public Future<FundingConfigurationModel> fundingConfigurationByCompanyAsync(Integer companyId)

Check the funding configuration of a company This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns the funding configuration of the requested company. . ### Security 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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique identifier of the company

Returns:

FundingConfigurationModel

fundingConfigurationsByCompanyAndCurrency

public ArrayList<FundingConfigurationModel> fundingConfigurationsByCompanyAndCurrency(Integer companyId,
 String currency)
                                                                               throws Exception

Check the funding configuration of a company This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns the funding configuration of the requested company. . ### Security 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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique identifier of the company

currency - The currency of the funding. USD and CAD are the only valid currencies

Returns:

ArrayList

Throws:

Exception

fundingConfigurationsByCompanyAndCurrencyAsync

public Future<ArrayList<FundingConfigurationModel>> fundingConfigurationsByCompanyAndCurrencyAsync(Integer companyId,
 String currency)

Check the funding configuration of a company This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns the funding configuration of the requested company. . ### Security 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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique identifier of the company

currency - The currency of the funding. USD and CAD are the only valid currencies

Returns:

ArrayList

getCompany

public CompanyModel getCompany(Integer id,
 String include)
                        throws Exception

Retrieve a single company Get the company object identified by this URL. A 'company' represents a single corporation or individual that is registered to handle transactional taxes. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Contacts * Items * Locations * Nexus * Settings * TaxCodes * TaxRules * UPC * Parameters ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company to retrieve.

include - 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.

Returns:

CompanyModel

Throws:

Exception

getCompanyAsync

public Future<CompanyModel> getCompanyAsync(Integer id,
 String include)

Retrieve a single company Get the company object identified by this URL. A 'company' represents a single corporation or individual that is registered to handle transactional taxes. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Contacts * Items * Locations * Nexus * Settings * TaxCodes * TaxRules * UPC * Parameters ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company to retrieve.

include - 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.

Returns:

CompanyModel

getCompanyConfiguration

public ArrayList<CompanyConfigurationModel> getCompanyConfiguration(Integer id)
                                                             throws Exception

Get configuration settings for this company Retrieve a list of all configuration settings tied to this company. Configuration settings provide you with the ability to control features of your account and of your tax software. The category name `AvaCertServiceConfig` is reserved for Avalara internal software configuration values; to store your own company-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Company settings are permanent settings that cannot be deleted. You can set the value of a company setting to null if desired and if the particular setting supports it. Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate processing, and should be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

ArrayList

Throws:

Exception

getCompanyConfigurationAsync

public Future<ArrayList<CompanyConfigurationModel>> getCompanyConfigurationAsync(Integer id)

Get configuration settings for this company Retrieve a list of all configuration settings tied to this company. Configuration settings provide you with the ability to control features of your account and of your tax software. The category name `AvaCertServiceConfig` is reserved for Avalara internal software configuration values; to store your own company-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Company settings are permanent settings that cannot be deleted. You can set the value of a company setting to null if desired and if the particular setting supports it. Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate processing, and should be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

ArrayList

getCompanyParameterDetail

public CompanyParameterDetailModel getCompanyParameterDetail(Integer companyId,
 Integer id)
                                                      throws Exception

Retrieve a single company parameter Retrieves a single parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId -

id -

Returns:

CompanyParameterDetailModel

Throws:

Exception

getCompanyParameterDetailAsync

public Future<CompanyParameterDetailModel> getCompanyParameterDetailAsync(Integer companyId,
 Integer id)

Retrieve a single company parameter Retrieves a single parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId -

id -

Returns:

CompanyParameterDetailModel

getFilingStatus

public String getFilingStatus(Integer id)
                       throws Exception

Get this company's filing status Retrieve the current filing status of this company. For customers using Avalara's Managed Returns Service, each company within their account can request for Avalara to file tax returns on their behalf. Avalara compliance team members will review all requested filing calendars prior to beginning filing tax returns on behalf of this company. A company's filing status can be one of the following values: * `NoReporting` - This company is not configured to report tax returns; instead, it reports through a parent company. * `NotYetFiling` - This company has not yet begun filing tax returns through Avalara's Managed Returns Service. * `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing. * `FirstFiling` - The company has recently filing tax returns and is in a new status. * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns. * `Inactive` - The company is currently inactive. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

String

Throws:

Exception

getFilingStatusAsync

public Future<String> getFilingStatusAsync(Integer id)

Get this company's filing status Retrieve the current filing status of this company. For customers using Avalara's Managed Returns Service, each company within their account can request for Avalara to file tax returns on their behalf. Avalara compliance team members will review all requested filing calendars prior to beginning filing tax returns on behalf of this company. A company's filing status can be one of the following values: * `NoReporting` - This company is not configured to report tax returns; instead, it reports through a parent company. * `NotYetFiling` - This company has not yet begun filing tax returns through Avalara's Managed Returns Service. * `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing. * `FirstFiling` - The company has recently filing tax returns and is in a new status. * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns. * `Inactive` - The company is currently inactive. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

String

listACHEntryDetailsForCompany

public ArrayList<ACHEntryDetailModel> listACHEntryDetailsForCompany(Integer id,
 Integer periodyear,
 Integer periodmonth)
                                                             throws Exception

Get ACH entry detail report for company and period This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns a list of ACH entry details for the given company and period. Each object in the result is an ach entry trace record for a payment made on behalf of this company. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * 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. Swagger Name: AvaTaxClient

Parameters:

id - The unique identifier of the company

periodyear - The period year

periodmonth - The period month

Returns:

ArrayList

Throws:

Exception

listACHEntryDetailsForCompanyAsync

public Future<ArrayList<ACHEntryDetailModel>> listACHEntryDetailsForCompanyAsync(Integer id,
 Integer periodyear,
 Integer periodmonth)

Get ACH entry detail report for company and period This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns a list of ACH entry details for the given company and period. Each object in the result is an ach entry trace record for a payment made on behalf of this company. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * 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. Swagger Name: AvaTaxClient

Parameters:

id - The unique identifier of the company

periodyear - The period year

periodmonth - The period month

Returns:

ArrayList

listCompanyParameterDetails

public FetchResult<CompanyParameterDetailModel> listCompanyParameterDetails(Integer companyId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                     throws Exception

Retrieve parameters for a company Retrieve all parameters of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCompanyParameterDetailsAsync

public Future<FetchResult<CompanyParameterDetailModel>> listCompanyParameterDetailsAsync(Integer companyId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve parameters for a company Retrieve all parameters of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listFundingRequestsByCompany

public ArrayList<FundingStatusModel> listFundingRequestsByCompany(Integer id)
                                                           throws Exception

Check managed returns funding status for a company This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns a list of funding setup requests and their current status. Each object in the result is a request that was made to setup or adjust funding status for this company. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * 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. Swagger Name: AvaTaxClient

Parameters:

id - The unique identifier of the company

Returns:

ArrayList

Throws:

Exception

listFundingRequestsByCompanyAsync

public Future<ArrayList<FundingStatusModel>> listFundingRequestsByCompanyAsync(Integer id)

Check managed returns funding status for a company This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns a list of funding setup requests and their current status. Each object in the result is a request that was made to setup or adjust funding status for this company. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * 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. Swagger Name: AvaTaxClient

Parameters:

id - The unique identifier of the company

Returns:

ArrayList

listMrsCompanies

public FetchResult<MrsCompanyModel> listMrsCompanies()
                                              throws Exception

Retrieve a list of MRS Companies with account This API is available by invitation only. Get a list of companies with an active MRS service. ### Security 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. Swagger Name: AvaTaxClient

Returns:

FetchResult

Throws:

Exception

listMrsCompaniesAsync

public Future<FetchResult<MrsCompanyModel>> listMrsCompaniesAsync()

Retrieve a list of MRS Companies with account This API is available by invitation only. Get a list of companies with an active MRS service. ### Security 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. Swagger Name: AvaTaxClient

Returns:

FetchResult

queryCompanies

public FetchResult<CompanyModel> queryCompanies(String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                         throws Exception

Retrieve all companies Get multiple company objects. A `company` represents a single corporation or individual that is registered to handle transactional taxes. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Contacts * Items * Locations * Nexus * Settings * TaxCodes * TaxRules * UPC * Parameters ### Security 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. Swagger Name: AvaTaxClient

Parameters:

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryCompaniesAsync

public Future<FetchResult<CompanyModel>> queryCompaniesAsync(String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all companies Get multiple company objects. A `company` represents a single corporation or individual that is registered to handle transactional taxes. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Contacts * Items * Locations * Nexus * Settings * TaxCodes * TaxRules * UPC * Parameters ### Security 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. Swagger Name: AvaTaxClient

Parameters:

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

setCompanyConfiguration

public ArrayList<CompanyConfigurationModel> setCompanyConfiguration(Integer id,
 ArrayList<CompanyConfigurationModel> model)
                                                             throws Exception

Change configuration settings for this company Update configuration settings tied to this company. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `AvaCertServiceConfig` is reserved for Avalara internal software configuration values; to store your own company-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Company settings are permanent settings that cannot be deleted. You can set the value of a company setting to null if desired and if the particular setting supports it. Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate processing, and should be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

model -

Returns:

ArrayList

Throws:

Exception

setCompanyConfigurationAsync

public Future<ArrayList<CompanyConfigurationModel>> setCompanyConfigurationAsync(Integer id,
 ArrayList<CompanyConfigurationModel> model)

Change configuration settings for this company Update configuration settings tied to this company. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `AvaCertServiceConfig` is reserved for Avalara internal software configuration values; to store your own company-level settings, please create a new category name that begins with `X-`, for example, `X-MyCustomCategory`. Company settings are permanent settings that cannot be deleted. You can set the value of a company setting to null if desired and if the particular setting supports it. Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate processing, and should be changed with care. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

model -

Returns:

ArrayList

updateCompany

public CompanyModel updateCompany(Integer id,
 CompanyModel model)
                           throws Exception

Update a single company Replace the existing company object at this URL with an updated object. A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes. All data from the existing object will be replaced with data in the object you PUT. When calling `UpdateCompany`, you are permitted to update the company itself. Updates to the nested objects such as contacts, locations, or settings are not permitted. To update the nested objects To set a field's value to `null`, you may either set its value to `null` or omit that field from the object you PUT. NOTE: Please do not use these blacklisted characters in company name and code: ';', '\', '|'. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company you wish to update.

model - The company object you wish to update.

Returns:

CompanyModel

Throws:

Exception

updateCompanyAsync

public Future<CompanyModel> updateCompanyAsync(Integer id,
 CompanyModel model)

Update a single company Replace the existing company object at this URL with an updated object. A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes. All data from the existing object will be replaced with data in the object you PUT. When calling `UpdateCompany`, you are permitted to update the company itself. Updates to the nested objects such as contacts, locations, or settings are not permitted. To update the nested objects To set a field's value to `null`, you may either set its value to `null` or omit that field from the object you PUT. NOTE: Please do not use these blacklisted characters in company name and code: ';', '\', '|'. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the company you wish to update.

model - The company object you wish to update.

Returns:

CompanyModel

updateCompanyParameterDetail

public CompanyParameterDetailModel updateCompanyParameterDetail(Integer companyId,
 Long id,
 CompanyParameterDetailModel model)
                                                         throws Exception

Update a company parameter Update a parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

id - The company parameter id

model - The company parameter object you wish to update.

Returns:

CompanyParameterDetailModel

Throws:

Exception

updateCompanyParameterDetailAsync

public Future<CompanyParameterDetailModel> updateCompanyParameterDetailAsync(Integer companyId,
 Long id,
 CompanyParameterDetailModel model)

Update a company parameter Update a parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

id - The company parameter id

model - The company parameter object you wish to update.

Returns:

CompanyParameterDetailModel

queryTaxAuthorityJurisdictionRates

public ComplianceJurisdictionRateModel queryTaxAuthorityJurisdictionRates(Integer taxAuthorityId,
 Date effectiveDate,
 Date endDate,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                                   throws Exception

Retrieve jurisdiction rate information for tax authority This API is available by invitation only. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

taxAuthorityId - Used to limit the jurisdictions returned.

effectiveDate - Used to limit the jurisdictions returned.

endDate - Used to limit the jurisdictions returned.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of objects to fetch underneath this jurisdiction.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

ComplianceJurisdictionRateModel

Throws:

Exception

queryTaxAuthorityJurisdictionRatesAsync

public Future<ComplianceJurisdictionRateModel> queryTaxAuthorityJurisdictionRatesAsync(Integer taxAuthorityId,
 Date effectiveDate,
 Date endDate,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve jurisdiction rate information for tax authority This API is available by invitation only. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

taxAuthorityId - Used to limit the jurisdictions returned.

effectiveDate - Used to limit the jurisdictions returned.

endDate - Used to limit the jurisdictions returned.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of objects to fetch underneath this jurisdiction.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

ComplianceJurisdictionRateModel

createContacts

public ArrayList<ContactModel> createContacts(Integer companyId,
 ArrayList<ContactModel> model)
                                       throws Exception

Create a new contact Create one or more new contact objects. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this contact.

model - The contacts you wish to create.

Returns:

ArrayList

Throws:

Exception

createContactsAsync

public Future<ArrayList<ContactModel>> createContactsAsync(Integer companyId,
 ArrayList<ContactModel> model)

Create a new contact Create one or more new contact objects. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this contact.

model - The contacts you wish to create.

Returns:

ArrayList

deleteContact

public ArrayList<ErrorDetail> deleteContact(Integer companyId,
 Integer id)
                                     throws Exception

Delete a single contact Mark the existing contact object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this contact.

id - The ID of the contact you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteContactAsync

public Future<ArrayList<ErrorDetail>> deleteContactAsync(Integer companyId,
 Integer id)

Delete a single contact Mark the existing contact object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this contact.

id - The ID of the contact you wish to delete.

Returns:

ArrayList

getContact

public ContactModel getContact(Integer companyId,
 Integer id)
                        throws Exception

Retrieve a single contact Get the contact object identified by this URL. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company for this contact

id - The primary key of this contact

Returns:

ContactModel

Throws:

Exception

getContactAsync

public Future<ContactModel> getContactAsync(Integer companyId,
 Integer id)

Retrieve a single contact Get the contact object identified by this URL. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company for this contact

id - The primary key of this contact

Returns:

ContactModel

listContactsByCompany

public FetchResult<ContactModel> listContactsByCompany(Integer companyId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                throws Exception

Retrieve contacts for this company List all contact objects assigned to this company. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these contacts

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listContactsByCompanyAsync

public Future<FetchResult<ContactModel>> listContactsByCompanyAsync(Integer companyId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve contacts for this company List all contact objects assigned to this company. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these contacts

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryContacts

public FetchResult<ContactModel> queryContacts(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

Retrieve all contacts Get multiple contact objects across all companies. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryContactsAsync

public Future<FetchResult<ContactModel>> queryContactsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all contacts Get multiple contact objects across all companies. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateContact

public ContactModel updateContact(Integer companyId,
 Integer id,
 ContactModel model)
                           throws Exception

Update a single contact Replace the existing contact object at this URL with an updated object. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this contact belongs to.

id - The ID of the contact you wish to update

model - The contact you wish to update.

Returns:

ContactModel

Throws:

Exception

updateContactAsync

public Future<ContactModel> updateContactAsync(Integer companyId,
 Integer id,
 ContactModel model)

Update a single contact Replace the existing contact object at this URL with an updated object. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this contact belongs to.

id - The ID of the contact you wish to update

model - The contact you wish to update.

Returns:

ContactModel

createCustomers

public ArrayList<CustomerModel> createCustomers(Integer companyId,
 ArrayList<CustomerModel> model)
                                         throws Exception

Create customers for this company Create one or more customers for this company. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. A nested object such as CustomFields could be specified and created along with the customer object. To fetch the nested object, please call 'GetCustomer' API with appropriate $include parameters. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

model - The list of customer objects to be created

Returns:

ArrayList

Throws:

Exception

createCustomersAsync

public Future<ArrayList<CustomerModel>> createCustomersAsync(Integer companyId,
 ArrayList<CustomerModel> model)

Create customers for this company Create one or more customers for this company. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. A nested object such as CustomFields could be specified and created along with the customer object. To fetch the nested object, please call 'GetCustomer' API with appropriate $include parameters. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

model - The list of customer objects to be created

Returns:

ArrayList

deleteCustomer

public CustomerModel deleteCustomer(Integer companyId,
 String customerCode)
                             throws Exception

Delete a customer record Deletes the customer object referenced by this URL. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

Returns:

CustomerModel

Throws:

Exception

deleteCustomerAsync

public Future<CustomerModel> deleteCustomerAsync(Integer companyId,
 String customerCode)

Delete a customer record Deletes the customer object referenced by this URL. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

Returns:

CustomerModel

getCustomer

public CustomerModel getCustomer(Integer companyId,
 String customerCode,
 String include)
                          throws Exception

Retrieve a single customer Retrieve the customer identified by this URL. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. You can use the `$include` parameter to fetch the following additional objects for expansion: * Certificates - Fetch a list of certificates linked to this customer. * CustomFields - Fetch a list of custom fields associated to this customer. * attributes - Retrieves all attributes applied to the customer. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

include - Specify optional additional objects to include in this fetch request

Returns:

CustomerModel

Throws:

Exception

getCustomerAsync

public Future<CustomerModel> getCustomerAsync(Integer companyId,
 String customerCode,
 String include)

Retrieve a single customer Retrieve the customer identified by this URL. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. You can use the `$include` parameter to fetch the following additional objects for expansion: * Certificates - Fetch a list of certificates linked to this customer. * CustomFields - Fetch a list of custom fields associated to this customer. * attributes - Retrieves all attributes applied to the customer. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

include - Specify optional additional objects to include in this fetch request

Returns:

CustomerModel

linkAttributesToCustomer

public FetchResult<CustomerAttributeModel> linkAttributesToCustomer(Integer companyId,
 String customerCode,
 ArrayList<CustomerAttributeModel> model)
                                                             throws Exception

Link attributes to a customer Link one or many attributes to a customer. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded the provided customer

customerCode - The unique code representing the current customer

model - The list of attributes to link to the customer.

Returns:

FetchResult

Throws:

Exception

linkAttributesToCustomerAsync

public Future<FetchResult<CustomerAttributeModel>> linkAttributesToCustomerAsync(Integer companyId,
 String customerCode,
 ArrayList<CustomerAttributeModel> model)

Link attributes to a customer Link one or many attributes to a customer. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded the provided customer

customerCode - The unique code representing the current customer

model - The list of attributes to link to the customer.

Returns:

FetchResult

linkCertificatesToCustomer

public FetchResult<CertificateModel> linkCertificatesToCustomer(Integer companyId,
 String customerCode,
 LinkCertificatesModel model)
                                                         throws Exception

Link certificates to a customer Link one or more certificates to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

model - The list of certificates to link to this customer

Returns:

FetchResult

Throws:

Exception

linkCertificatesToCustomerAsync

public Future<FetchResult<CertificateModel>> linkCertificatesToCustomerAsync(Integer companyId,
 String customerCode,
 LinkCertificatesModel model)

Link certificates to a customer Link one or more certificates to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

model - The list of certificates to link to this customer

Returns:

FetchResult

linkShipToCustomersToBillCustomer

public CustomerModel linkShipToCustomersToBillCustomer(Integer companyId,
 String code,
 LinkCustomersModel model)
                                                throws Exception

Link two customer records together Links a Ship-To customer record with a Bill-To customer record. 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. In general, a customer will have only one primary billing address and multiple ship-to addresses, representing all of the different locations where they receive goods. To facilitate this type of customer, you can send in one bill-to customer code and multiple ship-to customer codes in a single API call. Note that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers of the same kind together. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company defining customers.

code - The code of the bill-to customer to link.

model - A list of information about ship-to customers to link to this bill-to customer.

Returns:

CustomerModel

Throws:

Exception

linkShipToCustomersToBillCustomerAsync

public Future<CustomerModel> linkShipToCustomersToBillCustomerAsync(Integer companyId,
 String code,
 LinkCustomersModel model)

Link two customer records together Links a Ship-To customer record with a Bill-To customer record. 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. In general, a customer will have only one primary billing address and multiple ship-to addresses, representing all of the different locations where they receive goods. To facilitate this type of customer, you can send in one bill-to customer code and multiple ship-to customer codes in a single API call. Note that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers of the same kind together. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company defining customers.

code - The code of the bill-to customer to link.

model - A list of information about ship-to customers to link to this bill-to customer.

Returns:

CustomerModel

listAttributesForCustomer

public FetchResult<CustomerAttributeModel> listAttributesForCustomer(Integer companyId,
 String customerCode)
                                                              throws Exception

Retrieve a customer's attributes Retrieve the attributes linked to the customer identified by this URL. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded the provided customer

customerCode - The unique code representing the current customer

Returns:

FetchResult

Throws:

Exception

listAttributesForCustomerAsync

public Future<FetchResult<CustomerAttributeModel>> listAttributesForCustomerAsync(Integer companyId,
 String customerCode)

Retrieve a customer's attributes Retrieve the attributes linked to the customer identified by this URL. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded the provided customer

customerCode - The unique code representing the current customer

Returns:

FetchResult

listCertificatesForCustomer

public FetchResult<CertificateModel> listCertificatesForCustomer(Integer companyId,
 String customerCode,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                          throws Exception

List certificates linked to a customer List all certificates linked to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCertificatesForCustomerAsync

public Future<FetchResult<CertificateModel>> listCertificatesForCustomerAsync(Integer companyId,
 String customerCode,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List certificates linked to a customer List all certificates linked to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

include - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listValidCertificatesForCustomer

public ExemptionStatusModel listValidCertificatesForCustomer(Integer companyId,
 String customerCode,
 String country,
 String region)
                                                      throws Exception

List valid certificates for a location List valid certificates linked to a customer in a particular country and region. This API is intended to help identify whether a customer has already provided a certificate that applies to a particular country and region. This API is intended to help you remind a customer when they have or have not provided copies of their exemption certificates to you during the sales order process. If a customer does not have a certificate on file and they wish to provide one, you should send the customer a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please see the `CreateCertExpressInvitation` API to create an invitation link for this customer. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

country - Search for certificates matching this country. Uses the ISO 3166 two character country code.

region - Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.

Returns:

ExemptionStatusModel

Throws:

Exception

listValidCertificatesForCustomerAsync

public Future<ExemptionStatusModel> listValidCertificatesForCustomerAsync(Integer companyId,
 String customerCode,
 String country,
 String region)

List valid certificates for a location List valid certificates linked to a customer in a particular country and region. This API is intended to help identify whether a customer has already provided a certificate that applies to a particular country and region. This API is intended to help you remind a customer when they have or have not provided copies of their exemption certificates to you during the sales order process. If a customer does not have a certificate on file and they wish to provide one, you should send the customer a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please see the `CreateCertExpressInvitation` API to create an invitation link for this customer. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

country - Search for certificates matching this country. Uses the ISO 3166 two character country code.

region - Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.

Returns:

ExemptionStatusModel

queryCustomers

public FetchResult<CustomerModel> queryCustomers(Integer companyId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                          throws Exception

List all customers for this company List all customers recorded by this company matching the specified criteria. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. You can use the `$include` parameter to fetch the following additional objects for expansion: * Certificates - Fetch a list of certificates linked to this customer. * attributes - Retrieves all attributes applied to the customer. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

include - OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* shipTos

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryCustomersAsync

public Future<FetchResult<CustomerModel>> queryCustomersAsync(Integer companyId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all customers for this company List all customers recorded by this company matching the specified criteria. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. You can use the `$include` parameter to fetch the following additional objects for expansion: * Certificates - Fetch a list of certificates linked to this customer. * attributes - Retrieves all attributes applied to the customer. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

include - OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* shipTos

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

unlinkAttributesFromCustomer

public FetchResult<CustomerAttributeModel> unlinkAttributesFromCustomer(Integer companyId,
 String customerCode,
 ArrayList<CustomerAttributeModel> model)
                                                                 throws Exception

Unlink attributes from a customer Unlink one or many attributes from a customer. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded the customer

customerCode - The unique code representing the current customer

model - The list of attributes to unlink from the customer.

Returns:

FetchResult

Throws:

Exception

unlinkAttributesFromCustomerAsync

public Future<FetchResult<CustomerAttributeModel>> unlinkAttributesFromCustomerAsync(Integer companyId,
 String customerCode,
 ArrayList<CustomerAttributeModel> model)

Unlink attributes from a customer Unlink one or many attributes from a customer. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded the customer

customerCode - The unique code representing the current customer

model - The list of attributes to unlink from the customer.

Returns:

FetchResult

unlinkCertificatesFromCustomer

public FetchResult<CertificateModel> unlinkCertificatesFromCustomer(Integer companyId,
 String customerCode,
 LinkCertificatesModel model)
                                                             throws Exception

Unlink certificates from a customer Remove one or more certificates to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

model - The list of certificates to link to this customer

Returns:

FetchResult

Throws:

Exception

unlinkCertificatesFromCustomerAsync

public Future<FetchResult<CertificateModel>> unlinkCertificatesFromCustomerAsync(Integer companyId,
 String customerCode,
 LinkCertificatesModel model)

Unlink certificates from a customer Remove one or more certificates to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

model - The list of certificates to link to this customer

Returns:

FetchResult

updateCustomer

public CustomerModel updateCustomer(Integer companyId,
 String customerCode,
 CustomerModel model)
                             throws Exception

Update a single customer Replace the customer object at this URL with a new record. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

model - The new customer model that will replace the existing record at this URL

Returns:

CustomerModel

Throws:

Exception

updateCustomerAsync

public Future<CustomerModel> updateCustomerAsync(Integer companyId,
 String customerCode,
 CustomerModel model)

Update a single customer Replace the customer object at this URL with a new record. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and identify any certificates linked to this `customer` object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`. Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that recorded this customer

customerCode - The unique code representing this customer

model - The new customer model that will replace the existing record at this URL

Returns:

CustomerModel

createDataSources

public ArrayList<DataSourceModel> createDataSources(Integer companyId,
 ArrayList<DataSourceModel> model)
                                             throws Exception

Create and store new datasources for the respective companies. Create one or more datasource objects. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company you which to create the datasources

model -

Returns:

ArrayList

Throws:

Exception

createDataSourcesAsync

public Future<ArrayList<DataSourceModel>> createDataSourcesAsync(Integer companyId,
 ArrayList<DataSourceModel> model)

Create and store new datasources for the respective companies. Create one or more datasource objects. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company you which to create the datasources

model -

Returns:

ArrayList

deleteDataSource

public ArrayList<ErrorDetail> deleteDataSource(Integer companyId,
 Integer id)
                                        throws Exception

Delete a datasource by datasource id for a company. Marks the existing datasource for a company as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the datasource belongs to.

id - The id of the datasource you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteDataSourceAsync

public Future<ArrayList<ErrorDetail>> deleteDataSourceAsync(Integer companyId,
 Integer id)

Delete a datasource by datasource id for a company. Marks the existing datasource for a company as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the datasource belongs to.

id - The id of the datasource you wish to delete.

Returns:

ArrayList

getDataSourceById

public DataSourceModel getDataSourceById(Integer companyId,
 Integer id)
                                  throws Exception

Get data source by data source id Retrieve the data source by its unique ID number. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId -

id - data source id

Returns:

DataSourceModel

Throws:

Exception

getDataSourceByIdAsync

public Future<DataSourceModel> getDataSourceByIdAsync(Integer companyId,
 Integer id)

Get data source by data source id Retrieve the data source by its unique ID number. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId -

id - data source id

Returns:

DataSourceModel

listDataSources

public FetchResult<DataSourceModel> listDataSources(Integer companyId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                             throws Exception

Retrieve all datasources for this company Gets multiple datasource objects for a given company. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company you wish to retrieve the datasources.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listDataSourcesAsync

public Future<FetchResult<DataSourceModel>> listDataSourcesAsync(Integer companyId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all datasources for this company Gets multiple datasource objects for a given company. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company you wish to retrieve the datasources.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryDataSources

public FetchResult<DataSourceModel> queryDataSources(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                              throws Exception

Retrieve all datasources Get multiple datasource objects across all companies. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryDataSourcesAsync

public Future<FetchResult<DataSourceModel>> queryDataSourcesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all datasources Get multiple datasource objects across all companies. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateDataSource

public DataSourceModel updateDataSource(Integer companyId,
 Integer id,
 DataSourceModel model)
                                 throws Exception

Update a datasource identified by id for a company Updates a datasource for a company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the datasource belongs to.

id - The id of the datasource you wish to delete.

model -

Returns:

DataSourceModel

Throws:

Exception

updateDataSourceAsync

public Future<DataSourceModel> updateDataSourceAsync(Integer companyId,
 Integer id,
 DataSourceModel model)

Update a datasource identified by id for a company Updates a datasource for a company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the datasource belongs to.

id - The id of the datasource you wish to delete.

model -

Returns:

DataSourceModel

getCrossBorderCode

public FetchResult<HsCodeModel> getCrossBorderCode(String country,
 String hsCode)
                                            throws Exception

Lists all parents of an HS Code. Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings a list of HS Codes that are the parents and information branches of the HS Code for the given destination country, if lower detail is available. This API will include information branches if applicable. These do not have HS Codes and cannot be referenced, but can contain information relevant to deciding the correct HS Code. This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful when HS Codes can have multiple levels of generic descriptions. ### Security Policies * This API depends on the following active services:*Required* (all): AvaTaxGlobal. Swagger Name: AvaTaxClient

Parameters:

country - The name or code of the destination country.

hsCode - The partial or full HS Code for which you would like to view all of the parents.

Returns:

FetchResult

Throws:

Exception

getCrossBorderCodeAsync

public Future<FetchResult<HsCodeModel>> getCrossBorderCodeAsync(String country,
 String hsCode)

Lists all parents of an HS Code. Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings a list of HS Codes that are the parents and information branches of the HS Code for the given destination country, if lower detail is available. This API will include information branches if applicable. These do not have HS Codes and cannot be referenced, but can contain information relevant to deciding the correct HS Code. This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful when HS Codes can have multiple levels of generic descriptions. ### Security Policies * This API depends on the following active services:*Required* (all): AvaTaxGlobal. Swagger Name: AvaTaxClient

Parameters:

country - The name or code of the destination country.

hsCode - The partial or full HS Code for which you would like to view all of the parents.

Returns:

FetchResult

getLoginVerifierByForm

public FetchResult<SkyscraperStatusModel> getLoginVerifierByForm(String form,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                          throws Exception

Test whether a form supports online login verification This API is intended to be useful to identify whether the user should be allowed Swagger Name: AvaTaxClient

Parameters:

form - The name of the form you would like to verify. This is the tax form code

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

getLoginVerifierByFormAsync

public Future<FetchResult<SkyscraperStatusModel>> getLoginVerifierByFormAsync(String form,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Test whether a form supports online login verification This API is intended to be useful to identify whether the user should be allowed Swagger Name: AvaTaxClient

Parameters:

form - The name of the form you would like to verify. This is the tax form code

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listAllMarketplaceLocations

public FetchResult<MarketplaceModel> listAllMarketplaceLocations(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                          throws Exception

List all market place locations. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listAllMarketplaceLocationsAsync

public Future<FetchResult<MarketplaceModel>> listAllMarketplaceLocationsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all market place locations. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listAvaFileForms

public FetchResult<AvaFileFormModel> listAvaFileForms(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                               throws Exception

Retrieve the full list of the AvaFile Forms available This API is deprecated. Please use the ListTaxForms API. Returns the full list of Avalara-supported AvaFile Forms Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listAvaFileFormsAsync

public Future<FetchResult<AvaFileFormModel>> listAvaFileFormsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of the AvaFile Forms available This API is deprecated. Please use the ListTaxForms API. Returns the full list of Avalara-supported AvaFile Forms Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCertificateAttributes

public FetchResult<CertificateAttributeModel> listCertificateAttributes(Integer companyid,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                 throws Exception

List certificate attributes used by a company List the certificate attributes defined by a company either specified by the user or the user's default company. A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a certificate at any time. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

companyid - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCertificateAttributesAsync

public Future<FetchResult<CertificateAttributeModel>> listCertificateAttributesAsync(Integer companyid,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List certificate attributes used by a company List the certificate attributes defined by a company either specified by the user or the user's default company. A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a certificate at any time. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

companyid - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCertificateExemptReasons

public FetchResult<ExemptionReasonModel> listCertificateExemptReasons(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                               throws Exception

List the certificate exempt reasons defined by a company List the certificate exempt reasons defined by a company. An exemption reason defines why a certificate allows a customer to be exempt for purposes of tax calculation. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCertificateExemptReasonsAsync

public Future<FetchResult<ExemptionReasonModel>> listCertificateExemptReasonsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List the certificate exempt reasons defined by a company List the certificate exempt reasons defined by a company. An exemption reason defines why a certificate allows a customer to be exempt for purposes of tax calculation. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCertificateExposureZones

public FetchResult<ExposureZoneModel> listCertificateExposureZones(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                            throws Exception

List certificate exposure zones used by a company List the certificate exposure zones defined by a company. An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing authority or other legal entity to which a certificate may apply. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, name, tag, description, created, modified, region, country

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCertificateExposureZonesAsync

public Future<FetchResult<ExposureZoneModel>> listCertificateExposureZonesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List certificate exposure zones used by a company List the certificate exposure zones defined by a company. An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing authority or other legal entity to which a certificate may apply. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, name, tag, description, created, modified, region, country

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listClassificationParametersUsage

public FetchResult<ClassificationParameterUsageMapModel> listClassificationParametersUsage(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                                    throws Exception

Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item. Returns the full list of Avalara-supported usage of extra parameters for item classification. The list of parameters is available for use with Item Classification. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listClassificationParametersUsageAsync

public Future<FetchResult<ClassificationParameterUsageMapModel>> listClassificationParametersUsageAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item. Returns the full list of Avalara-supported usage of extra parameters for item classification. The list of parameters is available for use with Item Classification. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCommunicationsServiceTypes

public FetchResult<CommunicationsTSPairModel> listCommunicationsServiceTypes(Integer id,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                      throws Exception

Retrieve the full list of communications service types Swagger Name: AvaTaxClient

Parameters:

id - The transaction type ID to examine

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCommunicationsServiceTypesAsync

public Future<FetchResult<CommunicationsTSPairModel>> listCommunicationsServiceTypesAsync(Integer id,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of communications service types Swagger Name: AvaTaxClient

Parameters:

id - The transaction type ID to examine

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCommunicationsTransactionTypes

public FetchResult<CommunicationsTransactionTypeModel> listCommunicationsTransactionTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                                   throws Exception

Retrieve the full list of communications transactiontypes Returns full list of communications transaction types which Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCommunicationsTransactionTypesAsync

public Future<FetchResult<CommunicationsTransactionTypeModel>> listCommunicationsTransactionTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of communications transactiontypes Returns full list of communications transaction types which Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCommunicationsTSPairs

public FetchResult<CommunicationsTSPairModel> listCommunicationsTSPairs(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                 throws Exception

Retrieve the full list of communications transaction/service type pairs Returns full list of communications transaction/service type pairs which Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCommunicationsTSPairsAsync

public Future<FetchResult<CommunicationsTSPairModel>> listCommunicationsTSPairsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of communications transaction/service type pairs Returns full list of communications transaction/service type pairs which Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCountries

public FetchResult<IsoCountryModel> listCountries(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                           throws Exception

List all ISO 3166 countries Returns a list of all ISO 3166 country codes, and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCountriesAsync

public Future<FetchResult<IsoCountryModel>> listCountriesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all ISO 3166 countries Returns a list of all ISO 3166 country codes, and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCoverLetters

public FetchResult<CoverLetterModel> listCoverLetters(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                               throws Exception

List certificate exposure zones used by a company List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. 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. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCoverLettersAsync

public Future<FetchResult<CoverLetterModel>> listCoverLettersAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List certificate exposure zones used by a company List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. 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. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCrossBorderCodes

public FetchResult<HsCodeModel> listCrossBorderCodes(String country,
 String hsCode,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                              throws Exception

Lists the next level of HS Codes given a destination country and HS Code prefix. Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if additional children are available. HS Code is interchangeable with "tariff code" and definitions are generally unique to a destination country. An HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification. This API is intended to be useful to identify the correct HS Code to use for your item. ### Security Policies * This API depends on the following active services:*Required* (all): AvaTaxGlobal. Swagger Name: AvaTaxClient

Parameters:

country - The name or code of the destination country.

hsCode - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCrossBorderCodesAsync

public Future<FetchResult<HsCodeModel>> listCrossBorderCodesAsync(String country,
 String hsCode,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Lists the next level of HS Codes given a destination country and HS Code prefix. Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if additional children are available. HS Code is interchangeable with "tariff code" and definitions are generally unique to a destination country. An HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification. This API is intended to be useful to identify the correct HS Code to use for your item. ### Security Policies * This API depends on the following active services:*Required* (all): AvaTaxGlobal. Swagger Name: AvaTaxClient

Parameters:

country - The name or code of the destination country.

hsCode - 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 - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listCrossBorderSections

public FetchResult<HsCodeModel> listCrossBorderSections()
                                                 throws Exception

List top level HS Code Sections. Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for classifying tariff codes and the items to which they apply. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification. This API is intended to be useful to identify the top level Sections for further LandedCost HS Code lookups. ### Security Policies * This API depends on the following active services:*Required* (all): AvaTaxGlobal. Swagger Name: AvaTaxClient

Returns:

FetchResult

Throws:

Exception

listCrossBorderSectionsAsync

public Future<FetchResult<HsCodeModel>> listCrossBorderSectionsAsync()

List top level HS Code Sections. Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for classifying tariff codes and the items to which they apply. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification. This API is intended to be useful to identify the top level Sections for further LandedCost HS Code lookups. ### Security Policies * This API depends on the following active services:*Required* (all): AvaTaxGlobal. Swagger Name: AvaTaxClient

Returns:

FetchResult

listCurrencies

public FetchResult<CurrencyModel> listCurrencies(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                          throws Exception

List all ISO 4217 currencies supported by AvaTax. Lists all ISO 4217 currencies supported by AvaTax. This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listCurrenciesAsync

public Future<FetchResult<CurrencyModel>> listCurrenciesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all ISO 4217 currencies supported by AvaTax. Lists all ISO 4217 currencies supported by AvaTax. This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listEntityUseCodes

public FetchResult<EntityUseCodeModel> listEntityUseCodes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                   throws Exception

Retrieve the full list of Avalara-supported entity use codes Returns the full list of Avalara-supported entity use codes. Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction is occurring. This information is generally used to determine taxability of the product. In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* validCountries

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listEntityUseCodesAsync

public Future<FetchResult<EntityUseCodeModel>> listEntityUseCodesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported entity use codes Returns the full list of Avalara-supported entity use codes. Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction is occurring. This information is generally used to determine taxability of the product. In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* validCountries

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listFilingFrequencies

public FetchResult<FilingFrequencyModel> listFilingFrequencies(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                        throws Exception

Retrieve the full list of Avalara-supported filing frequencies. Returns the full list of Avalara-supported filing frequencies. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listFilingFrequenciesAsync

public Future<FetchResult<FilingFrequencyModel>> listFilingFrequenciesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported filing frequencies. Returns the full list of Avalara-supported filing frequencies. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listJurisdictions

public FetchResult<JurisdictionModel> listJurisdictions(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

List jurisdictions based on the filter provided Returns a list of all Avalara-supported taxing jurisdictions. This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* rate, salesRate, signatureCode, useRate

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listJurisdictionsAsync

public Future<FetchResult<JurisdictionModel>> listJurisdictionsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List jurisdictions based on the filter provided Returns a list of all Avalara-supported taxing jurisdictions. This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* rate, salesRate, signatureCode, useRate

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listJurisdictionsByAddress

public FetchResult<JurisdictionOverrideModel> listJurisdictionsByAddress(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                  throws Exception

List jurisdictions near a specific address Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information. It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby jurisdiction in AvaTax. Swagger Name: AvaTaxClient

Parameters:

line1 - The first address line portion of this address.

line2 - The second address line portion of this address.

line3 - The third address line portion of this address.

city - The city portion of this address.

region - The region, state, or province code portion of this address.

postalCode - The postal code or zip code portion of this address.

country - The two-character ISO-3166 code of the country portion of this address.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listJurisdictionsByAddressAsync

public Future<FetchResult<JurisdictionOverrideModel>> listJurisdictionsByAddressAsync(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List jurisdictions near a specific address Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information. It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby jurisdiction in AvaTax. Swagger Name: AvaTaxClient

Parameters:

line1 - The first address line portion of this address.

line2 - The second address line portion of this address.

line3 - The third address line portion of this address.

city - The city portion of this address.

region - The region, state, or province code portion of this address.

postalCode - The postal code or zip code portion of this address.

country - The two-character ISO-3166 code of the country portion of this address.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listJurisdictionsByRateTypeTaxTypeMapping

public FetchResult<JurisdictionRateTypeTaxTypeMappingModel> listJurisdictionsByRateTypeTaxTypeMapping(String country,
 String taxTypeId,
 String taxSubTypeId,
 String rateTypeId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                                               throws Exception

List jurisdictions based on the TaxType, TaxSubType and RateType provided Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType. This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' Swagger Name: AvaTaxClient

Parameters:

country - The country for which you want to retrieve the jurisdiction information

taxTypeId - The taxtype for which you want to retrieve the jurisdiction information

taxSubTypeId - The taxsubtype for which you want to retrieve the jurisdiction information

rateTypeId - The ratetype for which you want to retrieve the jurisdiction information

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listJurisdictionsByRateTypeTaxTypeMappingAsync

public Future<FetchResult<JurisdictionRateTypeTaxTypeMappingModel>> listJurisdictionsByRateTypeTaxTypeMappingAsync(String country,
 String taxTypeId,
 String taxSubTypeId,
 String rateTypeId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List jurisdictions based on the TaxType, TaxSubType and RateType provided Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType. This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' Swagger Name: AvaTaxClient

Parameters:

country - The country for which you want to retrieve the jurisdiction information

taxTypeId - The taxtype for which you want to retrieve the jurisdiction information

taxSubTypeId - The taxsubtype for which you want to retrieve the jurisdiction information

rateTypeId - The ratetype for which you want to retrieve the jurisdiction information

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listLocationQuestionsByAddress

public FetchResult<LocationQuestionModel> listLocationQuestionsByAddress(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 BigDecimal latitude,
 BigDecimal longitude,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                  throws Exception

Retrieve the list of questions that are required for a tax location Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. Some tax jurisdictions require that you register or provide additional information to configure each physical place where your company does business. This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly. You can call this API call for any address and obtain information about what questions must be answered in order to properly Swagger Name: AvaTaxClient

Parameters:

line1 - The first line of this location's address.

line2 - The second line of this location's address.

line3 - The third line of this location's address.

city - The city part of this location's address.

region - The region, state, or province part of this location's address.

postalCode - The postal code of this location's address.

country - The country part of this location's address.

latitude - Optionally identify the location via latitude/longitude instead of via address.

longitude - Optionally identify the location via latitude/longitude instead of via address.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listLocationQuestionsByAddressAsync

public Future<FetchResult<LocationQuestionModel>> listLocationQuestionsByAddressAsync(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 BigDecimal latitude,
 BigDecimal longitude,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the list of questions that are required for a tax location Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. Some tax jurisdictions require that you register or provide additional information to configure each physical place where your company does business. This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly. You can call this API call for any address and obtain information about what questions must be answered in order to properly Swagger Name: AvaTaxClient

Parameters:

line1 - The first line of this location's address.

line2 - The second line of this location's address.

line3 - The third line of this location's address.

city - The city part of this location's address.

region - The region, state, or province part of this location's address.

postalCode - The postal code of this location's address.

country - The country part of this location's address.

latitude - Optionally identify the location via latitude/longitude instead of via address.

longitude - Optionally identify the location via latitude/longitude instead of via address.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listLoginVerifiers

public FetchResult<SkyscraperStatusModel> listLoginVerifiers(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                      throws Exception

List all forms where logins can be verified automatically List all forms where logins can be verified automatically. This API is intended to be useful to identify whether the user should be allowed Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listLoginVerifiersAsync

public Future<FetchResult<SkyscraperStatusModel>> listLoginVerifiersAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all forms where logins can be verified automatically List all forms where logins can be verified automatically. This API is intended to be useful to identify whether the user should be allowed Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listMarketplaceLocations

public FetchResult<MarketplaceLocationModel> listMarketplaceLocations(String marketplaceId,
 Integer top,
 Integer skip,
 String orderBy)
                                                               throws Exception

Retrieve the list of locations for a marketplace. Swagger Name: AvaTaxClient

Parameters:

marketplaceId - MarketplaceId of a marketplace

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listMarketplaceLocationsAsync

public Future<FetchResult<MarketplaceLocationModel>> listMarketplaceLocationsAsync(String marketplaceId,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the list of locations for a marketplace. Swagger Name: AvaTaxClient

Parameters:

marketplaceId - MarketplaceId of a marketplace

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexus

public FetchResult<NexusModel> listNexus(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                  throws Exception

Retrieve the full list of Avalara-supported nexus for all countries and regions. Returns the full list of all Avalara-supported nexus for all countries and regions. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusAsync

public Future<FetchResult<NexusModel>> listNexusAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported nexus for all countries and regions. Returns the full list of all Avalara-supported nexus for all countries and regions. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusByAddress

public FetchResult<NexusModel> listNexusByAddress(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                           throws Exception

List all nexus that apply to a specific address. Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale. In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address where the company does business. Swagger Name: AvaTaxClient

Parameters:

line1 - The first address line portion of this address.

line2 - The first address line portion of this address.

line3 - The first address line portion of this address.

city - The city portion of this address.

region - 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`.

postalCode - The postal code or zip code portion of this address.

country - 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`.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusByAddressAsync

public Future<FetchResult<NexusModel>> listNexusByAddressAsync(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all nexus that apply to a specific address. Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale. In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address where the company does business. Swagger Name: AvaTaxClient

Parameters:

line1 - The first address line portion of this address.

line2 - The first address line portion of this address.

line3 - The first address line portion of this address.

city - The city portion of this address.

region - 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`.

postalCode - The postal code or zip code portion of this address.

country - 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`.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusByCountry

public FetchResult<NexusModel> listNexusByCountry(String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                           throws Exception

Retrieve the full list of Avalara-supported nexus for a country. Returns all Avalara-supported nexus for the specified country. Swagger Name: AvaTaxClient

Parameters:

country - The country in which you want to fetch the system nexus

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusByCountryAsync

public Future<FetchResult<NexusModel>> listNexusByCountryAsync(String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported nexus for a country. Returns all Avalara-supported nexus for the specified country. Swagger Name: AvaTaxClient

Parameters:

country - The country in which you want to fetch the system nexus

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusByCountryAndRegion

public FetchResult<NexusModel> listNexusByCountryAndRegion(String country,
 String region,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                    throws Exception

Retrieve the full list of Avalara-supported nexus for a country and region. Returns all Avalara-supported nexus for the specified country and region. Swagger Name: AvaTaxClient

Parameters:

country - The two-character ISO-3166 code for the country.

region - The two or three character region code for the region.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusByCountryAndRegionAsync

public Future<FetchResult<NexusModel>> listNexusByCountryAndRegionAsync(String country,
 String region,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported nexus for a country and region. Returns all Avalara-supported nexus for the specified country and region. Swagger Name: AvaTaxClient

Parameters:

country - The two-character ISO-3166 code for the country.

region - The two or three character region code for the region.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusByFormCode

public NexusByTaxFormModel listNexusByFormCode(String formCode)
                                        throws Exception

List nexus related to a tax form Retrieves a list of nexus related to a tax form. The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated to collect and remit transaction-based taxes. When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax in all jurisdictions affected by your transactions. This API is intended to provide useful information when examining a tax form. If you are about to begin filing a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

formCode - The form code that we are looking up the nexus for

Returns:

NexusByTaxFormModel

Throws:

Exception

listNexusByFormCodeAsync

public Future<NexusByTaxFormModel> listNexusByFormCodeAsync(String formCode)

List nexus related to a tax form Retrieves a list of nexus related to a tax form. The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated to collect and remit transaction-based taxes. When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax in all jurisdictions affected by your transactions. This API is intended to provide useful information when examining a tax form. If you are about to begin filing a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

formCode - The form code that we are looking up the nexus for

Returns:

NexusByTaxFormModel

listNexusByTaxTypeGroup

public FetchResult<NexusModel> listNexusByTaxTypeGroup(String taxTypeGroup,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                throws Exception

Retrieve the full list of Avalara-supported nexus for a tax type group. Returns all Avalara-supported nexus for the specified specified tax type group. Swagger Name: AvaTaxClient

Parameters:

taxTypeGroup - The tax type group to fetch the supporting system nexus for.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusByTaxTypeGroupAsync

public Future<FetchResult<NexusModel>> listNexusByTaxTypeGroupAsync(String taxTypeGroup,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported nexus for a tax type group. Returns all Avalara-supported nexus for the specified specified tax type group. Swagger Name: AvaTaxClient

Parameters:

taxTypeGroup - The tax type group to fetch the supporting system nexus for.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusTaxTypeGroups

public FetchResult<NexusTaxTypeGroupModel> listNexusTaxTypeGroups(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                           throws Exception

Retrieve the full list of nexus tax type groups Returns the full list of Avalara-supported nexus tax type groups Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusTaxTypeGroupsAsync

public Future<FetchResult<NexusTaxTypeGroupModel>> listNexusTaxTypeGroupsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of nexus tax type groups Returns the full list of Avalara-supported nexus tax type groups Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeCustomerFundingOptions

public FetchResult<NoticeCustomerFundingOptionModel> listNoticeCustomerFundingOptions(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                               throws Exception

Retrieve the full list of Avalara-supported tax notice customer funding options. Returns the full list of Avalara-supported tax notice customer funding options. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeCustomerFundingOptionsAsync

public Future<FetchResult<NoticeCustomerFundingOptionModel>> listNoticeCustomerFundingOptionsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice customer funding options. Returns the full list of Avalara-supported tax notice customer funding options. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeCustomerTypes

public FetchResult<NoticeCustomerTypeModel> listNoticeCustomerTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                             throws Exception

Retrieve the full list of Avalara-supported tax notice customer types. Returns the full list of Avalara-supported tax notice customer types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeCustomerTypesAsync

public Future<FetchResult<NoticeCustomerTypeModel>> listNoticeCustomerTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice customer types. Returns the full list of Avalara-supported tax notice customer types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeFilingtypes

public FetchResult<NoticeFilingTypeModel> listNoticeFilingtypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                         throws Exception

Retrieve the full list of Avalara-supported tax notice filing types. Returns the full list of Avalara-supported tax notice filing types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeFilingtypesAsync

public Future<FetchResult<NoticeFilingTypeModel>> listNoticeFilingtypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice filing types. Returns the full list of Avalara-supported tax notice filing types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticePriorities

public FetchResult<NoticePriorityModel> listNoticePriorities(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                      throws Exception

Retrieve the full list of Avalara-supported tax notice priorities. Returns the full list of Avalara-supported tax notice priorities. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticePrioritiesAsync

public Future<FetchResult<NoticePriorityModel>> listNoticePrioritiesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice priorities. Returns the full list of Avalara-supported tax notice priorities. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeReasons

public FetchResult<NoticeReasonModel> listNoticeReasons(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

Retrieve the full list of Avalara-supported tax notice reasons. Returns the full list of Avalara-supported tax notice reasons. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeReasonsAsync

public Future<FetchResult<NoticeReasonModel>> listNoticeReasonsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice reasons. Returns the full list of Avalara-supported tax notice reasons. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeResponsibilities

public FetchResult<NoticeResponsibilityModel> listNoticeResponsibilities(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                  throws Exception

Retrieve the full list of Avalara-supported tax notice responsibility ids Returns the full list of Avalara-supported tax notice responsibility ids Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeResponsibilitiesAsync

public Future<FetchResult<NoticeResponsibilityModel>> listNoticeResponsibilitiesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice responsibility ids Returns the full list of Avalara-supported tax notice responsibility ids Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeRootCauses

public FetchResult<NoticeRootCauseModel> listNoticeRootCauses(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                       throws Exception

Retrieve the full list of Avalara-supported tax notice root causes Returns the full list of Avalara-supported tax notice root causes Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeRootCausesAsync

public Future<FetchResult<NoticeRootCauseModel>> listNoticeRootCausesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice root causes Returns the full list of Avalara-supported tax notice root causes Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeStatuses

public FetchResult<NoticeStatusModel> listNoticeStatuses(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                  throws Exception

Retrieve the full list of Avalara-supported tax notice statuses. Returns the full list of Avalara-supported tax notice statuses. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isOpen, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeStatusesAsync

public Future<FetchResult<NoticeStatusModel>> listNoticeStatusesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice statuses. Returns the full list of Avalara-supported tax notice statuses. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isOpen, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNoticeTypes

public FetchResult<NoticeTypeModel> listNoticeTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                             throws Exception

Retrieve the full list of Avalara-supported tax notice types. Returns the full list of Avalara-supported tax notice types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNoticeTypesAsync

public Future<FetchResult<NoticeTypeModel>> listNoticeTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax notice types. Returns the full list of Avalara-supported tax notice types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listParameters

public FetchResult<ParameterModel> listParameters(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                           throws Exception

Retrieve the full list of Avalara-supported extra parameters for creating transactions. Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listParametersAsync

public Future<FetchResult<ParameterModel>> listParametersAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported extra parameters for creating transactions. Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listParametersByItem

public FetchResult<ParameterModel> listParametersByItem(String companyCode,
 String itemCode,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

Retrieve the parameters by companyCode and itemCode. Returns the list of parameters based on the company's service types and the item code. Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section. Ignores nexus for the AvaAlcohol service type. NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code' For Item Code other than the five given above below two should also be used * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyCode - Company code.

itemCode - Item code.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listParametersByItemAsync

public Future<FetchResult<ParameterModel>> listParametersByItemAsync(String companyCode,
 String itemCode,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the parameters by companyCode and itemCode. Returns the list of parameters based on the company's service types and the item code. Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section. Ignores nexus for the AvaAlcohol service type. NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code' For Item Code other than the five given above below two should also be used * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyCode - Company code.

itemCode - Item code.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listParametersUsage

public FetchResult<ParameterUsageModel> listParametersUsage(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                     throws Exception

Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listParametersUsageAsync

public Future<FetchResult<ParameterUsageModel>> listParametersUsageAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listPermissions

public FetchResult<String> listPermissions(Integer top,
 Integer skip)
                                    throws Exception

Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types. Swagger Name: AvaTaxClient

Parameters:

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

FetchResult

Throws:

Exception

listPermissionsAsync

public Future<FetchResult<String>> listPermissionsAsync(Integer top,
 Integer skip)

Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types. Swagger Name: AvaTaxClient

Parameters:

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

FetchResult

listPostalCodes

public FetchResult<PostalCodeModel> listPostalCodes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                             throws Exception

Retrieve the full list of Avalara-supported postal codes. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listPostalCodesAsync

public Future<FetchResult<PostalCodeModel>> listPostalCodesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported postal codes. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listPreferredPrograms

public FetchResult<PreferredProgramModel> listPreferredPrograms(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                         throws Exception

List all customs duty programs recognized by AvaTax List all preferred customs duty programs recognized by AvaTax. A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring countries. To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effectiveDate, endDate

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listPreferredProgramsAsync

public Future<FetchResult<PreferredProgramModel>> listPreferredProgramsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all customs duty programs recognized by AvaTax List all preferred customs duty programs recognized by AvaTax. A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring countries. To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effectiveDate, endDate

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listProductClassificationSystems

public FetchResult<ProductClassificationSystemModel> listProductClassificationSystems(String filter,
 Integer top,
 Integer skip,
 String orderBy,
 String countryCode)
                                                                               throws Exception

List all available product classification systems. List all available product classification systems. Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

countryCode - If not null, return all records with this code.

Returns:

FetchResult

Throws:

Exception

listProductClassificationSystemsAsync

public Future<FetchResult<ProductClassificationSystemModel>> listProductClassificationSystemsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy,
 String countryCode)

List all available product classification systems. List all available product classification systems. Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

countryCode - If not null, return all records with this code.

Returns:

FetchResult

listProductClassificationSystemsByCompany

public FetchResult<ProductClassificationSystemModel> listProductClassificationSystemsByCompany(String companyCode,
 String filter,
 Integer top,
 Integer skip,
 String orderBy,
 String countryCode)
                                                                                        throws Exception

List all product classification systems available to a company based on its nexus. Lists all product classification systems available to a company based on its nexus. Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. More than one tax authority might use the same product classification system, but they might charge different tax rates for products. NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code' Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

countryCode - If not null, return all records with this code.

Returns:

FetchResult

Throws:

Exception

listProductClassificationSystemsByCompanyAsync

public Future<FetchResult<ProductClassificationSystemModel>> listProductClassificationSystemsByCompanyAsync(String companyCode,
 String filter,
 Integer top,
 Integer skip,
 String orderBy,
 String countryCode)

List all product classification systems available to a company based on its nexus. Lists all product classification systems available to a company based on its nexus. Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. More than one tax authority might use the same product classification system, but they might charge different tax rates for products. NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code' Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

countryCode - If not null, return all records with this code.

Returns:

FetchResult

listRateTypesByCountry

public FetchResult<RateTypeModel> listRateTypesByCountry(String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                  throws Exception

Retrieve the full list of rate types for each country Returns the full list of Avalara-supported rate type file types Swagger Name: AvaTaxClient

Parameters:

country - The country to examine for rate types

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listRateTypesByCountryAsync

public Future<FetchResult<RateTypeModel>> listRateTypesByCountryAsync(String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of rate types for each country Returns the full list of Avalara-supported rate type file types Swagger Name: AvaTaxClient

Parameters:

country - The country to examine for rate types

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listRateTypesByCountryTaxTypeTaxSubType

public FetchResult<RateTypesModel> listRateTypesByCountryTaxTypeTaxSubType(String country,
 String taxTypeId,
 String taxSubTypeId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                    throws Exception

Retrieve the list of rate types by country, TaxType and by TaxSubType Returns the list of Avalara-supported rate type file types Swagger Name: AvaTaxClient

Parameters:

country - The country to examine for rate types

taxTypeId - The taxType for the country to examine for rate types

taxSubTypeId - The taxSubType for the country and taxType to examine for rate types

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, rateType, description

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listRateTypesByCountryTaxTypeTaxSubTypeAsync

public Future<FetchResult<RateTypesModel>> listRateTypesByCountryTaxTypeTaxSubTypeAsync(String country,
 String taxTypeId,
 String taxSubTypeId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the list of rate types by country, TaxType and by TaxSubType Returns the list of Avalara-supported rate type file types Swagger Name: AvaTaxClient

Parameters:

country - The country to examine for rate types

taxTypeId - The taxType for the country to examine for rate types

taxSubTypeId - The taxSubType for the country and taxType to examine for rate types

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, rateType, description

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listRegions

public FetchResult<IsoRegionModel> listRegions(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

List all ISO 3166 regions Returns a list of all ISO 3166 region codes and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listRegionsAsync

public Future<FetchResult<IsoRegionModel>> listRegionsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all ISO 3166 regions Returns a list of all ISO 3166 region codes and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listRegionsByCountry

public FetchResult<IsoRegionModel> listRegionsByCountry(String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

List all ISO 3166 regions for a country Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region Swagger Name: AvaTaxClient

Parameters:

country - The country of which you want to fetch ISO 3166 regions

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listRegionsByCountryAsync

public Future<FetchResult<IsoRegionModel>> listRegionsByCountryAsync(String country,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all ISO 3166 regions for a country Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region Swagger Name: AvaTaxClient

Parameters:

country - The country of which you want to fetch ISO 3166 regions

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listResourceFileTypes

public FetchResult<ResourceFileTypeModel> listResourceFileTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                         throws Exception

Retrieve the full list of Avalara-supported resource file types Returns the full list of Avalara-supported resource file types Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listResourceFileTypesAsync

public Future<FetchResult<ResourceFileTypeModel>> listResourceFileTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported resource file types Returns the full list of Avalara-supported resource file types Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listReturnsParametersUsage

public FetchResult<ReturnsParameterUsageModel> listReturnsParametersUsage(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                   throws Exception

Retrieve the full list of Avalara-supported usage of parameters used for returns. Returns the full list of Avalara-supported usage of extra parameters for the returns. This list of parameters is available for use with Returns. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listReturnsParametersUsageAsync

public Future<FetchResult<ReturnsParameterUsageModel>> listReturnsParametersUsageAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported usage of parameters used for returns. Returns the full list of Avalara-supported usage of extra parameters for the returns. This list of parameters is available for use with Returns. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* values

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listSecurityRoles

public FetchResult<SecurityRoleModel> listSecurityRoles(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types. This API is intended to be useful when designing a user interface for selecting the security role of a user account. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listSecurityRolesAsync

public Future<FetchResult<SecurityRoleModel>> listSecurityRolesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported permissions Returns the full list of Avalara-supported permission types. This API is intended to be useful when designing a user interface for selecting the security role of a user account. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listSubscriptionTypes

public FetchResult<SubscriptionTypeModel> listSubscriptionTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                         throws Exception

Retrieve the full list of Avalara-supported subscription types Returns the full list of Avalara-supported subscription types. This API is intended to be useful for identifying which features you have added to your account. You may always contact Avalara's sales department for information on available products or services. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listSubscriptionTypesAsync

public Future<FetchResult<SubscriptionTypeModel>> listSubscriptionTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported subscription types Returns the full list of Avalara-supported subscription types. This API is intended to be useful for identifying which features you have added to your account. You may always contact Avalara's sales department for information on available products or services. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTags

public FetchResult<TagsModel> listTags(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                throws Exception

Retrieve the list all tags supported by avalara Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTagsAsync

public Future<FetchResult<TagsModel>> listTagsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the list all tags supported by avalara Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxAuthorities

public FetchResult<TaxAuthorityModel> listTaxAuthorities(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                  throws Exception

Retrieve the full list of Avalara-supported tax authorities. Returns the full list of Avalara-supported tax authorities. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxAuthoritiesAsync

public Future<FetchResult<TaxAuthorityModel>> listTaxAuthoritiesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax authorities. Returns the full list of Avalara-supported tax authorities. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxAuthorityForms

public FetchResult<TaxAuthorityFormModel> listTaxAuthorityForms(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                         throws Exception

Retrieve the full list of Avalara-supported forms for each tax authority. Returns the full list of Avalara-supported forms for each tax authority. This list represents tax forms that Avalara recognizes. Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxAuthorityFormsAsync

public Future<FetchResult<TaxAuthorityFormModel>> listTaxAuthorityFormsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported forms for each tax authority. Returns the full list of Avalara-supported forms for each tax authority. This list represents tax forms that Avalara recognizes. Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxAuthorityTypes

public FetchResult<TaxAuthorityTypeModel> listTaxAuthorityTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                         throws Exception

Retrieve the full list of Avalara-supported tax authority types. Returns the full list of Avalara-supported tax authority types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxAuthorityTypesAsync

public Future<FetchResult<TaxAuthorityTypeModel>> listTaxAuthorityTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax authority types. Returns the full list of Avalara-supported tax authority types. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxCodes

public FetchResult<TaxCodeModel> listTaxCodes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                       throws Exception

Retrieve the full list of Avalara-supported tax codes. Retrieves the list of Avalara-supported system tax codes. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxCodesAsync

public Future<FetchResult<TaxCodeModel>> listTaxCodesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of Avalara-supported tax codes. Retrieves the list of Avalara-supported system tax codes. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxCodeTypes

public TaxCodeTypesModel listTaxCodeTypes(Integer top,
 Integer skip)
                                   throws Exception

Retrieve the full list of Avalara-supported tax code types. Returns the full list of recognized tax code types. A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode. Swagger Name: AvaTaxClient

Parameters:

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

TaxCodeTypesModel

Throws:

Exception

listTaxCodeTypesAsync

public Future<TaxCodeTypesModel> listTaxCodeTypesAsync(Integer top,
 Integer skip)

Retrieve the full list of Avalara-supported tax code types. Returns the full list of recognized tax code types. A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode. Swagger Name: AvaTaxClient

Parameters:

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

TaxCodeTypesModel

listTaxForms

public FetchResult<FormMasterModel> listTaxForms(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                          throws Exception

Retrieve the full list of the Tax Forms available Returns the full list of Avalara-supported Tax Forms Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxFormsAsync

public Future<FetchResult<FormMasterModel>> listTaxFormsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of the Tax Forms available Returns the full list of Avalara-supported Tax Forms Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxSubTypes

public FetchResult<TaxSubTypeModel> listTaxSubTypes(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                             throws Exception

Retrieve the full list of tax sub types Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxSubTypesAsync

public Future<FetchResult<TaxSubTypeModel>> listTaxSubTypesAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of tax sub types Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxSubTypesByCountryAndTaxType

public FetchResult<TaxSubTypeModel> listTaxSubTypesByCountryAndTaxType(String country,
 String taxTypeId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                throws Exception

Retrieve the full list of tax sub types by Country and TaxType Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient

Parameters:

country - The country to examine for taxsubtype

taxTypeId - The taxType for the country to examine for taxsubtype

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxSubTypesByCountryAndTaxTypeAsync

public Future<FetchResult<TaxSubTypeModel>> listTaxSubTypesByCountryAndTaxTypeAsync(String country,
 String taxTypeId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of tax sub types by Country and TaxType Returns the full list of Avalara-supported tax sub-types Swagger Name: AvaTaxClient

Parameters:

country - The country to examine for taxsubtype

taxTypeId - The taxType for the country to examine for taxsubtype

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxSubTypesByJurisdictionAndRegion

public FetchResult<TaxSubTypeModel> listTaxSubTypesByJurisdictionAndRegion(String jurisdictionCode,
 String region,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                    throws Exception

Retrieve the full list of tax sub types by jurisdiction code and region Returns the full list of Avalara-supported tax sub-types by jurisdiction and region Swagger Name: AvaTaxClient

Parameters:

jurisdictionCode - The jurisdiction code of the tax sub type.

region - The region of the tax sub type.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxSubTypesByJurisdictionAndRegionAsync

public Future<FetchResult<TaxSubTypeModel>> listTaxSubTypesByJurisdictionAndRegionAsync(String jurisdictionCode,
 String region,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of tax sub types by jurisdiction code and region Returns the full list of Avalara-supported tax sub-types by jurisdiction and region Swagger Name: AvaTaxClient

Parameters:

jurisdictionCode - The jurisdiction code of the tax sub type.

region - The region of the tax sub type.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxTypeGroups

public FetchResult<TaxTypeGroupModel> listTaxTypeGroups(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

Retrieve the full list of tax type groups Returns the full list of Avalara-supported tax type groups Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxTypeGroupsAsync

public Future<FetchResult<TaxTypeGroupModel>> listTaxTypeGroupsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the full list of tax type groups Returns the full list of Avalara-supported tax type groups Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listTaxTypesByNexusAndCountry

public FetchResult<TaxTypeModel> listTaxTypesByNexusAndCountry(String country,
 Integer companyId,
 Integer top,
 Integer skip,
 String orderBy)
                                                        throws Exception

Retrieve the list of applicable TaxTypes Swagger Name: AvaTaxClient

Parameters:

country - The country for which you want to retrieve the unitofbasis information

companyId - Your companyId to retrieve the applicable taxtypes

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxTypesByNexusAndCountryAsync

public Future<FetchResult<TaxTypeModel>> listTaxTypesByNexusAndCountryAsync(String country,
 Integer companyId,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the list of applicable TaxTypes Swagger Name: AvaTaxClient

Parameters:

country - The country for which you want to retrieve the unitofbasis information

companyId - Your companyId to retrieve the applicable taxtypes

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType

public FetchResult<UnitOfBasisModel> listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType(String country,
 String taxTypeId,
 String taxSubTypeId,
 String rateTypeId,
 Integer top,
 Integer skip,
 String orderBy)
                                                                                         throws Exception

Retrieve the list of applicable UnitOfBasis Swagger Name: AvaTaxClient

Parameters:

country - The country for which you want to retrieve the unitofbasis information

taxTypeId - The taxtype for which you want to retrieve the unitofbasis information

taxSubTypeId - The taxsubtype for which you want to retrieve the unitofbasis information

rateTypeId - The ratetype for which you want to retrieve the unitofbasis information

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateTypeAsync

public Future<FetchResult<UnitOfBasisModel>> listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateTypeAsync(String country,
 String taxTypeId,
 String taxSubTypeId,
 String rateTypeId,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve the list of applicable UnitOfBasis Swagger Name: AvaTaxClient

Parameters:

country - The country for which you want to retrieve the unitofbasis information

taxTypeId - The taxtype for which you want to retrieve the unitofbasis information

taxSubTypeId - The taxsubtype for which you want to retrieve the unitofbasis information

rateTypeId - The ratetype for which you want to retrieve the unitofbasis information

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listUnitOfMeasurement

public FetchResult<UomModel> listUnitOfMeasurement(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                            throws Exception

List all defined units of measurement List all units of measurement systems defined by Avalara. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listUnitOfMeasurementAsync

public Future<FetchResult<UomModel>> listUnitOfMeasurementAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all defined units of measurement List all units of measurement systems defined by Avalara. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

createDistanceThreshold

public ArrayList<CompanyDistanceThresholdModel> createDistanceThreshold(Integer companyId,
 ArrayList<CompanyDistanceThresholdModel> model)
                                                                 throws Exception

Create one or more DistanceThreshold objects Create one or more DistanceThreshold objects for this company. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that owns this DistanceThreshold

model - The DistanceThreshold object or objects you wish to create.

Returns:

ArrayList

Throws:

Exception

createDistanceThresholdAsync

public Future<ArrayList<CompanyDistanceThresholdModel>> createDistanceThresholdAsync(Integer companyId,
 ArrayList<CompanyDistanceThresholdModel> model)

Create one or more DistanceThreshold objects Create one or more DistanceThreshold objects for this company. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that owns this DistanceThreshold

model - The DistanceThreshold object or objects you wish to create.

Returns:

ArrayList

deleteDistanceThreshold

public ArrayList<ErrorDetail> deleteDistanceThreshold(Integer companyId,
 Long id)
                                               throws Exception

Delete a single DistanceThreshold object Marks the DistanceThreshold object identified by this URL as deleted. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that owns this DistanceThreshold

id - The unique ID number of the DistanceThreshold object you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteDistanceThresholdAsync

public Future<ArrayList<ErrorDetail>> deleteDistanceThresholdAsync(Integer companyId,
 Long id)

Delete a single DistanceThreshold object Marks the DistanceThreshold object identified by this URL as deleted. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that owns this DistanceThreshold

id - The unique ID number of the DistanceThreshold object you wish to delete.

Returns:

ArrayList

getDistanceThreshold

public CompanyDistanceThresholdModel getDistanceThreshold(Integer companyId,
 Long id)
                                                   throws Exception

Retrieve a single DistanceThreshold Retrieves a single DistanceThreshold object defined by this URL. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this DistanceThreshold object

id - The unique ID number referring to this DistanceThreshold object

Returns:

CompanyDistanceThresholdModel

Throws:

Exception

getDistanceThresholdAsync

public Future<CompanyDistanceThresholdModel> getDistanceThresholdAsync(Integer companyId,
 Long id)

Retrieve a single DistanceThreshold Retrieves a single DistanceThreshold object defined by this URL. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this DistanceThreshold object

id - The unique ID number referring to this DistanceThreshold object

Returns:

CompanyDistanceThresholdModel

listDistanceThresholds

public FetchResult<CompanyDistanceThresholdModel> listDistanceThresholds(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                                  throws Exception

Retrieve all DistanceThresholds for this company. Lists all DistanceThreshold objects that belong to this company. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company whose DistanceThreshold objects you wish to list.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listDistanceThresholdsAsync

public Future<FetchResult<CompanyDistanceThresholdModel>> listDistanceThresholdsAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all DistanceThresholds for this company. Lists all DistanceThreshold objects that belong to this company. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company whose DistanceThreshold objects you wish to list.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryDistanceThresholds

public FetchResult<CompanyDistanceThresholdModel> queryDistanceThresholds(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                                   throws Exception

Retrieve all DistanceThreshold objects Lists all DistanceThreshold objects that belong to this account. 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. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryDistanceThresholdsAsync

public Future<FetchResult<CompanyDistanceThresholdModel>> queryDistanceThresholdsAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all DistanceThreshold objects Lists all DistanceThreshold objects that belong to this account. 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. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateDistanceThreshold

public CompanyDistanceThresholdModel updateDistanceThreshold(Integer companyId,
 Long id,
 CompanyDistanceThresholdModel model)
                                                      throws Exception

Update a DistanceThreshold object Replace the existing DistanceThreshold object at this URL with an updated object. 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. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that owns this DistanceThreshold object.

id - The unique ID number of the DistanceThreshold object to replace.

model - The new DistanceThreshold object to store.

Returns:

CompanyDistanceThresholdModel

Throws:

Exception

updateDistanceThresholdAsync

public Future<CompanyDistanceThresholdModel> updateDistanceThresholdAsync(Integer companyId,
 Long id,
 CompanyDistanceThresholdModel model)

Update a DistanceThreshold object Replace the existing DistanceThreshold object at this URL with an updated object. 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. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company that owns this DistanceThreshold object.

id - The unique ID number of the DistanceThreshold object to replace.

model - The new DistanceThreshold object to store.

Returns:

CompanyDistanceThresholdModel

createECommerceToken

public ECommerceTokenOutputModel createECommerceToken(Integer companyId,
 CreateECommerceTokenInputModel model)
                                               throws Exception

Create a new eCommerce token. Creates a new eCommerce token. This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The company ID that will be issued this certificate.

model -

Returns:

ECommerceTokenOutputModel

Throws:

Exception

createECommerceTokenAsync

public Future<ECommerceTokenOutputModel> createECommerceTokenAsync(Integer companyId,
 CreateECommerceTokenInputModel model)

Create a new eCommerce token. Creates a new eCommerce token. This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The company ID that will be issued this certificate.

model -

Returns:

ECommerceTokenOutputModel

refreshECommerceToken

public FetchResult<ECommerceTokenOutputModel> refreshECommerceToken(Integer companyId,
 RefreshECommerceTokenInputModel model)
                                                             throws Exception

Refresh an eCommerce token. Refresh an eCommerce token. CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The company ID that the refreshed certificate belongs to.

model -

Returns:

FetchResult

Throws:

Exception

refreshECommerceTokenAsync

public Future<FetchResult<ECommerceTokenOutputModel>> refreshECommerceTokenAsync(Integer companyId,
 RefreshECommerceTokenInputModel model)

Refresh an eCommerce token. Refresh an eCommerce token. CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The company ID that the refreshed certificate belongs to.

model -

Returns:

FetchResult

approveFirmClientLinkage

public FirmClientLinkageOutputModel approveFirmClientLinkage(Integer id)
                                                      throws Exception

Approves linkage to a firm for a client account This API enables the account admin of a client account to approve linkage request by a firm. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

approveFirmClientLinkageAsync

public Future<FirmClientLinkageOutputModel> approveFirmClientLinkageAsync(Integer id)

Approves linkage to a firm for a client account This API enables the account admin of a client account to approve linkage request by a firm. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

createAndLinkNewFirmClientAccount

public FirmClientLinkageOutputModel createAndLinkNewFirmClientAccount(NewFirmClientAccountRequestModel model)
                                                               throws Exception

Request a new FirmClient account and create an approved linkage to it This API is for use by Firms only. Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. Firms can create accounts of FirmClient for customers they are managing using this API. Calling this API creates an account with the specified product subscriptions, but without a new user for account. Account is then linked to the Firm so they can managed their returns. You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm. The created account will be created in `Active` status but there will be no user or license key associated with account. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. Swagger Name: AvaTaxClient

Parameters:

model - Information about the account you wish to create.

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

createAndLinkNewFirmClientAccountAsync

public Future<FirmClientLinkageOutputModel> createAndLinkNewFirmClientAccountAsync(NewFirmClientAccountRequestModel model)

Request a new FirmClient account and create an approved linkage to it This API is for use by Firms only. Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. Firms can create accounts of FirmClient for customers they are managing using this API. Calling this API creates an account with the specified product subscriptions, but without a new user for account. Account is then linked to the Firm so they can managed their returns. You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm. The created account will be created in `Active` status but there will be no user or license key associated with account. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. Swagger Name: AvaTaxClient

Parameters:

model - Information about the account you wish to create.

Returns:

FirmClientLinkageOutputModel

createFirmClientLinkage

public FirmClientLinkageOutputModel createFirmClientLinkage(FirmClientLinkageInputModel model)
                                                     throws Exception

Links a firm account with the client account This API enables the firm admins/firm users to request the linkage of a firm account and a client account. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - FirmClientLinkageInputModel

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

createFirmClientLinkageAsync

public Future<FirmClientLinkageOutputModel> createFirmClientLinkageAsync(FirmClientLinkageInputModel model)

Links a firm account with the client account This API enables the firm admins/firm users to request the linkage of a firm account and a client account. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - FirmClientLinkageInputModel

Returns:

FirmClientLinkageOutputModel

deleteFirmClientLinkage

public ArrayList<ErrorDetail> deleteFirmClientLinkage(Integer id)
                                               throws Exception

Delete a linkage This API marks a linkage between a firm and client as deleted. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

ArrayList

Throws:

Exception

deleteFirmClientLinkageAsync

public Future<ArrayList<ErrorDetail>> deleteFirmClientLinkageAsync(Integer id)

Delete a linkage This API marks a linkage between a firm and client as deleted. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

ArrayList

getFirmClientLinkage

public FirmClientLinkageOutputModel getFirmClientLinkage(Integer id)
                                                  throws Exception

Get linkage between a firm and client by id This API enables the firm admins/firm users to request the linkage of a firm account and a client account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

getFirmClientLinkageAsync

public Future<FirmClientLinkageOutputModel> getFirmClientLinkageAsync(Integer id)

Get linkage between a firm and client by id This API enables the firm admins/firm users to request the linkage of a firm account and a client account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

listFirmClientLinkage

public FetchResult<FirmClientLinkageOutputModel> listFirmClientLinkage(String filter)
                                                                throws Exception

List client linkages for a firm or client This API enables the firm or account users to request the associated linkages to the account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName

Returns:

FetchResult

Throws:

Exception

listFirmClientLinkageAsync

public Future<FetchResult<FirmClientLinkageOutputModel>> listFirmClientLinkageAsync(String filter)

List client linkages for a firm or client This API enables the firm or account users to request the associated linkages to the account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName

Returns:

FetchResult

rejectFirmClientLinkage

public FirmClientLinkageOutputModel rejectFirmClientLinkage(Integer id)
                                                     throws Exception

Rejects linkage to a firm for a client account This API enables the account admin of a client account to reject linkage request by a firm. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

rejectFirmClientLinkageAsync

public Future<FirmClientLinkageOutputModel> rejectFirmClientLinkageAsync(Integer id)

Rejects linkage to a firm for a client account This API enables the account admin of a client account to reject linkage request by a firm. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

resetFirmClientLinkage

public FirmClientLinkageOutputModel resetFirmClientLinkage(Integer id)
                                                    throws Exception

Reset linkage status between a client and firm back to requested This API enables the firm admin of a client account to reset a previously created linkage request by a firm. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

resetFirmClientLinkageAsync

public Future<FirmClientLinkageOutputModel> resetFirmClientLinkageAsync(Integer id)

Reset linkage status between a client and firm back to requested This API enables the firm admin of a client account to reset a previously created linkage request by a firm. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

revokeFirmClientLinkage

public FirmClientLinkageOutputModel revokeFirmClientLinkage(Integer id)
                                                     throws Exception

Revokes previously approved linkage to a firm for a client account This API enables the account admin of a client account to revoke a previously approved linkage request by a firm. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

Throws:

Exception

revokeFirmClientLinkageAsync

public Future<FirmClientLinkageOutputModel> revokeFirmClientLinkageAsync(Integer id)

Revokes previously approved linkage to a firm for a client account This API enables the account admin of a client account to revoke a previously approved linkage request by a firm. ### Security Policies * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id -

Returns:

FirmClientLinkageOutputModel

requestFreeTrial

public NewAccountModel requestFreeTrial(FreeTrialRequestModel model)
                                 throws Exception

FREE API - Request a free trial of AvaTax Call this API to obtain a free AvaTax account. This API is free to use. No authentication credentials are required to call this API. You must read and accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be created. If all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/). After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/). ### Security Policies * This API may be called without providing authentication credentials. Swagger Name: AvaTaxClient

Parameters:

model - Required information to provision a free trial account.

Returns:

NewAccountModel

Throws:

Exception

requestFreeTrialAsync

public Future<NewAccountModel> requestFreeTrialAsync(FreeTrialRequestModel model)

FREE API - Request a free trial of AvaTax Call this API to obtain a free AvaTax account. This API is free to use. No authentication credentials are required to call this API. You must read and accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be created. If all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/). After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/). ### Security Policies * This API may be called without providing authentication credentials. Swagger Name: AvaTaxClient

Parameters:

model - Required information to provision a free trial account.

Returns:

NewAccountModel

activateFundingRequest

public FundingStatusModel activateFundingRequest(Long id)
                                          throws Exception

Request the javascript for a funding setup widget This API is available by invitation only. Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are required to setup their funding configuration before Avalara can begin filing tax returns on their behalf. Funding configuration for each company is set up by submitting a funding setup request, which can be sent either via email or via an embedded HTML widget. When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members before approval. This API returns back the actual javascript code to insert into your application to render the JavaScript funding setup widget inline. Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page. This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security 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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of this funding request

Returns:

FundingStatusModel

Throws:

Exception

activateFundingRequestAsync

public Future<FundingStatusModel> activateFundingRequestAsync(Long id)

Request the javascript for a funding setup widget This API is available by invitation only. Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are required to setup their funding configuration before Avalara can begin filing tax returns on their behalf. Funding configuration for each company is set up by submitting a funding setup request, which can be sent either via email or via an embedded HTML widget. When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members before approval. This API returns back the actual javascript code to insert into your application to render the JavaScript funding setup widget inline. Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page. This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security 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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of this funding request

Returns:

FundingStatusModel

fundingRequestStatus

public FundingStatusModel fundingRequestStatus(Integer id)
                                        throws Exception

Retrieve status about a funding setup request This API is available by invitation only. Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are required to setup their funding configuration before Avalara can begin filing tax returns on their behalf. Funding configuration for each company is set up by submitting a funding setup request, which can be sent either via email or via an embedded HTML widget. When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members before approval. This API checks the status on an existing funding request. This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of this funding request

Returns:

FundingStatusModel

Throws:

Exception

fundingRequestStatusAsync

public Future<FundingStatusModel> fundingRequestStatusAsync(Integer id)

Retrieve status about a funding setup request This API is available by invitation only. Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are required to setup their funding configuration before Avalara can begin filing tax returns on their behalf. Funding configuration for each company is set up by submitting a funding setup request, which can be sent either via email or via an embedded HTML widget. When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members before approval. This API checks the status on an existing funding request. This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of this funding request

Returns:

FundingStatusModel

batchDeleteItemClassifications

public ArrayList<ErrorDetail> batchDeleteItemClassifications(Integer companyId,
 Long itemId)
                                                      throws Exception

Delete all classifications for an item Delete all the classifications for a given item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

itemId - The ID of the item you wish to delete the classifications.

Returns:

ArrayList

Throws:

Exception

batchDeleteItemClassificationsAsync

public Future<ArrayList<ErrorDetail>> batchDeleteItemClassificationsAsync(Integer companyId,
 Long itemId)

Delete all classifications for an item Delete all the classifications for a given item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

itemId - The ID of the item you wish to delete the classifications.

Returns:

ArrayList

batchDeleteItemParameters

public ArrayList<ErrorDetail> batchDeleteItemParameters(Integer companyId,
 Long itemId)
                                                 throws Exception

Delete all parameters for an item Delete all the parameters for a given item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

itemId - The ID of the item you wish to delete the parameters.

Returns:

ArrayList

Throws:

Exception

batchDeleteItemParametersAsync

public Future<ArrayList<ErrorDetail>> batchDeleteItemParametersAsync(Integer companyId,
 Long itemId)

Delete all parameters for an item Delete all the parameters for a given item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

itemId - The ID of the item you wish to delete the parameters.

Returns:

ArrayList

bulkUploadItems

public ItemBulkUploadOutputModel bulkUploadItems(Integer companyId,
 ItemBulkUploadInputModel model)
                                          throws Exception

Bulk upload items from a product catalog Create/Update one or more item objects attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. The tax code takes precedence over the tax code id if both are provided. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this items.

model - The items you wish to upload.

Returns:

ItemBulkUploadOutputModel

Throws:

Exception

bulkUploadItemsAsync

public Future<ItemBulkUploadOutputModel> bulkUploadItemsAsync(Integer companyId,
 ItemBulkUploadInputModel model)

Bulk upload items from a product catalog Create/Update one or more item objects attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. The tax code takes precedence over the tax code id if both are provided. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this items.

model - The items you wish to upload.

Returns:

ItemBulkUploadOutputModel

createItemClassifications

public ArrayList<ItemClassificationOutputModel> createItemClassifications(Integer companyId,
 Long itemId,
 ArrayList<ItemClassificationInputModel> model)
                                                                   throws Exception

Add classifications to an item. Add classifications to an item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. An item may only have one classification per tax system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

model - The item classifications you wish to create.

Returns:

ArrayList

Throws:

Exception

createItemClassificationsAsync

public Future<ArrayList<ItemClassificationOutputModel>> createItemClassificationsAsync(Integer companyId,
 Long itemId,
 ArrayList<ItemClassificationInputModel> model)

Add classifications to an item. Add classifications to an item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. An item may only have one classification per tax system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

model - The item classifications you wish to create.

Returns:

ArrayList

createItemParameters

public ArrayList<ItemParameterModel> createItemParameters(Integer companyId,
 Long itemId,
 ArrayList<ItemParameterModel> model)
                                                   throws Exception

Add parameters to an item. Add parameters to an item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item parameter.

itemId - The item id.

model - The item parameters you wish to create.

Returns:

ArrayList

Throws:

Exception

createItemParametersAsync

public Future<ArrayList<ItemParameterModel>> createItemParametersAsync(Integer companyId,
 Long itemId,
 ArrayList<ItemParameterModel> model)

Add parameters to an item. Add parameters to an item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item parameter.

itemId - The item id.

model - The item parameters you wish to create.

Returns:

ArrayList

createItems

public ArrayList<ItemModel> createItems(Integer companyId,
 ArrayList<ItemModel> model)
                                 throws Exception

Create a new item Creates one or more new item objects attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. The tax code takes precedence over the tax code id if both are provided. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

model - The item you wish to create.

Returns:

ArrayList

Throws:

Exception

createItemsAsync

public Future<ArrayList<ItemModel>> createItemsAsync(Integer companyId,
 ArrayList<ItemModel> model)

Create a new item Creates one or more new item objects attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. The tax code takes precedence over the tax code id if both are provided. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

model - The item you wish to create.

Returns:

ArrayList

createItemTags

public ArrayList<ItemTagDetailModel> createItemTags(Integer companyId,
 Integer itemId,
 ArrayList<ItemTagDetailModel> model)
                                             throws Exception

Create tags for a item Creates one or more new `Tag` objects attached to this Item. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

itemId - The ID of the item as defined by the company that owns this tag.

model - Tags you wish to associate with the Item

Returns:

ArrayList

Throws:

Exception

createItemTagsAsync

public Future<ArrayList<ItemTagDetailModel>> createItemTagsAsync(Integer companyId,
 Integer itemId,
 ArrayList<ItemTagDetailModel> model)

Create tags for a item Creates one or more new `Tag` objects attached to this Item. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

itemId - The ID of the item as defined by the company that owns this tag.

model - Tags you wish to associate with the Item

Returns:

ArrayList

createTaxCodeClassificationRequest

public ItemTaxCodeClassificationRequestOutputModel createTaxCodeClassificationRequest(Integer companyId,
 ItemTaxCodeClassificationRequestInputModel model)
                                                                               throws Exception

Create a new tax code classification request Creates a new tax code classification request. Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes, allowing them to take advantage of thousands of tax rules in the AvaTax engine and resulting in accurate taxability determinations. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company creating this request.

model - The request you wish to create.

Returns:

ItemTaxCodeClassificationRequestOutputModel

Throws:

Exception

createTaxCodeClassificationRequestAsync

public Future<ItemTaxCodeClassificationRequestOutputModel> createTaxCodeClassificationRequestAsync(Integer companyId,
 ItemTaxCodeClassificationRequestInputModel model)

Create a new tax code classification request Creates a new tax code classification request. Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes, allowing them to take advantage of thousands of tax rules in the AvaTax engine and resulting in accurate taxability determinations. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company creating this request.

model - The request you wish to create.

Returns:

ItemTaxCodeClassificationRequestOutputModel

deleteCatalogueItem

public ArrayList<ErrorDetail> deleteCatalogueItem(Integer companyId,
 String itemCode)
                                           throws Exception

Delete a single item Deletes the item object at this URL. Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to delete an existing item with item code. Deleting an item will also delete the parameters, classifications, and product categories associated with that item. NOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code' * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

itemCode - The code of the item you want to delete.

Returns:

ArrayList

Throws:

Exception

deleteCatalogueItemAsync

public Future<ArrayList<ErrorDetail>> deleteCatalogueItemAsync(Integer companyId,
 String itemCode)

Delete a single item Deletes the item object at this URL. Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to delete an existing item with item code. Deleting an item will also delete the parameters, classifications, and product categories associated with that item. NOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code' * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

itemCode - The code of the item you want to delete.

Returns:

ArrayList

deleteItem

public ArrayList<ErrorDetail> deleteItem(Integer companyId,
 Long id)
                                  throws Exception

Delete a single item Deletes the item object at this URL. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Deleting an item will also delete the parameters and classifications associated with that item. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

id - The ID of the item you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteItemAsync

public Future<ArrayList<ErrorDetail>> deleteItemAsync(Integer companyId,
 Long id)

Delete a single item Deletes the item object at this URL. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Deleting an item will also delete the parameters and classifications associated with that item. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

id - The ID of the item you wish to delete.

Returns:

ArrayList

deleteItemClassification

public ArrayList<ErrorDetail> deleteItemClassification(Integer companyId,
 Long itemId,
 Long id)
                                                throws Exception

Delete a single item classification. Delete a single item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

id - The item classification id.

Returns:

ArrayList

Throws:

Exception

deleteItemClassificationAsync

public Future<ArrayList<ErrorDetail>> deleteItemClassificationAsync(Integer companyId,
 Long itemId,
 Long id)

Delete a single item classification. Delete a single item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

id - The item classification id.

Returns:

ArrayList

deleteItemParameter

public ArrayList<ErrorDetail> deleteItemParameter(Integer companyId,
 Long itemId,
 Long id)
                                           throws Exception

Delete a single item parameter Delete a single item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

itemId - The item id

id - The parameter id

Returns:

ArrayList

Throws:

Exception

deleteItemParameterAsync

public Future<ArrayList<ErrorDetail>> deleteItemParameterAsync(Integer companyId,
 Long itemId,
 Long id)

Delete a single item parameter Delete a single item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

itemId - The item id

id - The parameter id

Returns:

ArrayList

deleteItemTag

public ArrayList<ErrorDetail> deleteItemTag(Integer companyId,
 Long itemId,
 Integer itemTagDetailId)
                                     throws Exception

Delete item tag by id Deletes the `Tag` object of an Item at this URL. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

itemId - The ID of the item as defined by the company that owns this tag.

itemTagDetailId - The ID of the item tag detail you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteItemTagAsync

public Future<ArrayList<ErrorDetail>> deleteItemTagAsync(Integer companyId,
 Long itemId,
 Integer itemTagDetailId)

Delete item tag by id Deletes the `Tag` object of an Item at this URL. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

itemId - The ID of the item as defined by the company that owns this tag.

itemTagDetailId - The ID of the item tag detail you wish to delete.

Returns:

ArrayList

deleteItemTags

public ArrayList<ErrorDetail> deleteItemTags(Integer companyId,
 Long itemId)
                                      throws Exception

Delete all item tags Deletes all `Tags` objects of an Item at this URL. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items.

itemId - The ID of the item as defined by the company that owns this tag.

Returns:

ArrayList

Throws:

Exception

deleteItemTagsAsync

public Future<ArrayList<ErrorDetail>> deleteItemTagsAsync(Integer companyId,
 Long itemId)

Delete all item tags Deletes all `Tags` objects of an Item at this URL. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items.

itemId - The ID of the item as defined by the company that owns this tag.

Returns:

ArrayList

getClassificationStatus

public FetchResult<ItemTaxCodeClassificationRequestStatusOutputModel> getClassificationStatus(Integer companyId,
 Boolean includeClassificationDetails,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                                       throws Exception

Get the status of classification requests for a company Get the status of tax code classification requests for a company. Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes, allowing them to take advantage of thousands of tax rules in the AvaTax engine and resulting in accurate taxability determinations. Enable includeClassificationDetails flag to get details of classification request status. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

includeClassificationDetails - A Boolean field that specifies whether to get a detailed classification status.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* classificationDetails, totalItems, status

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

getClassificationStatusAsync

public Future<FetchResult<ItemTaxCodeClassificationRequestStatusOutputModel>> getClassificationStatusAsync(Integer companyId,
 Boolean includeClassificationDetails,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Get the status of classification requests for a company Get the status of tax code classification requests for a company. Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes, allowing them to take advantage of thousands of tax rules in the AvaTax engine and resulting in accurate taxability determinations. Enable includeClassificationDetails flag to get details of classification request status. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

includeClassificationDetails - A Boolean field that specifies whether to get a detailed classification status.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* classificationDetails, totalItems, status

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

getItem

public ItemModel getItem(Integer companyId,
 Long id,
 String include)
                  throws Exception

Retrieve a single item Get the `Item` object identified by this URL. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item object

id - The primary key of this item

include - A comma separated list of additional data to retrieve.

Returns:

ItemModel

Throws:

Exception

getItemAsync

public Future<ItemModel> getItemAsync(Integer companyId,
 Long id,
 String include)

Retrieve a single item Get the `Item` object identified by this URL. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item object

id - The primary key of this item

include - A comma separated list of additional data to retrieve.

Returns:

ItemModel

getItemClassification

public ItemClassificationOutputModel getItemClassification(Integer companyId,
 Long itemId,
 Long id)
                                                    throws Exception

Retrieve a single item classification. Retrieve a single item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

id - The item classification id.

Returns:

ItemClassificationOutputModel

Throws:

Exception

getItemClassificationAsync

public Future<ItemClassificationOutputModel> getItemClassificationAsync(Integer companyId,
 Long itemId,
 Long id)

Retrieve a single item classification. Retrieve a single item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

id - The item classification id.

Returns:

ItemClassificationOutputModel

getItemParameter

public ItemParameterModel getItemParameter(Integer companyId,
 Long itemId,
 Long id)
                                    throws Exception

Retrieve a single item parameter Retrieve a single item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

itemId - The item id

id - The parameter id

Returns:

ItemParameterModel

Throws:

Exception

getItemParameterAsync

public Future<ItemParameterModel> getItemParameterAsync(Integer companyId,
 Long itemId,
 Long id)

Retrieve a single item parameter Retrieve a single item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

itemId - The item id

id - The parameter id

Returns:

ItemParameterModel

getItemTags

public FetchResult<ItemTagDetailModel> getItemTags(Integer companyId,
 Long itemId,
 String filter,
 Integer top,
 Integer skip)
                                            throws Exception

Retrieve tags for an item Get the `Tag` objects of an Item identified by this URL. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

itemId - The ID of the item as defined by the company that owns this tag.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

FetchResult

Throws:

Exception

getItemTagsAsync

public Future<FetchResult<ItemTagDetailModel>> getItemTagsAsync(Integer companyId,
 Long itemId,
 String filter,
 Integer top,
 Integer skip)

Retrieve tags for an item Get the `Tag` objects of an Item identified by this URL. Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

itemId - The ID of the item as defined by the company that owns this tag.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

Returns:

FetchResult

getPremiumClassification

public ItemPremiumClassificationOutputModel getPremiumClassification(Integer companyId,
 String itemCode,
 String systemCode)
                                                              throws Exception

Retrieve premium classification for a company's item based on its ItemCode and SystemCode. Retrieves the premium classification for an ItemCode and SystemCode. NOTE: If your item code contains any of these characters /, +, ?,",' ,% or #, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code' * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item object

itemCode - The ItemCode of the item for which you want to retrieve premium classification

systemCode - The SystemCode for which you want to retrieve premium classification

Returns:

ItemPremiumClassificationOutputModel

Throws:

Exception

getPremiumClassificationAsync

public Future<ItemPremiumClassificationOutputModel> getPremiumClassificationAsync(Integer companyId,
 String itemCode,
 String systemCode)

Retrieve premium classification for a company's item based on its ItemCode and SystemCode. Retrieves the premium classification for an ItemCode and SystemCode. NOTE: If your item code contains any of these characters /, +, ?,",' ,% or #, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code' * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item object

itemCode - The ItemCode of the item for which you want to retrieve premium classification

systemCode - The SystemCode for which you want to retrieve premium classification

Returns:

ItemPremiumClassificationOutputModel

getTaxCodeRecommendations

public FetchResult<ItemTaxCodeRecommendationsOutputModel> getTaxCodeRecommendations(Integer companyId,
 Integer requestId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                             throws Exception

Get tax code recommendations Get tax code recommendations. Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes, allowing them to take advantage of thousands of tax rules in the AvaTax engine and resulting in accurate taxability determinations. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

requestId - The ID of the classification request

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* recommendations, url

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

getTaxCodeRecommendationsAsync

public Future<FetchResult<ItemTaxCodeRecommendationsOutputModel>> getTaxCodeRecommendationsAsync(Integer companyId,
 Integer requestId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Get tax code recommendations Get tax code recommendations. Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes, allowing them to take advantage of thousands of tax rules in the AvaTax engine and resulting in accurate taxability determinations. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

requestId - The ID of the classification request

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* recommendations, url

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listImportRestrictions

public FetchResult<ItemRestrictionOutputModel> listImportRestrictions(Integer companyId,
 String itemCode,
 String countryOfImport,
 Integer top,
 Integer skip,
 String orderBy)
                                                               throws Exception

Retrieve Restrictions for Item by CountryOfImport Retrieve Restrictions for Item by CountryOfImport. This API will only return import restriction for the countryOfImport. NOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code' * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item object

itemCode - ItemCode for the item

countryOfImport - Country for which you want the restrictions for the Item.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listImportRestrictionsAsync

public Future<FetchResult<ItemRestrictionOutputModel>> listImportRestrictionsAsync(Integer companyId,
 String itemCode,
 String countryOfImport,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve Restrictions for Item by CountryOfImport Retrieve Restrictions for Item by CountryOfImport. This API will only return import restriction for the countryOfImport. NOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code' * Replace '+' with '\_-ava2b-\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code' * Replace '?' with '\_-ava3f-\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code' * Replace '%' with '\_-ava25-\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code' * Replace '#' with '\_-ava23-\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code' * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code' * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code' ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item object

itemCode - ItemCode for the item

countryOfImport - Country for which you want the restrictions for the Item.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listItemClassifications

public FetchResult<ItemClassificationOutputModel> listItemClassifications(Integer companyId,
 Long itemId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                                   throws Exception

Retrieve classifications for an item. List classifications for an item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. Search for specific objects using the criteria in the `$filter` classification; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` classifications. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listItemClassificationsAsync

public Future<FetchResult<ItemClassificationOutputModel>> listItemClassificationsAsync(Integer companyId,
 Long itemId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve classifications for an item. List classifications for an item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. Search for specific objects using the criteria in the `$filter` classification; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` classifications. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listItemParameters

public FetchResult<ItemParameterModel> listItemParameters(Integer companyId,
 Long itemId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                   throws Exception

Retrieve parameters for an item List parameters for an item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

itemId - The item id

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listItemParametersAsync

public Future<FetchResult<ItemParameterModel>> listItemParametersAsync(Integer companyId,
 Long itemId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve parameters for an item List parameters for an item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

itemId - The item id

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listItemsByCompany

public FetchResult<ItemModel> listItemsByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy,
 String tagName)
                                          throws Exception

Retrieve items for this company List all items defined for the current company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify Tag Name in the `tagName` query parameter if you want to filter items on the basis of tagName You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Parameters * Classifications * Tags ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, upc, classifications, parameters, tags

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

tagName - Tag Name on the basis of which you want to filter Items

Returns:

FetchResult

Throws:

Exception

listItemsByCompanyAsync

public Future<FetchResult<ItemModel>> listItemsByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy,
 String tagName)

Retrieve items for this company List all items defined for the current company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify Tag Name in the `tagName` query parameter if you want to filter items on the basis of tagName You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Parameters * Classifications * Tags ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, upc, classifications, parameters, tags

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

tagName - Tag Name on the basis of which you want to filter Items

Returns:

FetchResult

queryItems

public FetchResult<ItemModel> queryItems(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                  throws Exception

Retrieve all items Get multiple item objects across all companies. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, upc, classifications, parameters, tags

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryItemsAsync

public Future<FetchResult<ItemModel>> queryItemsAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all items Get multiple item objects across all companies. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, upc, classifications, parameters, tags

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryItemsByTag

public FetchResult<ItemModel> queryItemsByTag(Integer companyId,
 String tag,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                       throws Exception

Retrieve all items associated with given tag Get multiple item objects associated with given tag. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items.

tag - The master tag to be associated with item.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, upc, classifications, parameters, tags

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryItemsByTagAsync

public Future<FetchResult<ItemModel>> queryItemsByTagAsync(Integer companyId,
 String tag,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all items associated with given tag Get multiple item objects associated with given tag. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that defined these items.

tag - The master tag to be associated with item.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, upc, classifications, parameters, tags

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

syncItemCatalogue

public ItemCatalogueOutputModel syncItemCatalogue(Integer companyId,
 ArrayList<ItemCatalogueInputModel> model)
                                           throws Exception

Create or update items from a product catalog. Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to create a new or update an existing item. This can be used to sync the items with Avalara. For example, an accounting software system can use this to sync all their items from an ERP with Avalara. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

model - The items you want to create or update.

Returns:

ItemCatalogueOutputModel

Throws:

Exception

syncItemCatalogueAsync

public Future<ItemCatalogueOutputModel> syncItemCatalogueAsync(Integer companyId,
 ArrayList<ItemCatalogueInputModel> model)

Create or update items from a product catalog. Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to create a new or update an existing item. This can be used to sync the items with Avalara. For example, an accounting software system can use this to sync all their items from an ERP with Avalara. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

model - The items you want to create or update.

Returns:

ItemCatalogueOutputModel

syncItems

public SyncItemsResponseModel syncItems(Integer companyId,
 SyncItemsRequestModel model)
                                 throws Exception

Sync items from a product catalog Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs with AvaTax. Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information. This API is currently limited to 1000 items per call (the limit is subject to change). Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

model - The request object.

Returns:

SyncItemsResponseModel

Throws:

Exception

syncItemsAsync

public Future<SyncItemsResponseModel> syncItemsAsync(Integer companyId,
 SyncItemsRequestModel model)

Sync items from a product catalog Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs with AvaTax. Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information. This API is currently limited to 1000 items per call (the limit is subject to change). Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this item.

model - The request object.

Returns:

SyncItemsResponseModel

updateItem

public ItemModel updateItem(Integer companyId,
 Long id,
 ItemModel model)
                     throws Exception

Update a single item Replace the existing `Item` object at this URL with an updated object. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. The tax code takes precedence over the tax code id if both are provided. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this item belongs to.

id - The ID of the item you wish to update

model - The item object you wish to update.

Returns:

ItemModel

Throws:

Exception

updateItemAsync

public Future<ItemModel> updateItemAsync(Integer companyId,
 Long id,
 ItemModel model)

Update a single item Replace the existing `Item` object at this URL with an updated object. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. The tax code takes precedence over the tax code id if both are provided. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this item belongs to.

id - The ID of the item you wish to update

model - The item object you wish to update.

Returns:

ItemModel

updateItemClassification

public ItemClassificationOutputModel updateItemClassification(Integer companyId,
 Long itemId,
 Long id,
 ItemClassificationInputModel model)
                                                       throws Exception

Update an item classification. Update an item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. An item may only have one classification per tax system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

id - The item classification id.

model - The item object you wish to update.

Returns:

ItemClassificationOutputModel

Throws:

Exception

updateItemClassificationAsync

public Future<ItemClassificationOutputModel> updateItemClassificationAsync(Integer companyId,
 Long itemId,
 Long id,
 ItemClassificationInputModel model)

Update an item classification. Update an item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. An item may only have one classification per tax system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id.

id - The item classification id.

model - The item object you wish to update.

Returns:

ItemClassificationOutputModel

updateItemParameter

public ItemParameterModel updateItemParameter(Integer companyId,
 Long itemId,
 Long id,
 ItemParameterModel model)
                                       throws Exception

Update an item parameter Update an item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id

id - The item parameter id

model - The item object you wish to update.

Returns:

ItemParameterModel

Throws:

Exception

updateItemParameterAsync

public Future<ItemParameterModel> updateItemParameterAsync(Integer companyId,
 Long itemId,
 Long id,
 ItemParameterModel model)

Update an item parameter Update an item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

itemId - The item id

id - The item parameter id

model - The item object you wish to update.

Returns:

ItemParameterModel

createJurisdictionOverrides

public ArrayList<JurisdictionOverrideModel> createJurisdictionOverrides(Integer accountId,
 ArrayList<JurisdictionOverrideModel> model)
                                                                 throws Exception

Create one or more overrides Creates one or more jurisdiction override objects for this account. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

model - The jurisdiction override objects to create

Returns:

ArrayList

Throws:

Exception

createJurisdictionOverridesAsync

public Future<ArrayList<JurisdictionOverrideModel>> createJurisdictionOverridesAsync(Integer accountId,
 ArrayList<JurisdictionOverrideModel> model)

Create one or more overrides Creates one or more jurisdiction override objects for this account. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

model - The jurisdiction override objects to create

Returns:

ArrayList

deleteJurisdictionOverride

public ArrayList<ErrorDetail> deleteJurisdictionOverride(Integer accountId,
 Integer id)
                                                  throws Exception

Delete a single override Marks the item object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

id - The ID of the override you wish to delete

Returns:

ArrayList

Throws:

Exception

deleteJurisdictionOverrideAsync

public Future<ArrayList<ErrorDetail>> deleteJurisdictionOverrideAsync(Integer accountId,
 Integer id)

Delete a single override Marks the item object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

id - The ID of the override you wish to delete

Returns:

ArrayList

getJurisdictionOverride

public JurisdictionOverrideModel getJurisdictionOverride(Integer accountId,
 Integer id)
                                                  throws Exception

Retrieve a single override Get the item object identified by this URL. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

id - The primary key of this override

Returns:

JurisdictionOverrideModel

Throws:

Exception

getJurisdictionOverrideAsync

public Future<JurisdictionOverrideModel> getJurisdictionOverrideAsync(Integer accountId,
 Integer id)

Retrieve a single override Get the item object identified by this URL. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

id - The primary key of this override

Returns:

JurisdictionOverrideModel

listJurisdictionOverridesByAccount

public FetchResult<JurisdictionOverrideModel> listJurisdictionOverridesByAccount(Integer accountId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                                          throws Exception

Retrieve overrides for this account List all jurisdiction override objects defined for this account. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listJurisdictionOverridesByAccountAsync

public Future<FetchResult<JurisdictionOverrideModel>> listJurisdictionOverridesByAccountAsync(Integer accountId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve overrides for this account List all jurisdiction override objects defined for this account. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this override

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryJurisdictionOverrides

public FetchResult<JurisdictionOverrideModel> queryJurisdictionOverrides(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                                  throws Exception

Retrieve all overrides Get multiple jurisdiction override objects across all companies. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryJurisdictionOverridesAsync

public Future<FetchResult<JurisdictionOverrideModel>> queryJurisdictionOverridesAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all overrides Get multiple jurisdiction override objects across all companies. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateJurisdictionOverride

public JurisdictionOverrideModel updateJurisdictionOverride(Integer accountId,
 Integer id,
 JurisdictionOverrideModel model)
                                                     throws Exception

Update a single jurisdictionoverride Replace the existing jurisdictionoverride object at this URL with an updated object. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that this jurisdictionoverride belongs to.

id - The ID of the jurisdictionoverride you wish to update

model - The jurisdictionoverride object you wish to update.

Returns:

JurisdictionOverrideModel

Throws:

Exception

updateJurisdictionOverrideAsync

public Future<JurisdictionOverrideModel> updateJurisdictionOverrideAsync(Integer accountId,
 Integer id,
 JurisdictionOverrideModel model)

Update a single jurisdictionoverride Replace the existing jurisdictionoverride object at this URL with an updated object. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that this jurisdictionoverride belongs to.

id - The ID of the jurisdictionoverride you wish to update

model - The jurisdictionoverride object you wish to update.

Returns:

JurisdictionOverrideModel

createLocationParameters

public ArrayList<LocationParameterModel> createLocationParameters(Integer companyId,
 Integer locationId,
 ArrayList<LocationParameterModel> model)
                                                           throws Exception

Add parameters to a location. Add parameters to a location. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. To see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location parameter.

locationId - The location id.

model - The location parameters you wish to create.

Returns:

ArrayList

Throws:

Exception

createLocationParametersAsync

public Future<ArrayList<LocationParameterModel>> createLocationParametersAsync(Integer companyId,
 Integer locationId,
 ArrayList<LocationParameterModel> model)

Add parameters to a location. Add parameters to a location. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. To see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location parameter.

locationId - The location id.

model - The location parameters you wish to create.

Returns:

ArrayList

createLocations

public ArrayList<LocationModel> createLocations(Integer companyId,
 ArrayList<LocationModel> model)
                                         throws Exception

Create a new location Create one or more new location objects attached to this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location.

model - The location you wish to create.

Returns:

ArrayList

Throws:

Exception

createLocationsAsync

public Future<ArrayList<LocationModel>> createLocationsAsync(Integer companyId,
 ArrayList<LocationModel> model)

Create a new location Create one or more new location objects attached to this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location.

model - The location you wish to create.

Returns:

ArrayList

deleteLocation

public ArrayList<ErrorDetail> deleteLocation(Integer companyId,
 Integer id)
                                      throws Exception

Delete a single location Mark the location object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location.

id - The ID of the location you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteLocationAsync

public Future<ArrayList<ErrorDetail>> deleteLocationAsync(Integer companyId,
 Integer id)

Delete a single location Mark the location object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location.

id - The ID of the location you wish to delete.

Returns:

ArrayList

deleteLocationParameter

public ArrayList<ErrorDetail> deleteLocationParameter(Integer companyId,
 Integer locationId,
 Long id)
                                               throws Exception

Delete a single location parameter Delete a single location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

locationId - The location id

id - The parameter id

Returns:

ArrayList

Throws:

Exception

deleteLocationParameterAsync

public Future<ArrayList<ErrorDetail>> deleteLocationParameterAsync(Integer companyId,
 Integer locationId,
 Long id)

Delete a single location parameter Delete a single location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

locationId - The location id

id - The parameter id

Returns:

ArrayList

getLocation

public LocationModel getLocation(Integer companyId,
 Integer id,
 String include)
                          throws Exception

Retrieve a single location Get the location object identified by this URL. An 'Location' represents a physical address where a company does business. Many taxing authorities require that you define a list of all locations where your company does business. These locations may require additional custom configuration or tax registration with these authorities. For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * LocationSettings * parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location

id - The primary key of this location

include - A comma separated list of additional data to retrieve.

Returns:

LocationModel

Throws:

Exception

getLocationAsync

public Future<LocationModel> getLocationAsync(Integer companyId,
 Integer id,
 String include)

Retrieve a single location Get the location object identified by this URL. An 'Location' represents a physical address where a company does business. Many taxing authorities require that you define a list of all locations where your company does business. These locations may require additional custom configuration or tax registration with these authorities. For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * LocationSettings * parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location

id - The primary key of this location

include - A comma separated list of additional data to retrieve.

Returns:

LocationModel

getLocationParameter

public LocationParameterModel getLocationParameter(Integer companyId,
 Integer locationId,
 Long id)
                                            throws Exception

Retrieve a single company location parameter Retrieve a single location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

locationId - The location id

id - The parameter id

Returns:

LocationParameterModel

Throws:

Exception

getLocationParameterAsync

public Future<LocationParameterModel> getLocationParameterAsync(Integer companyId,
 Integer locationId,
 Long id)

Retrieve a single company location parameter Retrieve a single location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

locationId - The location id

id - The parameter id

Returns:

LocationParameterModel

listLocationParameters

public FetchResult<LocationParameterModel> listLocationParameters(Integer companyId,
 Integer locationId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                           throws Exception

Retrieve parameters for a location List parameters for a location. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

locationId - The ID of the location

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listLocationParametersAsync

public Future<FetchResult<LocationParameterModel>> listLocationParametersAsync(Integer companyId,
 Integer locationId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve parameters for a location List parameters for a location. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

locationId - The ID of the location

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listLocationsByCompany

public FetchResult<LocationModel> listLocationsByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                  throws Exception

Retrieve locations for this company List all location objects defined for this company. An 'Location' represents a physical address where a company does business. Many taxing authorities require that you define a list of all locations where your company does business. These locations may require additional custom configuration or tax registration with these authorities. For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * LocationSettings * parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these locations

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listLocationsByCompanyAsync

public Future<FetchResult<LocationModel>> listLocationsByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve locations for this company List all location objects defined for this company. An 'Location' represents a physical address where a company does business. Many taxing authorities require that you define a list of all locations where your company does business. These locations may require additional custom configuration or tax registration with these authorities. For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * LocationSettings * parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these locations

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryLocations

public FetchResult<LocationModel> queryLocations(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                          throws Exception

Retrieve all locations Get multiple location objects across all companies. An 'Location' represents a physical address where a company does business. Many taxing authorities require that you define a list of all locations where your company does business. These locations may require additional custom configuration or tax registration with these authorities. For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * LocationSettings * parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters

include - A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryLocationsAsync

public Future<FetchResult<LocationModel>> queryLocationsAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all locations Get multiple location objects across all companies. An 'Location' represents a physical address where a company does business. Many taxing authorities require that you define a list of all locations where your company does business. These locations may require additional custom configuration or tax registration with these authorities. For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * LocationSettings * parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters

include - A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateLocation

public LocationModel updateLocation(Integer companyId,
 Integer id,
 LocationModel model)
                             throws Exception

Update a single location Replace the existing location object at this URL with an updated object. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this location belongs to.

id - The ID of the location you wish to update

model - The location you wish to update.

Returns:

LocationModel

Throws:

Exception

updateLocationAsync

public Future<LocationModel> updateLocationAsync(Integer companyId,
 Integer id,
 LocationModel model)

Update a single location Replace the existing location object at this URL with an updated object. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this location belongs to.

id - The ID of the location you wish to update

model - The location you wish to update.

Returns:

LocationModel

updateLocationParameter

public LocationParameterModel updateLocationParameter(Integer companyId,
 Integer locationId,
 Long id,
 LocationParameterModel model)
                                               throws Exception

Update a location parameter Update a location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

locationId - The location id

id - The location parameter id

model - The location parameter object you wish to update.

Returns:

LocationParameterModel

Throws:

Exception

updateLocationParameterAsync

public Future<LocationParameterModel> updateLocationParameterAsync(Integer companyId,
 Integer locationId,
 Long id,
 LocationParameterModel model)

Update a location parameter Update a location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

locationId - The location id

id - The location parameter id

model - The location parameter object you wish to update.

Returns:

LocationParameterModel

validateLocation

public LocationValidationModel validateLocation(Integer companyId,
 Integer id)
                                         throws Exception

Validate the location against local requirements Returns validation information for this location. This API call is intended to compare this location against the currently known taxing authority rules and regulations, and provide information about what additional work is required to completely setup this location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location

id - The primary key of this location

Returns:

LocationValidationModel

Throws:

Exception

validateLocationAsync

public Future<LocationValidationModel> validateLocationAsync(Integer companyId,
 Integer id)

Validate the location against local requirements Returns validation information for this location. This API call is intended to compare this location against the currently known taxing authority rules and regulations, and provide information about what additional work is required to completely setup this location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this location

id - The primary key of this location

Returns:

LocationValidationModel

adjustMultiDocumentTransaction

public MultiDocumentModel adjustMultiDocumentTransaction(String code,
 DocumentType type,
 String include,
 AdjustMultiDocumentModel model)
                                                  throws Exception

Adjust a MultiDocument transaction Adjusts the current MultiDocument transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you adjust a transaction, that transaction's status is recorded as `Adjusted`. Both the revisions will be available for retrieval based on their code and ID numbers. Only transactions in Committed status can be reported on a tax filing by Avalara's Managed Returns Service. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are no longer available for adjustments. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The transaction code for this MultiDocument transaction

type - The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The adjust request you wish to execute

Returns:

MultiDocumentModel

Throws:

Exception

adjustMultiDocumentTransactionAsync

public Future<MultiDocumentModel> adjustMultiDocumentTransactionAsync(String code,
 DocumentType type,
 String include,
 AdjustMultiDocumentModel model)

Adjust a MultiDocument transaction Adjusts the current MultiDocument transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you adjust a transaction, that transaction's status is recorded as `Adjusted`. Both the revisions will be available for retrieval based on their code and ID numbers. Only transactions in Committed status can be reported on a tax filing by Avalara's Managed Returns Service. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are no longer available for adjustments. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The transaction code for this MultiDocument transaction

type - The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The adjust request you wish to execute

Returns:

MultiDocumentModel

auditMultiDocumentTransaction

public AuditMultiDocumentModel auditMultiDocumentTransaction(String code,
 DocumentType type)
                                                      throws Exception

Get audit information about a MultiDocument transaction Retrieve audit information about a MultiDocument transaction stored in AvaTax. The audit API retrieves audit information related to a specific MultiDocument transaction. This audit information includes the following: * The `code` of the MultiDocument transaction * The `type` of the MultiDocument transaction * The server timestamp representing the exact server time when the transaction was created * The server duration - how long it took to process this transaction * Whether exact API call details were logged * A reconstructed API call showing what the original create call looked like A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The transaction code for this MultiDocument transaction

type - The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)

Returns:

AuditMultiDocumentModel

Throws:

Exception

auditMultiDocumentTransactionAsync

public Future<AuditMultiDocumentModel> auditMultiDocumentTransactionAsync(String code,
 DocumentType type)

Get audit information about a MultiDocument transaction Retrieve audit information about a MultiDocument transaction stored in AvaTax. The audit API retrieves audit information related to a specific MultiDocument transaction. This audit information includes the following: * The `code` of the MultiDocument transaction * The `type` of the MultiDocument transaction * The server timestamp representing the exact server time when the transaction was created * The server duration - how long it took to process this transaction * Whether exact API call details were logged * A reconstructed API call showing what the original create call looked like A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The transaction code for this MultiDocument transaction

type - The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)

Returns:

AuditMultiDocumentModel

commitMultiDocumentTransaction

public MultiDocumentModel commitMultiDocumentTransaction(CommitMultiDocumentModel model)
                                                  throws Exception

Commit a MultiDocument transaction Marks a list of transactions by changing its status to `Committed`. Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). Any changes made to a committed transaction will generate a transaction history. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

model - The commit request you wish to execute

Returns:

MultiDocumentModel

Throws:

Exception

commitMultiDocumentTransactionAsync

public Future<MultiDocumentModel> commitMultiDocumentTransactionAsync(CommitMultiDocumentModel model)

Commit a MultiDocument transaction Marks a list of transactions by changing its status to `Committed`. Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). Any changes made to a committed transaction will generate a transaction history. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

model - The commit request you wish to execute

Returns:

MultiDocumentModel

createMultiDocumentTransaction

public MultiDocumentModel createMultiDocumentTransaction(String include,
 CreateMultiDocumentModel model)
                                                  throws Exception

Create a new MultiDocument transaction Records a new MultiDocument transaction in AvaTax. 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. This API will report an error if you attempt to create a transaction when one already exists with the specified `code`. If you would like the API to automatically update the transaction when it already exists, please set the `allowAdjust` value to `true`. To generate a refund for a transaction, use the `RefundTransaction` API. The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded. The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please provide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode information in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated using the best available address location information. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - the multi document transaction model

Returns:

MultiDocumentModel

Throws:

Exception

createMultiDocumentTransactionAsync

public Future<MultiDocumentModel> createMultiDocumentTransactionAsync(String include,
 CreateMultiDocumentModel model)

Create a new MultiDocument transaction Records a new MultiDocument transaction in AvaTax. 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. This API will report an error if you attempt to create a transaction when one already exists with the specified `code`. If you would like the API to automatically update the transaction when it already exists, please set the `allowAdjust` value to `true`. To generate a refund for a transaction, use the `RefundTransaction` API. The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded. The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please provide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode information in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated using the best available address location information. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - the multi document transaction model

Returns:

MultiDocumentModel

getMultiDocumentTransactionByCodeAndType

public MultiDocumentModel getMultiDocumentTransactionByCodeAndType(String code,
 DocumentType type,
 String include)
                                                            throws Exception

Retrieve a MultiDocument transaction Get the current MultiDocument transaction identified by this URL. If this transaction was adjusted, the return value of this API will be the current transaction with this code. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The multidocument code to retrieve

type - The transaction type to retrieve (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in the response after transaction is created

Returns:

MultiDocumentModel

Throws:

Exception

getMultiDocumentTransactionByCodeAndTypeAsync

public Future<MultiDocumentModel> getMultiDocumentTransactionByCodeAndTypeAsync(String code,
 DocumentType type,
 String include)

Retrieve a MultiDocument transaction Get the current MultiDocument transaction identified by this URL. If this transaction was adjusted, the return value of this API will be the current transaction with this code. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The multidocument code to retrieve

type - The transaction type to retrieve (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in the response after transaction is created

Returns:

MultiDocumentModel

getMultiDocumentTransactionById

public MultiDocumentModel getMultiDocumentTransactionById(Long id,
 String include)
                                                   throws Exception

Retrieve a MultiDocument transaction by ID Get the unique MultiDocument transaction identified by this URL. 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. This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted by using the `AdjustTransaction` endpoint. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of the MultiDocument transaction to retrieve

include - Specifies objects to include in the response after transaction is created

Returns:

MultiDocumentModel

Throws:

Exception

getMultiDocumentTransactionByIdAsync

public Future<MultiDocumentModel> getMultiDocumentTransactionByIdAsync(Long id,
 String include)

Retrieve a MultiDocument transaction by ID Get the unique MultiDocument transaction identified by this URL. 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. This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted by using the `AdjustTransaction` endpoint. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of the MultiDocument transaction to retrieve

include - Specifies objects to include in the response after transaction is created

Returns:

MultiDocumentModel

listMultiDocumentTransactions

public FetchResult<MultiDocumentModel> listMultiDocumentTransactions(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                              throws Exception

Retrieve all MultiDocument transactions List all MultiDocument transactions within this account. This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument transactions, please use the pagination features of the API. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documents

include - Specifies objects to include in the response after transaction is created

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listMultiDocumentTransactionsAsync

public Future<FetchResult<MultiDocumentModel>> listMultiDocumentTransactionsAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all MultiDocument transactions List all MultiDocument transactions within this account. This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument transactions, please use the pagination features of the API. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documents

include - Specifies objects to include in the response after transaction is created

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

refundMultiDocumentTransaction

public MultiDocumentModel refundMultiDocumentTransaction(String code,
 DocumentType type,
 String include,
 RefundTransactionModel model)
                                                  throws Exception

Create a refund for a MultiDocument transaction Create a refund for a MultiDocument transaction. 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. The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund for a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and specify individual line items from the original sale for refund. The `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that was calculated during the original transaction, regardless of any changes to your company's configuration, rules, nexus, or any other setting. This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following common refund scenarios: * A full refund of a previous sale * Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase * Refunding one or more items (lines) from a previous sale * Granting a customer a percentage refund of a previous sale For more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to create a custom refund transaction. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The code of this MultiDocument transaction

type - The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in the response after transaction is created

model - Information about the refund to create

Returns:

MultiDocumentModel

Throws:

Exception

refundMultiDocumentTransactionAsync

public Future<MultiDocumentModel> refundMultiDocumentTransactionAsync(String code,
 DocumentType type,
 String include,
 RefundTransactionModel model)

Create a refund for a MultiDocument transaction Create a refund for a MultiDocument transaction. 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. The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund for a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and specify individual line items from the original sale for refund. The `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that was calculated during the original transaction, regardless of any changes to your company's configuration, rules, nexus, or any other setting. This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following common refund scenarios: * A full refund of a previous sale * Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase * Refunding one or more items (lines) from a previous sale * Granting a customer a percentage refund of a previous sale For more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to create a custom refund transaction. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The code of this MultiDocument transaction

type - The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in the response after transaction is created

model - Information about the refund to create

Returns:

MultiDocumentModel

verifyMultiDocumentTransaction

public MultiDocumentModel verifyMultiDocumentTransaction(VerifyMultiDocumentModel model)
                                                  throws Exception

Verify a MultiDocument transaction Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values. If the transaction does not match these expected values, this API will return an error code indicating which value did not match. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

model - Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax

Returns:

MultiDocumentModel

Throws:

Exception

verifyMultiDocumentTransactionAsync

public Future<MultiDocumentModel> verifyMultiDocumentTransactionAsync(VerifyMultiDocumentModel model)

Verify a MultiDocument transaction Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values. If the transaction does not match these expected values, this API will return an error code indicating which value did not match. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

model - Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax

Returns:

MultiDocumentModel

voidMultiDocumentTransaction

public MultiDocumentModel voidMultiDocumentTransaction(String code,
 DocumentType type,
 VoidTransactionModel model)
                                                throws Exception

Void a MultiDocument transaction Voids the current transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you void a transaction, that transaction's status is recorded as `DocVoided`. Transactions that have been previously reported to a tax authority by Avalara Managed Returns Service are considered `locked`, and they are no longer available to be voided. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The transaction code for this MultiDocument transaction

type - The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)

model - The void request you wish to execute

Returns:

MultiDocumentModel

Throws:

Exception

voidMultiDocumentTransactionAsync

public Future<MultiDocumentModel> voidMultiDocumentTransactionAsync(String code,
 DocumentType type,
 VoidTransactionModel model)

Void a MultiDocument transaction Voids the current transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you void a transaction, that transaction's status is recorded as `DocVoided`. Transactions that have been previously reported to a tax authority by Avalara Managed Returns Service are considered `locked`, and they are no longer available to be voided. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

code - The transaction code for this MultiDocument transaction

type - The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)

model - The void request you wish to execute

Returns:

MultiDocumentModel

createNexus

public ArrayList<NexusModel> createNexus(Integer companyId,
 ArrayList<NexusModel> model)
                                  throws Exception

Create a new nexus Creates one or more new nexus declarations attached to this company. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. 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. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus.

model - The nexus you wish to create.

Returns:

ArrayList

Throws:

Exception

createNexusAsync

public Future<ArrayList<NexusModel>> createNexusAsync(Integer companyId,
 ArrayList<NexusModel> model)

Create a new nexus Creates one or more new nexus declarations attached to this company. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. 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. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus.

model - The nexus you wish to create.

Returns:

ArrayList

createNexusParameters

public ArrayList<NexusParameterDetailModel> createNexusParameters(Integer companyId,
 Integer nexusId,
 ArrayList<NexusParameterDetailModel> model)
                                                           throws Exception

Add parameters to a nexus. Add parameters to the nexus. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus parameter.

nexusId - The nexus id.

model - The nexus parameters you wish to create.

Returns:

ArrayList

Throws:

Exception

createNexusParametersAsync

public Future<ArrayList<NexusParameterDetailModel>> createNexusParametersAsync(Integer companyId,
 Integer nexusId,
 ArrayList<NexusParameterDetailModel> model)

Add parameters to a nexus. Add parameters to the nexus. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus parameter.

nexusId - The nexus id.

model - The nexus parameters you wish to create.

Returns:

ArrayList

declareNexusByAddress

public ArrayList<NexusByAddressModel> declareNexusByAddress(Integer companyId,
 ArrayList<DeclareNexusByAddressModel> model)
                                                     throws Exception

Creates nexus for a list of addresses. This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this API declares nexus for this company, for the list of addresses provided, for the date range provided. You may also use this API to extend effective date on an already-declared nexus. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the '/api/v2/definitions/nexus' endpoint. You may only define nexus matching the official list of declared nexus. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that will own this nexus.

model - The nexus you wish to create.

Returns:

ArrayList

Throws:

Exception

declareNexusByAddressAsync

public Future<ArrayList<NexusByAddressModel>> declareNexusByAddressAsync(Integer companyId,
 ArrayList<DeclareNexusByAddressModel> model)

Creates nexus for a list of addresses. This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this API declares nexus for this company, for the list of addresses provided, for the date range provided. You may also use this API to extend effective date on an already-declared nexus. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the '/api/v2/definitions/nexus' endpoint. You may only define nexus matching the official list of declared nexus. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that will own this nexus.

model - The nexus you wish to create.

Returns:

ArrayList

deleteNexus

public ArrayList<ErrorDetail> deleteNexus(Integer companyId,
 Integer id,
 Boolean cascadeDelete)
                                   throws Exception

Delete a single nexus Marks the existing nexus object at this URL as deleted. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus.

id - The ID of the nexus you wish to delete.

cascadeDelete - If true, deletes all the child nexus if they exist along with parent nexus

Returns:

ArrayList

Throws:

Exception

deleteNexusAsync

public Future<ArrayList<ErrorDetail>> deleteNexusAsync(Integer companyId,
 Integer id,
 Boolean cascadeDelete)

Delete a single nexus Marks the existing nexus object at this URL as deleted. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus.

id - The ID of the nexus you wish to delete.

cascadeDelete - If true, deletes all the child nexus if they exist along with parent nexus

Returns:

ArrayList

deleteNexusParameter

public ArrayList<ErrorDetail> deleteNexusParameter(Integer companyId,
 Integer nexusId,
 Long id)
                                            throws Exception

Delete a single nexus parameter Delete a single nexus parameter. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

nexusId - The nexus id

id - The parameter id

Returns:

ArrayList

Throws:

Exception

deleteNexusParameterAsync

public Future<ArrayList<ErrorDetail>> deleteNexusParameterAsync(Integer companyId,
 Integer nexusId,
 Long id)

Delete a single nexus parameter Delete a single nexus parameter. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

nexusId - The nexus id

id - The parameter id

Returns:

ArrayList

deleteNexusParameters

public ArrayList<ErrorDetail> deleteNexusParameters(Integer companyId,
 Integer nexusId)
                                             throws Exception

Delete all parameters for an nexus Delete all the parameters for a given nexus. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus.

nexusId - The ID of the nexus you wish to delete the parameters.

Returns:

ArrayList

Throws:

Exception

deleteNexusParametersAsync

public Future<ArrayList<ErrorDetail>> deleteNexusParametersAsync(Integer companyId,
 Integer nexusId)

Delete all parameters for an nexus Delete all the parameters for a given nexus. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus.

nexusId - The ID of the nexus you wish to delete the parameters.

Returns:

ArrayList

getNexus

public NexusModel getNexus(Integer companyId,
 Integer id,
 String include)
                    throws Exception

Retrieve a single nexus Get the nexus object identified by this URL. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus object

id - The primary key of this nexus

include -

Returns:

NexusModel

Throws:

Exception

getNexusAsync

public Future<NexusModel> getNexusAsync(Integer companyId,
 Integer id,
 String include)

Retrieve a single nexus Get the nexus object identified by this URL. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus object

id - The primary key of this nexus

include -

Returns:

NexusModel

getNexusByFormCode

public NexusByTaxFormModel getNexusByFormCode(Integer companyId,
 String formCode,
 String include)
                                       throws Exception

List company nexus related to a tax form Retrieves a list of nexus related to a tax form. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. This API is intended to provide useful information when examining a tax form. If you are about to begin filing a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus object

formCode - The form code that we are looking up the nexus for

include -

Returns:

NexusByTaxFormModel

Throws:

Exception

getNexusByFormCodeAsync

public Future<NexusByTaxFormModel> getNexusByFormCodeAsync(Integer companyId,
 String formCode,
 String include)

List company nexus related to a tax form Retrieves a list of nexus related to a tax form. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. This API is intended to provide useful information when examining a tax form. If you are about to begin filing a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this nexus object

formCode - The form code that we are looking up the nexus for

include -

Returns:

NexusByTaxFormModel

getNexusParameter

public NexusParameterDetailModel getNexusParameter(Integer companyId,
 Integer nexusId,
 Long id)
                                            throws Exception

Retrieve a single nexus parameter Retrieve a single nexus parameter. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

nexusId - The nexus id

id - The parameter id

Returns:

NexusParameterDetailModel

Throws:

Exception

getNexusParameterAsync

public Future<NexusParameterDetailModel> getNexusParameterAsync(Integer companyId,
 Integer nexusId,
 Long id)

Retrieve a single nexus parameter Retrieve a single nexus parameter. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

nexusId - The nexus id

id - The parameter id

Returns:

NexusParameterDetailModel

listNexusByCompany

public FetchResult<NexusModel> listNexusByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                           throws Exception

Retrieve nexus for this company List all nexus objects defined for this company. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these nexus objects

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusByCompanyAsync

public Future<FetchResult<NexusModel>> listNexusByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve nexus for this company List all nexus objects defined for this company. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these nexus objects

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusByCompanyAndTaxTypeGroup

public FetchResult<NexusModel> listNexusByCompanyAndTaxTypeGroup(Integer companyId,
 String taxTypeGroup,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                          throws Exception

Retrieve nexus for this company By TaxTypeGroup List all nexus objects defined for this company filtered by TaxTypeGroup. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these nexus objects

taxTypeGroup - Name of TaxTypeGroup to filter by

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusByCompanyAndTaxTypeGroupAsync

public Future<FetchResult<NexusModel>> listNexusByCompanyAndTaxTypeGroupAsync(Integer companyId,
 String taxTypeGroup,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve nexus for this company By TaxTypeGroup List all nexus objects defined for this company filtered by TaxTypeGroup. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these nexus objects

taxTypeGroup - Name of TaxTypeGroup to filter by

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

listNexusParameters

public FetchResult<NexusParameterDetailModel> listNexusParameters(Integer companyId,
 Integer nexusId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                           throws Exception

Retrieve parameters for a nexus List parameters for a nexus. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

nexusId - The nexus id

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNexusParametersAsync

public Future<FetchResult<NexusParameterDetailModel>> listNexusParametersAsync(Integer companyId,
 Integer nexusId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve parameters for a nexus List parameters for a nexus. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id

nexusId - The nexus id

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryNexus

public FetchResult<NexusModel> queryNexus(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                   throws Exception

Retrieve all nexus Get multiple nexus objects across all companies. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryNexusAsync

public Future<FetchResult<NexusModel>> queryNexusAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all nexus Get multiple nexus objects across all companies. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateNexus

public NexusModel updateNexus(Integer companyId,
 Integer id,
 NexusModel model)
                       throws Exception

Update a single nexus Replace the existing nexus declaration object at this URL with an updated object. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. 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. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this nexus belongs to.

id - The ID of the nexus you wish to update

model - The nexus object you wish to update.

Returns:

NexusModel

Throws:

Exception

updateNexusAsync

public Future<NexusModel> updateNexusAsync(Integer companyId,
 Integer id,
 NexusModel model)

Update a single nexus Replace the existing nexus declaration object at this URL with an updated object. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. 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. Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this nexus belongs to.

id - The ID of the nexus you wish to update

model - The nexus object you wish to update.

Returns:

NexusModel

updateNexusParameter

public NexusParameterDetailModel updateNexusParameter(Integer companyId,
 Integer nexusId,
 Long id,
 NexusParameterDetailModel model)
                                               throws Exception

Update an nexus parameter Update an nexus parameter. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added. A parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this? ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

nexusId - The nexus id

id - The nexus parameter id

model - The nexus object you wish to update.

Returns:

NexusParameterDetailModel

Throws:

Exception

updateNexusParameterAsync

public Future<NexusParameterDetailModel> updateNexusParameterAsync(Integer companyId,
 Integer nexusId,
 Long id,
 NexusParameterDetailModel model)

Update an nexus parameter Update an nexus parameter. Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added. A parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this? ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The company id.

nexusId - The nexus id

id - The nexus parameter id

model - The nexus object you wish to update.

Returns:

NexusParameterDetailModel

createNoticeResponsibilityType

public NoticeResponsibilityModel createNoticeResponsibilityType(CreateNoticeResponsibilityTypeModel model)
                                                         throws Exception

Creates a new tax notice responsibility type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - The responsibility type to create

Returns:

NoticeResponsibilityModel

Throws:

Exception

createNoticeResponsibilityTypeAsync

public Future<NoticeResponsibilityModel> createNoticeResponsibilityTypeAsync(CreateNoticeResponsibilityTypeModel model)

Creates a new tax notice responsibility type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - The responsibility type to create

Returns:

NoticeResponsibilityModel

createNoticeRootCauseType

public NoticeRootCauseModel createNoticeRootCauseType(CreateNoticeRootCauseTypeModel model)
                                               throws Exception

Creates a new tax notice root cause type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - The root cause type to create

Returns:

NoticeRootCauseModel

Throws:

Exception

createNoticeRootCauseTypeAsync

public Future<NoticeRootCauseModel> createNoticeRootCauseTypeAsync(CreateNoticeRootCauseTypeModel model)

Creates a new tax notice root cause type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - The root cause type to create

Returns:

NoticeRootCauseModel

deleteNoticeResponsibilityType

public ArrayList<ErrorDetail> deleteNoticeResponsibilityType(Integer responsibilityId)
                                                      throws Exception

Delete a tax notice responsibility type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

responsibilityId - The unique ID of the responsibility type

Returns:

ArrayList

Throws:

Exception

deleteNoticeResponsibilityTypeAsync

public Future<ArrayList<ErrorDetail>> deleteNoticeResponsibilityTypeAsync(Integer responsibilityId)

Delete a tax notice responsibility type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

responsibilityId - The unique ID of the responsibility type

Returns:

ArrayList

deleteNoticeRootCauseType

public ArrayList<ErrorDetail> deleteNoticeRootCauseType(Integer rootCauseId)
                                                 throws Exception

Delete a tax notice root cause type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

rootCauseId - The unique ID of the root cause type

Returns:

ArrayList

Throws:

Exception

deleteNoticeRootCauseTypeAsync

public Future<ArrayList<ErrorDetail>> deleteNoticeRootCauseTypeAsync(Integer rootCauseId)

Delete a tax notice root cause type. This API is available by invitation only and only available for users with Compliance admin access. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

rootCauseId - The unique ID of the root cause type

Returns:

ArrayList

dismissNotification

public NotificationModel dismissNotification(Long id)
                                      throws Exception

Mark a single notification as dismissed. Marks the notification identified by this URL as dismissed. 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. When you dismiss a notification, the notification will track the user and time when it was dismissed. You can then later review which employees of your company dismissed notifications to determine if they were resolved appropriately. A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification you wish to mark as dismissed.

Returns:

NotificationModel

Throws:

Exception

dismissNotificationAsync

public Future<NotificationModel> dismissNotificationAsync(Long id)

Mark a single notification as dismissed. Marks the notification identified by this URL as dismissed. 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. When you dismiss a notification, the notification will track the user and time when it was dismissed. You can then later review which employees of your company dismissed notifications to determine if they were resolved appropriately. A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification you wish to mark as dismissed.

Returns:

NotificationModel

getNotification

public NotificationModel getNotification(Long id)
                                  throws Exception

Retrieve a single notification. Retrieve a single notification by its unique ID number. 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. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification to retrieve.

Returns:

NotificationModel

Throws:

Exception

getNotificationAsync

public Future<NotificationModel> getNotificationAsync(Long id)

Retrieve a single notification. Retrieve a single notification by its unique ID number. 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. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification to retrieve.

Returns:

NotificationModel

listNotifications

public FetchResult<NotificationModel> listNotifications(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                 throws Exception

List all notifications. List all notifications. 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. You may search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listNotificationsAsync

public Future<FetchResult<NotificationModel>> listNotificationsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

List all notifications. List all notifications. 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. You may search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

requestNewAccount

public NewAccountModel requestNewAccount(NewAccountRequestModel model)
                                  throws Exception

Request a new Avalara account This API is for use by partner provisioning services customers only. Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features of AvaTax. These partners can create accounts for new customers using this API. Calling this API creates an account with the specified product subscriptions, but does not configure billing. The customer will receive information from Avalara about how to configure billing for their account. You should call this API when a customer has requested to begin using Avalara services. If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara terms and conditions. If they do so, they can receive a license key as part of this API and their API will be created in `Active` status. If the customer has not yet read and accepted these terms and conditions, the account will be created in `New` status and they can receive a license key by logging onto the AvaTax website and reviewing terms and conditions online. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. Swagger Name: AvaTaxClient

Parameters:

model - Information about the account you wish to create and the selected product offerings.

Returns:

NewAccountModel

Throws:

Exception

requestNewAccountAsync

public Future<NewAccountModel> requestNewAccountAsync(NewAccountRequestModel model)

Request a new Avalara account This API is for use by partner provisioning services customers only. Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features of AvaTax. These partners can create accounts for new customers using this API. Calling this API creates an account with the specified product subscriptions, but does not configure billing. The customer will receive information from Avalara about how to configure billing for their account. You should call this API when a customer has requested to begin using Avalara services. If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara terms and conditions. If they do so, they can receive a license key as part of this API and their API will be created in `Active` status. If the customer has not yet read and accepted these terms and conditions, the account will be created in `New` status and they can receive a license key by logging onto the AvaTax website and reviewing terms and conditions online. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. Swagger Name: AvaTaxClient

Parameters:

model - Information about the account you wish to create and the selected product offerings.

Returns:

NewAccountModel

requestNewEntitlement

public OfferModel requestNewEntitlement(Integer id,
 String offer)
                                 throws Exception

Request a new entitilement to an existing customer This API is for use by partner provisioning services customers only. This will allow the partners to allow the add new entitlement to an existing customer ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. Swagger Name: AvaTaxClient

Parameters:

id - The avatax account id of the customer

offer - The offer to be added to an already existing customer

Returns:

OfferModel

Throws:

Exception

requestNewEntitlementAsync

public Future<OfferModel> requestNewEntitlementAsync(Integer id,
 String offer)

Request a new entitilement to an existing customer This API is for use by partner provisioning services customers only. This will allow the partners to allow the add new entitlement to an existing customer ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. Swagger Name: AvaTaxClient

Parameters:

id - The avatax account id of the customer

offer - The offer to be added to an already existing customer

Returns:

OfferModel

createAccount

public ArrayList<AccountModel> createAccount(AccountModel model)
                                      throws Exception

Create a new account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Create a single new account object. When creating an account object you may attach subscriptions and users as part of the 'Create' call. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - The account you wish to create.

Returns:

ArrayList

Throws:

Exception

createAccountAsync

public Future<ArrayList<AccountModel>> createAccountAsync(AccountModel model)

Create a new account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Create a single new account object. When creating an account object you may attach subscriptions and users as part of the 'Create' call. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

model - The account you wish to create.

Returns:

ArrayList

createNotifications

public ArrayList<NotificationModel> createNotifications(ArrayList<NotificationModel> model)
                                                 throws Exception

Create new notifications. This API is available by invitation only. Create 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. A Global notification is a message which is directed to all the accounts and is set to expire within a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global 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. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. Swagger Name: AvaTaxClient

Parameters:

model - The notifications you wish to create.

Returns:

ArrayList

Throws:

Exception

createNotificationsAsync

public Future<ArrayList<NotificationModel>> createNotificationsAsync(ArrayList<NotificationModel> model)

Create new notifications. This API is available by invitation only. Create 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. A Global notification is a message which is directed to all the accounts and is set to expire within a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global 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. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. Swagger Name: AvaTaxClient

Parameters:

model - The notifications you wish to create.

Returns:

ArrayList

createSubscriptions

public ArrayList<SubscriptionModel> createSubscriptions(Integer accountId,
 ArrayList<SubscriptionModel> model)
                                                 throws Exception

Create a new subscription This API is for use by Avalara Registrar administrative users only. Create one or more new subscription objects attached to this account. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. ### Security Policies * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this subscription.

model - The subscription you wish to create.

Returns:

ArrayList

Throws:

Exception

createSubscriptionsAsync

public Future<ArrayList<SubscriptionModel>> createSubscriptionsAsync(Integer accountId,
 ArrayList<SubscriptionModel> model)

Create a new subscription This API is for use by Avalara Registrar administrative users only. Create one or more new subscription objects attached to this account. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. ### Security Policies * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this subscription.

model - The subscription you wish to create.

Returns:

ArrayList

deleteAccount

public ArrayList<ErrorDetail> deleteAccount(Integer id)
                                     throws Exception

Delete a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Delete an account. Deleting an account will delete all companies, all account level users and license keys attached to this account. ### Security Policies * This API requires the user role SystemAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteAccountAsync

public Future<ArrayList<ErrorDetail>> deleteAccountAsync(Integer id)

Delete a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Delete an account. Deleting an account will delete all companies, all account level users and license keys attached to this account. ### Security Policies * This API requires the user role SystemAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to delete.

Returns:

ArrayList

deleteNotification

public ArrayList<ErrorDetail> deleteNotification(Long id)
                                          throws Exception

Delete a single notification. This API is available by invitation only. Delete the existing notification identified by this URL. 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. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteNotificationAsync

public Future<ArrayList<ErrorDetail>> deleteNotificationAsync(Long id)

Delete a single notification. This API is available by invitation only. Delete the existing notification identified by this URL. 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. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification you wish to delete.

Returns:

ArrayList

deleteSubscription

public ArrayList<ErrorDetail> deleteSubscription(Integer accountId,
 Integer id)
                                          throws Exception

Delete a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Mark the existing account identified by this URL as deleted. ### Security Policies * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this subscription.

id - The ID of the subscription you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteSubscriptionAsync

public Future<ArrayList<ErrorDetail>> deleteSubscriptionAsync(Integer accountId,
 Integer id)

Delete a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Mark the existing account identified by this URL as deleted. ### Security Policies * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this subscription.

id - The ID of the subscription you wish to delete.

Returns:

ArrayList

resetPassword

public String resetPassword(Integer userId,
 Boolean isUndoMigrateRequest,
 SetPasswordModel model)
                     throws Exception

Reset a user's password programmatically # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Allows a system admin to reset the password for a specific user via the API. This API is only available for Avalara Registrar Admins, and can be used to reset the password of any user based on internal Avalara business processes. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API is available to Avalara system-level (registrar-level) users only. Swagger Name: AvaTaxClient

Parameters:

userId - The unique ID of the user whose password will be changed

isUndoMigrateRequest - If user's password was migrated to AI, undo this.

model - The new password for this user

Returns:

String

Throws:

Exception

resetPasswordAsync

public Future<String> resetPasswordAsync(Integer userId,
 Boolean isUndoMigrateRequest,
 SetPasswordModel model)

Reset a user's password programmatically # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Allows a system admin to reset the password for a specific user via the API. This API is only available for Avalara Registrar Admins, and can be used to reset the password of any user based on internal Avalara business processes. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * This API is available to Avalara system-level (registrar-level) users only. Swagger Name: AvaTaxClient

Parameters:

userId - The unique ID of the user whose password will be changed

isUndoMigrateRequest - If user's password was migrated to AI, undo this.

model - The new password for this user

Returns:

String

updateAccount

public AccountModel updateAccount(Integer id,
 AccountModel model)
                           throws Exception

Update a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Replace an existing account object with an updated account object. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

model - The account object you wish to update.

Returns:

AccountModel

Throws:

Exception

updateAccountAsync

public Future<AccountModel> updateAccountAsync(Integer id,
 AccountModel model)

Update a single account # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Replace an existing account object with an updated account object. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the account you wish to update.

model - The account object you wish to update.

Returns:

AccountModel

updateNotification

public NotificationModel updateNotification(Long id,
 NotificationModel model)
                                     throws Exception

Update a single notification. This API is available by invitation only. Replaces the notification identified by this URL with a new 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. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification you wish to update.

model - The notification object you wish to update.

Returns:

NotificationModel

Throws:

Exception

updateNotificationAsync

public Future<NotificationModel> updateNotificationAsync(Long id,
 NotificationModel model)

Update a single notification. This API is available by invitation only. Replaces the notification identified by this URL with a new 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. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. Swagger Name: AvaTaxClient

Parameters:

id - The id of the notification you wish to update.

model - The notification object you wish to update.

Returns:

NotificationModel

updateSubscription

public SubscriptionModel updateSubscription(Integer accountId,
 Integer id,
 SubscriptionModel model)
                                     throws Exception

Update a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Replace the existing subscription object at this URL with an updated object. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that this subscription belongs to.

id - The ID of the subscription you wish to update

model - The subscription you wish to update.

Returns:

SubscriptionModel

Throws:

Exception

updateSubscriptionAsync

public Future<SubscriptionModel> updateSubscriptionAsync(Integer accountId,
 Integer id,
 SubscriptionModel model)

Update a single subscription # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Replace the existing subscription object at this URL with an updated object. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that this subscription belongs to.

id - The ID of the subscription you wish to update

model - The subscription you wish to update.

Returns:

SubscriptionModel

downloadReport

public String downloadReport(Long id)
                      throws Exception

Download a report This API downloads the file associated with a report. If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete, use the `GetReport` API. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. * We throttle this API. You can only call this API up to 5 times in a minute. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of this report

Returns:

String

Throws:

Exception

downloadReportAsync

public Future<String> downloadReportAsync(Long id)

Download a report This API downloads the file associated with a report. If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete, use the `GetReport` API. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. * We throttle this API. You can only call this API up to 5 times in a minute. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of this report

Returns:

String

getReport

public ReportModel getReport(Long id)
                      throws Exception

Retrieve a single report Retrieve a single report by its unique ID number. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of the report to retrieve

Returns:

ReportModel

Throws:

Exception

getReportAsync

public Future<ReportModel> getReportAsync(Long id)

Retrieve a single report Retrieve a single report by its unique ID number. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of the report to retrieve

Returns:

ReportModel

initiateExportDocumentLineReport

public ArrayList<ReportModel> initiateExportDocumentLineReport(Integer companyId,
 ExportDocumentLineModel model)
                                                        throws Exception

Initiate an ExportDocumentLine report task Begins running an `ExportDocumentLine` report task and returns the identity of the report. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. The `ExportDocumentLine` report produces information about invoice lines recorded within your account. To split large reports into multiple smaller partitions, use the numberOfPartitions and partition properties on ExportDocumentLineModel. Example - split a report into three partitions * Follow the steps above with numberOfPartitions = 3 and partition = 0 * Follow the steps above with numberOfPartitions = 3 and partition = 1 * Follow the steps above with numberOfPartitions = 3 and partition = 2 * Once all three reports are downloaded merge the files on the client side. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company to report on.

model - Options that may be configured to customize the report.

Returns:

ArrayList

Throws:

Exception

initiateExportDocumentLineReportAsync

public Future<ArrayList<ReportModel>> initiateExportDocumentLineReportAsync(Integer companyId,
 ExportDocumentLineModel model)

Initiate an ExportDocumentLine report task Begins running an `ExportDocumentLine` report task and returns the identity of the report. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. The `ExportDocumentLine` report produces information about invoice lines recorded within your account. To split large reports into multiple smaller partitions, use the numberOfPartitions and partition properties on ExportDocumentLineModel. Example - split a report into three partitions * Follow the steps above with numberOfPartitions = 3 and partition = 0 * Follow the steps above with numberOfPartitions = 3 and partition = 1 * Follow the steps above with numberOfPartitions = 3 and partition = 2 * Once all three reports are downloaded merge the files on the client side. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The unique ID number of the company to report on.

model - Options that may be configured to customize the report.

Returns:

ArrayList

listReports

public FetchResult<ReportModel> listReports(Integer companyId,
 String pageKey,
 Integer skip,
 Integer top)
                                     throws Exception

List all report tasks for account List all report tasks for your account. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. This API call returns information about all report types across your entire account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company for which to get reports.

pageKey - Provide a page key to retrieve the next page of results.

skip - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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.

Returns:

FetchResult

Throws:

Exception

listReportsAsync

public Future<FetchResult<ReportModel>> listReportsAsync(Integer companyId,
 String pageKey,
 Integer skip,
 Integer top)

List all report tasks for account List all report tasks for your account. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. This API call returns information about all report types across your entire account. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company for which to get reports.

pageKey - Provide a page key to retrieve the next page of results.

skip - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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.

Returns:

FetchResult

createSettings

public ArrayList<SettingModel> createSettings(Integer companyId,
 ArrayList<SettingModel> model)
                                       throws Exception

Create a new setting Create one or more new setting objects attached to this 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. Use Set = Transactions, Name = TaxCodePrioritization/HSCodePrioritization and Value = Transaction/ItemMaster for prioritizing which TaxCodes/HsCodes should be used for calculating taxes. Example: To prioritize TaxCodes passed in a Transaction over values stored with Items when calculating tax, use Set = Transactions, Name = TaxCodePrioritization, Value = Transaction ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this setting.

model - The setting you wish to create.

Returns:

ArrayList

Throws:

Exception

createSettingsAsync

public Future<ArrayList<SettingModel>> createSettingsAsync(Integer companyId,
 ArrayList<SettingModel> model)

Create a new setting Create one or more new setting objects attached to this 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. Use Set = Transactions, Name = TaxCodePrioritization/HSCodePrioritization and Value = Transaction/ItemMaster for prioritizing which TaxCodes/HsCodes should be used for calculating taxes. Example: To prioritize TaxCodes passed in a Transaction over values stored with Items when calculating tax, use Set = Transactions, Name = TaxCodePrioritization, Value = Transaction ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this setting.

model - The setting you wish to create.

Returns:

ArrayList

deleteSetting

public ArrayList<ErrorDetail> deleteSetting(Integer companyId,
 Integer id)
                                     throws Exception

Delete a single setting Mark the setting object at this URL as deleted. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this setting.

id - The ID of the setting you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteSettingAsync

public Future<ArrayList<ErrorDetail>> deleteSettingAsync(Integer companyId,
 Integer id)

Delete a single setting Mark the setting object at this URL as deleted. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this setting.

id - The ID of the setting you wish to delete.

Returns:

ArrayList

getSetting

public SettingModel getSetting(Integer companyId,
 Integer id)
                        throws Exception

Retrieve a single setting Get a single setting object by its unique ID. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this setting

id - The primary key of this setting

Returns:

SettingModel

Throws:

Exception

getSettingAsync

public Future<SettingModel> getSettingAsync(Integer companyId,
 Integer id)

Retrieve a single setting Get a single setting object by its unique ID. 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. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this setting

id - The primary key of this setting

Returns:

SettingModel

listSettingsByCompany

public FetchResult<SettingModel> listSettingsByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                throws Exception

Retrieve all settings for this company List all setting objects attached to this 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. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these settings

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listSettingsByCompanyAsync

public Future<FetchResult<SettingModel>> listSettingsByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all settings for this company List all setting objects attached to this 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. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these settings

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

querySettings

public FetchResult<SettingModel> querySettings(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

Retrieve all settings Get multiple setting objects across all companies. 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. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

querySettingsAsync

public Future<FetchResult<SettingModel>> querySettingsAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all settings Get multiple setting objects across all companies. 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. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateSetting

public SettingModel updateSetting(Integer companyId,
 Integer id,
 SettingModel model)
                           throws Exception

Update a single setting Replace the existing setting object at this URL with an updated object. 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. All data from the existing object will be replaced with data in the object you `PUT`. To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this setting belongs to.

id - The ID of the setting you wish to update

model - The setting you wish to update.

Returns:

SettingModel

Throws:

Exception

updateSettingAsync

public Future<SettingModel> updateSettingAsync(Integer companyId,
 Integer id,
 SettingModel model)

Update a single setting Replace the existing setting object at this URL with an updated object. 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. All data from the existing object will be replaced with data in the object you `PUT`. To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this setting belongs to.

id - The ID of the setting you wish to update

model - The setting you wish to update.

Returns:

SettingModel

getSubscription

public SubscriptionModel getSubscription(Integer accountId,
 Integer id)
                                  throws Exception

Retrieve a single subscription Get the subscription object identified by this URL. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this subscription

id - The primary key of this subscription

Returns:

SubscriptionModel

Throws:

Exception

getSubscriptionAsync

public Future<SubscriptionModel> getSubscriptionAsync(Integer accountId,
 Integer id)

Retrieve a single subscription Get the subscription object identified by this URL. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns this subscription

id - The primary key of this subscription

Returns:

SubscriptionModel

listSubscriptionsByAccount

public FetchResult<SubscriptionModel> listSubscriptionsByAccount(Integer accountId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                          throws Exception

Retrieve subscriptions for this account List all subscription objects attached to this account. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns these subscriptions

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listSubscriptionsByAccountAsync

public Future<FetchResult<SubscriptionModel>> listSubscriptionsByAccountAsync(Integer accountId,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve subscriptions for this account List all subscription objects attached to this account. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The ID of the account that owns these subscriptions

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

querySubscriptions

public FetchResult<SubscriptionModel> querySubscriptions(String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                  throws Exception

Retrieve all subscriptions Get multiple subscription objects across all accounts. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

querySubscriptionsAsync

public Future<FetchResult<SubscriptionModel>> querySubscriptionsAsync(String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all subscriptions Get multiple subscription objects across all accounts. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

createTaxCodes

public ArrayList<TaxCodeModel> createTaxCodes(Integer companyId,
 ArrayList<TaxCodeModel> model)
                                       throws Exception

Create a new tax code Create one or more new taxcode objects attached to this company. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax code.

model - The tax code you wish to create.

Returns:

ArrayList

Throws:

Exception

createTaxCodesAsync

public Future<ArrayList<TaxCodeModel>> createTaxCodesAsync(Integer companyId,
 ArrayList<TaxCodeModel> model)

Create a new tax code Create one or more new taxcode objects attached to this company. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax code.

model - The tax code you wish to create.

Returns:

ArrayList

deleteTaxCode

public ArrayList<ErrorDetail> deleteTaxCode(Integer companyId,
 Integer id)
                                     throws Exception

Delete a single tax code Marks the existing TaxCode object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax code.

id - The ID of the tax code you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteTaxCodeAsync

public Future<ArrayList<ErrorDetail>> deleteTaxCodeAsync(Integer companyId,
 Integer id)

Delete a single tax code Marks the existing TaxCode object at this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax code.

id - The ID of the tax code you wish to delete.

Returns:

ArrayList

getTaxCode

public TaxCodeModel getTaxCode(Integer companyId,
 Integer id)
                        throws Exception

Retrieve a single tax code Get the taxcode object identified by this URL. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax code

id - The primary key of this tax code

Returns:

TaxCodeModel

Throws:

Exception

getTaxCodeAsync

public Future<TaxCodeModel> getTaxCodeAsync(Integer companyId,
 Integer id)

Retrieve a single tax code Get the taxcode object identified by this URL. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax code

id - The primary key of this tax code

Returns:

TaxCodeModel

listTaxCodesByCompany

public FetchResult<TaxCodeModel> listTaxCodesByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                                throws Exception

Retrieve tax codes for this company List all taxcode objects attached to this company. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these tax codes

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxCodesByCompanyAsync

public Future<FetchResult<TaxCodeModel>> listTaxCodesByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve tax codes for this company List all taxcode objects attached to this company. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these tax codes

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryTaxCodes

public FetchResult<TaxCodeModel> queryTaxCodes(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

Retrieve all tax codes Get multiple taxcode objects across all companies. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryTaxCodesAsync

public Future<FetchResult<TaxCodeModel>> queryTaxCodesAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all tax codes Get multiple taxcode objects across all companies. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateTaxCode

public TaxCodeModel updateTaxCode(Integer companyId,
 Integer id,
 TaxCodeModel model)
                           throws Exception

Update a single tax code Replace the existing taxcode object at this URL with an updated object. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this tax code belongs to.

id - The ID of the tax code you wish to update

model - The tax code you wish to update.

Returns:

TaxCodeModel

Throws:

Exception

updateTaxCodeAsync

public Future<TaxCodeModel> updateTaxCodeAsync(Integer companyId,
 Integer id,
 TaxCodeModel model)

Update a single tax code Replace the existing taxcode object at this URL with an updated object. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this tax code belongs to.

id - The ID of the tax code you wish to update

model - The tax code you wish to update.

Returns:

TaxCodeModel

buildTaxContentFile

public String buildTaxContentFile(PointOfSaleDataRequestModel model)
                           throws Exception

Build a multi-location tax content file Builds a tax content file containing information useful for a retail point-of-sale solution. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize decisions on tax changes at unexpected times and may make changes in response to legal issues or governmental priorities. Any tax content downloaded for future time periods is subject to change if tax rates or tax laws change. A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use `CreateLocations()`. The file is built by looking up the tax profile for your location and your item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code, then use `CreateItems()` to create an item that uses the custom tax code. This data file can be customized for specific partner devices and usage conditions. The result of this API is the file you requested in the format you requested using the `responseType` field. This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content file for a single location at a time, please use `BuildTaxContentFileForLocation`. NOTE: This API does not work for Tennessee tax holiday scenarios. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

model - Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.

Returns:

String

Throws:

Exception

buildTaxContentFileAsync

public Future<String> buildTaxContentFileAsync(PointOfSaleDataRequestModel model)

Build a multi-location tax content file Builds a tax content file containing information useful for a retail point-of-sale solution. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize decisions on tax changes at unexpected times and may make changes in response to legal issues or governmental priorities. Any tax content downloaded for future time periods is subject to change if tax rates or tax laws change. A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use `CreateLocations()`. The file is built by looking up the tax profile for your location and your item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code, then use `CreateItems()` to create an item that uses the custom tax code. This data file can be customized for specific partner devices and usage conditions. The result of this API is the file you requested in the format you requested using the `responseType` field. This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content file for a single location at a time, please use `BuildTaxContentFileForLocation`. NOTE: This API does not work for Tennessee tax holiday scenarios. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

model - Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.

Returns:

String

buildTaxContentFileForLocation

public String buildTaxContentFileForLocation(Integer companyId,
 Integer id,
 Date date,
 PointOfSaleFileType format,
 PointOfSalePartnerId partnerId,
 Boolean includeJurisCodes)
                                      throws Exception

Build a tax content file for a single location Builds a tax content file containing information useful for a retail point-of-sale solution. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize decisions on tax changes at unexpected times and may make changes in response to legal issues or governmental priorities. Any tax content downloaded for future time periods is subject to change if tax rates or tax laws change. A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use `CreateLocations()`. The file is built by looking up the tax profile for your location and your item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code, then use `CreateItems()` to create an item that uses the custom tax code. This data file can be customized for specific partner devices and usage conditions. The result of this API is the file you requested in the format you requested using the `responseType` field. This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content file for a multiple locations in a single file, please use `BuildTaxContentFile`. NOTE: This API does not work for Tennessee tax holiday scenarios. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company that owns this location.

id - The ID number of the location to retrieve point-of-sale data.

date - The date for which point-of-sale data would be calculated (today by default)

format - The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)

partnerId - If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)

includeJurisCodes - When true, the file will include jurisdiction codes in the result.

Returns:

String

Throws:

Exception

buildTaxContentFileForLocationAsync

public Future<String> buildTaxContentFileForLocationAsync(Integer companyId,
 Integer id,
 Date date,
 PointOfSaleFileType format,
 PointOfSalePartnerId partnerId,
 Boolean includeJurisCodes)

Build a tax content file for a single location Builds a tax content file containing information useful for a retail point-of-sale solution. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize decisions on tax changes at unexpected times and may make changes in response to legal issues or governmental priorities. Any tax content downloaded for future time periods is subject to change if tax rates or tax laws change. A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use `CreateLocations()`. The file is built by looking up the tax profile for your location and your item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code, then use `CreateItems()` to create an item that uses the custom tax code. This data file can be customized for specific partner devices and usage conditions. The result of this API is the file you requested in the format you requested using the `responseType` field. This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content file for a multiple locations in a single file, please use `BuildTaxContentFile`. NOTE: This API does not work for Tennessee tax holiday scenarios. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID number of the company that owns this location.

id - The ID number of the location to retrieve point-of-sale data.

date - The date for which point-of-sale data would be calculated (today by default)

format - The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)

partnerId - If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)

includeJurisCodes - When true, the file will include jurisdiction codes in the result.

Returns:

String

downloadTaxRatesByZipCode

public String downloadTaxRatesByZipCode(Date date,
 String region)
                                 throws Exception

Download a file listing tax rates by postal code Download a CSV file containing all five digit postal codes in the United States and their sales and use tax rates for tangible personal property. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize decisions on tax changes at unexpected times and may make changes in response to legal issues or governmental priorities. Any tax content downloaded for future time periods is subject to change if tax rates or tax laws change. This rates file is intended to be used as a default for tax calculation when your software cannot call the `CreateTransaction` API call. When using this file, your software will be unable to handle complex tax rules such as: * Zip+4 - This tax file contains five digit zip codes only. * Different product types - This tax file contains tangible personal property tax rates only. * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes. * Threshold-based taxes - This tax file does not contain information about thresholds. If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction` to reconcile the actual transaction and determine the difference between the estimated general tax rate and the final transaction tax. The file provided by this API is in CSV format with the following columns: * ZIP_CODE - The five digit zip code for this record. * STATE_ABBREV - A valid two character US state abbreviation for this record. Zip codes may span multiple states. * COUNTY_NAME - A valid county name for this record. Zip codes may span multiple counties. * CITY_NAME - A valid city name for this record. Zip codes may span multiple cities. * STATE_SALES_TAX - The state component of the sales tax rate. * STATE_USE_TAX - The state component of the use tax rate. * COUNTY_SALES_TAX - The county component of the sales tax rate. * COUNTY_USE_TAX - The county component of the use tax rate. * CITY_SALES_TAX - The city component of the sales tax rate. * CITY_USE_TAX - The city component of the use tax rate. * TOTAL_SALES_TAX - The total tax rate for sales tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules. * TOTAL_USE_TAX - The total tax rate for use tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules. * TAX_SHIPPING_ALONE - This column contains 'Y' if shipping is taxable. * TAX_SHIPPING_AND_HANDLING_TOGETHER - This column contains 'Y' if shipping and handling are taxable when sent together. For more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

date - The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31

region - A two character region code which limits results to a specific region.

Returns:

String

Throws:

Exception

downloadTaxRatesByZipCodeAsync

public Future<String> downloadTaxRatesByZipCodeAsync(Date date,
 String region)

Download a file listing tax rates by postal code Download a CSV file containing all five digit postal codes in the United States and their sales and use tax rates for tangible personal property. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize decisions on tax changes at unexpected times and may make changes in response to legal issues or governmental priorities. Any tax content downloaded for future time periods is subject to change if tax rates or tax laws change. This rates file is intended to be used as a default for tax calculation when your software cannot call the `CreateTransaction` API call. When using this file, your software will be unable to handle complex tax rules such as: * Zip+4 - This tax file contains five digit zip codes only. * Different product types - This tax file contains tangible personal property tax rates only. * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes. * Threshold-based taxes - This tax file does not contain information about thresholds. If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction` to reconcile the actual transaction and determine the difference between the estimated general tax rate and the final transaction tax. The file provided by this API is in CSV format with the following columns: * ZIP_CODE - The five digit zip code for this record. * STATE_ABBREV - A valid two character US state abbreviation for this record. Zip codes may span multiple states. * COUNTY_NAME - A valid county name for this record. Zip codes may span multiple counties. * CITY_NAME - A valid city name for this record. Zip codes may span multiple cities. * STATE_SALES_TAX - The state component of the sales tax rate. * STATE_USE_TAX - The state component of the use tax rate. * COUNTY_SALES_TAX - The county component of the sales tax rate. * COUNTY_USE_TAX - The county component of the use tax rate. * CITY_SALES_TAX - The city component of the sales tax rate. * CITY_USE_TAX - The city component of the use tax rate. * TOTAL_SALES_TAX - The total tax rate for sales tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules. * TOTAL_USE_TAX - The total tax rate for use tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules. * TAX_SHIPPING_ALONE - This column contains 'Y' if shipping is taxable. * TAX_SHIPPING_AND_HANDLING_TOGETHER - This column contains 'Y' if shipping and handling are taxable when sent together. For more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations. ### Security 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. Swagger Name: AvaTaxClient

Parameters:

date - The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31

region - A two character region code which limits results to a specific region.

Returns:

String

taxRatesByAddress

public TaxRateModel taxRatesByAddress(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country)
                               throws Exception

Sales tax rates for a specified address Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP response code 429 - `Too Many Requests`. This API assumes that you are selling general tangible personal property at a retail point-of-sale location in the United States only. For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API, which supports features including, but not limited to: * Nexus declarations * Taxability based on product/service type * Sourcing rules affecting origin/destination states * Customers who are exempt from certain taxes * States that have dollar value thresholds for tax amounts * Refunds for products purchased on a different date * Detailed jurisdiction names and state assigned codes * And more! Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) Swagger Name: AvaTaxClient

Parameters:

line1 - The street address of the location.

line2 - The street address of the location.

line3 - The street address of the location.

city - The city name of the location.

region - 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 - The postal code of the location.

country - 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`.

Returns:

TaxRateModel

Throws:

Exception

taxRatesByAddressAsync

public Future<TaxRateModel> taxRatesByAddressAsync(String line1,
 String line2,
 String line3,
 String city,
 String region,
 String postalCode,
 String country)

Sales tax rates for a specified address Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP response code 429 - `Too Many Requests`. This API assumes that you are selling general tangible personal property at a retail point-of-sale location in the United States only. For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API, which supports features including, but not limited to: * Nexus declarations * Taxability based on product/service type * Sourcing rules affecting origin/destination states * Customers who are exempt from certain taxes * States that have dollar value thresholds for tax amounts * Refunds for products purchased on a different date * Detailed jurisdiction names and state assigned codes * And more! Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) Swagger Name: AvaTaxClient

Parameters:

line1 - The street address of the location.

line2 - The street address of the location.

line3 - The street address of the location.

city - The city name of the location.

region - 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 - The postal code of the location.

country - 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`.

Returns:

TaxRateModel

taxRatesByPostalCode

public TaxRateModel taxRatesByPostalCode(String country,
 String postalCode)
                                  throws Exception

Sales tax rates for a specified country and postal code. This API is only available for US postal codes. This API is only available for a US postal codes. Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP response code 429 - `Too Many Requests`. This API assumes that you are selling general tangible personal property at a retail point-of-sale location in the United States only. For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API, which supports features including, but not limited to: * Nexus declarations * Taxability based on product/service type * Sourcing rules affecting origin/destination states * Customers who are exempt from certain taxes * States that have dollar value thresholds for tax amounts * Refunds for products purchased on a different date * Detailed jurisdiction names and state assigned codes * And more! Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) Swagger Name: AvaTaxClient

Parameters:

country - 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 - The postal code of the location.

Returns:

TaxRateModel

Throws:

Exception

taxRatesByPostalCodeAsync

public Future<TaxRateModel> taxRatesByPostalCodeAsync(String country,
 String postalCode)

Sales tax rates for a specified country and postal code. This API is only available for US postal codes. This API is only available for a US postal codes. Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP response code 429 - `Too Many Requests`. This API assumes that you are selling general tangible personal property at a retail point-of-sale location in the United States only. For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API, which supports features including, but not limited to: * Nexus declarations * Taxability based on product/service type * Sourcing rules affecting origin/destination states * Customers who are exempt from certain taxes * States that have dollar value thresholds for tax amounts * Refunds for products purchased on a different date * Detailed jurisdiction names and state assigned codes * And more! Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) Swagger Name: AvaTaxClient

Parameters:

country - 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 - The postal code of the location.

Returns:

TaxRateModel

createTaxRules

public ArrayList<TaxRuleModel> createTaxRules(Integer companyId,
 ArrayList<TaxRuleModel> model)
                                       throws Exception

Create a new tax rule Create one or more custom tax rules attached to this company. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax rule.

model - The tax rule you wish to create.

Returns:

ArrayList

Throws:

Exception

createTaxRulesAsync

public Future<ArrayList<TaxRuleModel>> createTaxRulesAsync(Integer companyId,
 ArrayList<TaxRuleModel> model)

Create a new tax rule Create one or more custom tax rules attached to this company. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax rule.

model - The tax rule you wish to create.

Returns:

ArrayList

deleteTaxRule

public ArrayList<ErrorDetail> deleteTaxRule(Integer companyId,
 Integer id)
                                     throws Exception

Delete a single tax rule Mark the custom tax rule identified by this URL as deleted. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax rule.

id - The ID of the tax rule you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteTaxRuleAsync

public Future<ArrayList<ErrorDetail>> deleteTaxRuleAsync(Integer companyId,
 Integer id)

Delete a single tax rule Mark the custom tax rule identified by this URL as deleted. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax rule.

id - The ID of the tax rule you wish to delete.

Returns:

ArrayList

getTaxRule

public TaxRuleModel getTaxRule(Integer companyId,
 Integer id)
                        throws Exception

Retrieve a single tax rule Get the taxrule object identified by this URL. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax rule

id - The primary key of this tax rule

Returns:

TaxRuleModel

Throws:

Exception

getTaxRuleAsync

public Future<TaxRuleModel> getTaxRuleAsync(Integer companyId,
 Integer id)

Retrieve a single tax rule Get the taxrule object identified by this URL. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this tax rule

id - The primary key of this tax rule

Returns:

TaxRuleModel

listTaxRules

public FetchResult<TaxRuleModel> listTaxRules(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                       throws Exception

Retrieve tax rules for this company List all taxrule objects attached to this company. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these tax rules

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTaxRulesAsync

public Future<FetchResult<TaxRuleModel>> listTaxRulesAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve tax rules for this company List all taxrule objects attached to this company. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these tax rules

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryTaxRules

public FetchResult<TaxRuleModel> queryTaxRules(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

Retrieve all tax rules Get multiple taxrule objects across all companies. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryTaxRulesAsync

public Future<FetchResult<TaxRuleModel>> queryTaxRulesAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all tax rules Get multiple taxrule objects across all companies. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateTaxRule

public TaxRuleModel updateTaxRule(Integer companyId,
 Integer id,
 TaxRuleModel model)
                           throws Exception

Update a single tax rule Replace the existing custom tax rule object at this URL with an updated object. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this tax rule belongs to.

id - The ID of the tax rule you wish to update

model - The tax rule you wish to update.

Returns:

TaxRuleModel

Throws:

Exception

updateTaxRuleAsync

public Future<TaxRuleModel> updateTaxRuleAsync(Integer companyId,
 Integer id,
 TaxRuleModel model)

Update a single tax rule Replace the existing custom tax rule object at this URL with an updated object. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted with the transaction. You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item. Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this tax rule belongs to.

id - The ID of the tax rule you wish to update

model - The tax rule you wish to update.

Returns:

TaxRuleModel

addLines

public TransactionModel addLines(String include,
 AddTransactionLineModel model)
                          throws Exception

Add lines to an existing unlocked transaction Add lines to an existing unlocked transaction. The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all transaction lines for them, in this case, the line number becomes: "1", "2", "3", ... A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - information about the transaction and lines to be added

Returns:

TransactionModel

Throws:

Exception

addLinesAsync

public Future<TransactionModel> addLinesAsync(String include,
 AddTransactionLineModel model)

Add lines to an existing unlocked transaction Add lines to an existing unlocked transaction. The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all transaction lines for them, in this case, the line number becomes: "1", "2", "3", ... A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - information about the transaction and lines to be added

Returns:

TransactionModel

adjustTransaction

public TransactionModel adjustTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 AdjustTransactionModel model)
                                   throws Exception

Correct a previously created transaction Replaces the current transaction uniquely identified by this URL with a new transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you adjust a committed transaction, the original transaction will be updated with the status code `Adjusted`, and both revisions will be available for retrieval based on their code and ID numbers. Only transactions in `Committed` status are reported by Avalara Managed Returns. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are no longer available for adjustments. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to adjust

documentType - (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The adjustment you wish to make

Returns:

TransactionModel

Throws:

Exception

adjustTransactionAsync

public Future<TransactionModel> adjustTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 AdjustTransactionModel model)

Correct a previously created transaction Replaces the current transaction uniquely identified by this URL with a new transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you adjust a committed transaction, the original transaction will be updated with the status code `Adjusted`, and both revisions will be available for retrieval based on their code and ID numbers. Only transactions in `Committed` status are reported by Avalara Managed Returns. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are no longer available for adjustments. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to adjust

documentType - (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The adjustment you wish to make

Returns:

TransactionModel

auditTransaction

public AuditTransactionModel auditTransaction(String companyCode,
 String transactionCode)
                                       throws Exception

Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax. The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit information includes the following: * The `CompanyId` of the company that created the transaction * The server timestamp representing the exact server time when the transaction was created * The server duration - how long it took to process this transaction * Whether exact API call details were logged * A reconstructed API call showing what the original CreateTransaction call looked like This API can be used to examine information about a previously created transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The code identifying the company that owns this transaction

transactionCode - The code identifying the transaction

Returns:

AuditTransactionModel

Throws:

Exception

auditTransactionAsync

public Future<AuditTransactionModel> auditTransactionAsync(String companyCode,
 String transactionCode)

Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax. The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit information includes the following: * The `CompanyId` of the company that created the transaction * The server timestamp representing the exact server time when the transaction was created * The server duration - how long it took to process this transaction * Whether exact API call details were logged * A reconstructed API call showing what the original CreateTransaction call looked like This API can be used to examine information about a previously created transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The code identifying the company that owns this transaction

transactionCode - The code identifying the transaction

Returns:

AuditTransactionModel

auditTransactionWithType

public AuditTransactionModel auditTransactionWithType(String companyCode,
 String transactionCode,
 DocumentType documentType)
                                               throws Exception

Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax. The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit information includes the following: * The `CompanyId` of the company that created the transaction * The server timestamp representing the exact server time when the transaction was created * The server duration - how long it took to process this transaction * Whether exact API call details were logged * A reconstructed API call showing what the original CreateTransaction call looked like This API can be used to examine information about a previously created transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The code identifying the company that owns this transaction

transactionCode - The code identifying the transaction

documentType - The document type of the original transaction (See DocumentType::* for a list of allowable values)

Returns:

AuditTransactionModel

Throws:

Exception

auditTransactionWithTypeAsync

public Future<AuditTransactionModel> auditTransactionWithTypeAsync(String companyCode,
 String transactionCode,
 DocumentType documentType)

Get audit information about a transaction Retrieve audit information about a transaction stored in AvaTax. The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit information includes the following: * The `CompanyId` of the company that created the transaction * The server timestamp representing the exact server time when the transaction was created * The server duration - how long it took to process this transaction * Whether exact API call details were logged * A reconstructed API call showing what the original CreateTransaction call looked like This API can be used to examine information about a previously created transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The code identifying the company that owns this transaction

transactionCode - The code identifying the transaction

documentType - The document type of the original transaction (See DocumentType::* for a list of allowable values)

Returns:

AuditTransactionModel

bulkLockTransaction

public BulkLockTransactionResult bulkLockTransaction(BulkLockTransactionModel model)
                                              throws Exception

Lock a set of documents This API is available by invitation only. Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once. After this API call succeeds, documents will be locked and can't be voided. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). ### Security Policies * This API requires the user role Compliance Root User. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - bulk lock request

Returns:

BulkLockTransactionResult

Throws:

Exception

bulkLockTransactionAsync

public Future<BulkLockTransactionResult> bulkLockTransactionAsync(BulkLockTransactionModel model)

Lock a set of documents This API is available by invitation only. Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once. After this API call succeeds, documents will be locked and can't be voided. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). ### Security Policies * This API requires the user role Compliance Root User. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

model - bulk lock request

Returns:

BulkLockTransactionResult

changeTransactionCode

public TransactionModel changeTransactionCode(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 ChangeTransactionCodeModel model)
                                       throws Exception

Change a transaction's code Renames a transaction uniquely identified by this URL by changing its `code` value. This API is available as long as the transaction is in `saved` or `posted` status. When a transaction is `committed`, it can be modified by using the [AdjustTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/AdjustTransaction/) method. After this API call succeeds, the transaction will have a new URL matching its new `code`. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to change

documentType - (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The code change request you wish to execute

Returns:

TransactionModel

Throws:

Exception

changeTransactionCodeAsync

public Future<TransactionModel> changeTransactionCodeAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 ChangeTransactionCodeModel model)

Change a transaction's code Renames a transaction uniquely identified by this URL by changing its `code` value. This API is available as long as the transaction is in `saved` or `posted` status. When a transaction is `committed`, it can be modified by using the [AdjustTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/AdjustTransaction/) method. After this API call succeeds, the transaction will have a new URL matching its new `code`. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to change

documentType - (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The code change request you wish to execute

Returns:

TransactionModel

commitTransaction

public TransactionModel commitTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 CommitTransactionModel model)
                                   throws Exception

Commit a transaction for reporting Marks a transaction by changing its status to `Committed`. Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. Any changes made to a committed transaction will generate a transaction history. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to commit

documentType - (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The commit request you wish to execute

Returns:

TransactionModel

Throws:

Exception

commitTransactionAsync

public Future<TransactionModel> commitTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 CommitTransactionModel model)

Commit a transaction for reporting Marks a transaction by changing its status to `Committed`. Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. Any changes made to a committed transaction will generate a transaction history. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to commit

documentType - (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The commit request you wish to execute

Returns:

TransactionModel

createOrAdjustTransaction

public TransactionModel createOrAdjustTransaction(String include,
 CreateOrAdjustTransactionModel model)
                                           throws Exception

Create or adjust a transaction Records a new transaction or adjust an existing transaction in AvaTax. The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API can help you create an idempotent service that creates transactions If there exists a transaction identified by code, the original transaction will be adjusted by using the meta data in the input transaction. The `CreateOrAdjustTransaction` API cannot modify any transaction that has been reported to a tax authority using the Avalara Managed Returns Service or any other tax filing service. If you call this API to attempt to modify a transaction that has been reported on a tax filing, you will receive the error `CannotModifyLockedTransaction`. To generate a refund for a transaction, use the `RefundTransaction` API. If you don't specify the field `type` in your request, you will get an estimate of type `SalesOrder`, which will not be recorded in the database. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently: * \_-ava2f-\_ * \_-ava2b-\_ * \_-ava3f-\_ ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - The transaction you wish to create or adjust

Returns:

TransactionModel

Throws:

Exception

createOrAdjustTransactionAsync

public Future<TransactionModel> createOrAdjustTransactionAsync(String include,
 CreateOrAdjustTransactionModel model)

Create or adjust a transaction Records a new transaction or adjust an existing transaction in AvaTax. The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API can help you create an idempotent service that creates transactions If there exists a transaction identified by code, the original transaction will be adjusted by using the meta data in the input transaction. The `CreateOrAdjustTransaction` API cannot modify any transaction that has been reported to a tax authority using the Avalara Managed Returns Service or any other tax filing service. If you call this API to attempt to modify a transaction that has been reported on a tax filing, you will receive the error `CannotModifyLockedTransaction`. To generate a refund for a transaction, use the `RefundTransaction` API. If you don't specify the field `type` in your request, you will get an estimate of type `SalesOrder`, which will not be recorded in the database. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently: * \_-ava2f-\_ * \_-ava2b-\_ * \_-ava3f-\_ ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - The transaction you wish to create or adjust

Returns:

TransactionModel

createTransaction

public TransactionModel createTransaction(String include,
 CreateTransactionModel model)
                                   throws Exception

Create a new transaction Records a new transaction in AvaTax. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). The `CreateTransaction` endpoint uses the tax profile of your company to identify the correct tax rules and rates to apply to all line items in this transaction. The end result will be the total tax calculated by AvaTax based on your company's configuration and the data provided in this API call. The `CreateTransaction` API will report an error if a committed transaction already exists with the same `code`. To avoid this error, use the `CreateOrAdjustTransaction` API - it will create the transaction if it does not exist, or update it if it does exist. To generate a refund for a transaction, use the `RefundTransaction` API. The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded. The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please provide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode information in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated using the best available address location information. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection. * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently: * \_-ava2f-\_ * \_-ava2b-\_ * \_-ava3f-\_ ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - The transaction you wish to create

Returns:

TransactionModel

Throws:

Exception

createTransactionAsync

public Future<TransactionModel> createTransactionAsync(String include,
 CreateTransactionModel model)

Create a new transaction Records a new transaction in AvaTax. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). The `CreateTransaction` endpoint uses the tax profile of your company to identify the correct tax rules and rates to apply to all line items in this transaction. The end result will be the total tax calculated by AvaTax based on your company's configuration and the data provided in this API call. The `CreateTransaction` API will report an error if a committed transaction already exists with the same `code`. To avoid this error, use the `CreateOrAdjustTransaction` API - it will create the transaction if it does not exist, or update it if it does exist. To generate a refund for a transaction, use the `RefundTransaction` API. The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded. The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please provide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode information in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated using the best available address location information. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection. * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently: * \_-ava2f-\_ * \_-ava2b-\_ * \_-ava3f-\_ ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - The transaction you wish to create

Returns:

TransactionModel

deleteLines

public TransactionModel deleteLines(String include,
 RemoveTransactionLineModel model)
                             throws Exception

Remove lines from an existing unlocked transaction Remove lines to an existing unlocked transaction. The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will be able to delete transaction lines and adjust original transaction the way they like A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - information about the transaction and lines to be removed

Returns:

TransactionModel

Throws:

Exception

deleteLinesAsync

public Future<TransactionModel> deleteLinesAsync(String include,
 RemoveTransactionLineModel model)

Remove lines from an existing unlocked transaction Remove lines to an existing unlocked transaction. The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will be able to delete transaction lines and adjust original transaction the way they like A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

include - Specifies objects to include in the response after transaction is created

model - information about the transaction and lines to be removed

Returns:

TransactionModel

getTransactionByCode

public TransactionModel getTransactionByCode(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)
                                      throws Exception

Retrieve a single transaction by code Get the current transaction identified by this company code, transaction code, and document type. A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`. For compatibility purposes, when this API finds multiple transactions with the same transaction code, and if you have not specified the `type` parameter to this API, it will default to selecting the `SalesInvoices` transaction. To change this behavior, use the optional `documentType` parameter to specify the specific document type you wish to find. If this transaction was adjusted, the return value of this API will be the current transaction with this code. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

Throws:

Exception

getTransactionByCodeAsync

public Future<TransactionModel> getTransactionByCodeAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)

Retrieve a single transaction by code Get the current transaction identified by this company code, transaction code, and document type. A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`. For compatibility purposes, when this API finds multiple transactions with the same transaction code, and if you have not specified the `type` parameter to this API, it will default to selecting the `SalesInvoices` transaction. To change this behavior, use the optional `documentType` parameter to specify the specific document type you wish to find. If this transaction was adjusted, the return value of this API will be the current transaction with this code. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

getTransactionByCodeAndType

public TransactionModel getTransactionByCodeAndType(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)
                                             throws Exception

Retrieve a single transaction by code DEPRECATED: Please use the `GetTransactionByCode` API instead. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to retrieve

documentType - The transaction type to retrieve (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

Throws:

Exception

getTransactionByCodeAndTypeAsync

public Future<TransactionModel> getTransactionByCodeAndTypeAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)

Retrieve a single transaction by code DEPRECATED: Please use the `GetTransactionByCode` API instead. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to retrieve

documentType - The transaction type to retrieve (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

getTransactionById

public TransactionModel getTransactionById(Long id,
 String include)
                                    throws Exception

Retrieve a single transaction by ID Get the unique transaction identified by this URL. This endpoint retrieves the exact transaction identified by this ID number, as long as it is the most version of the transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of the transaction to retrieve

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

Throws:

Exception

getTransactionByIdAsync

public Future<TransactionModel> getTransactionByIdAsync(Long id,
 String include)

Retrieve a single transaction by ID Get the unique transaction identified by this URL. This endpoint retrieves the exact transaction identified by this ID number, as long as it is the most version of the transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

id - The unique ID number of the transaction to retrieve

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

listTransactionsByCompany

public FetchResult<TransactionModel> listTransactionsByCompany(String companyCode,
 Integer dataSourceId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                                        throws Exception

Retrieve all transactions List all transactions attached to this company. This endpoint is limited to returning 1,000 transactions at a time maximum. When listing transactions, you must specify a `date` range filter. If you do not specify a `$filter` that includes a `date` field criteria, the query will default to looking at only those transactions with `date` in the past 30 days. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

dataSourceId - Optionally filter transactions to those from a specific data source.

include - Specifies objects to include in this fetch call

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listTransactionsByCompanyAsync

public Future<FetchResult<TransactionModel>> listTransactionsByCompanyAsync(String companyCode,
 Integer dataSourceId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all transactions List all transactions attached to this company. This endpoint is limited to returning 1,000 transactions at a time maximum. When listing transactions, you must specify a `date` range filter. If you do not specify a `$filter` that includes a `date` field criteria, the query will default to looking at only those transactions with `date` in the past 30 days. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

dataSourceId - Optionally filter transactions to those from a specific data source.

include - Specifies objects to include in this fetch call

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

lockTransaction

public TransactionModel lockTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 LockTransactionModel model)
                                 throws Exception

Lock a single transaction Lock a transaction uniquely identified by this URL. This API is mainly used for connector developers to simulate what happens when the Returns product locks a document. After this API call succeeds, the document will be locked and can't be voided or adjusted. This API is only available to customers in Sandbox with AvaTaxPro subscription. On production servers, this API is available by invitation only. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to lock

documentType - (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The lock request you wish to execute

Returns:

TransactionModel

Throws:

Exception

lockTransactionAsync

public Future<TransactionModel> lockTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 LockTransactionModel model)

Lock a single transaction Lock a transaction uniquely identified by this URL. This API is mainly used for connector developers to simulate what happens when the Returns product locks a document. After this API call succeeds, the document will be locked and can't be voided or adjusted. This API is only available to customers in Sandbox with AvaTaxPro subscription. On production servers, this API is available by invitation only. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to lock

documentType - (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The lock request you wish to execute

Returns:

TransactionModel

refundTransaction

public TransactionModel refundTransaction(String companyCode,
 String transactionCode,
 String include,
 DocumentType documentType,
 Boolean useTaxDateOverride,
 RefundTransactionModel model)
                                   throws Exception

Create a refund for a transaction Create a refund for a transaction. The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund for a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and specify individual line items from the original sale for refund. The `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that was calculated during the original transaction, regardless of any changes to your company's configuration, rules, nexus, or any other setting. This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following common refund scenarios: * A full refund of a previous sale * Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase * Refunding one or more items (lines) from a previous sale * Granting a customer a percentage refund of a previous sale For more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to create a custom refund transaction. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The code of the company that made the original sale

transactionCode - The transaction code of the original sale

include - Specifies objects to include in the response after transaction is created

documentType - (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

useTaxDateOverride - (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).

model - Information about the refund to create

Returns:

TransactionModel

Throws:

Exception

refundTransactionAsync

public Future<TransactionModel> refundTransactionAsync(String companyCode,
 String transactionCode,
 String include,
 DocumentType documentType,
 Boolean useTaxDateOverride,
 RefundTransactionModel model)

Create a refund for a transaction Create a refund for a transaction. The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund for a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and specify individual line items from the original sale for refund. The `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that was calculated during the original transaction, regardless of any changes to your company's configuration, rules, nexus, or any other setting. This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following common refund scenarios: * A full refund of a previous sale * Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase * Refunding one or more items (lines) from a previous sale * Granting a customer a percentage refund of a previous sale For more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to create a custom refund transaction. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The code of the company that made the original sale

transactionCode - The transaction code of the original sale

include - Specifies objects to include in the response after transaction is created

documentType - (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

useTaxDateOverride - (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).

model - Information about the refund to create

Returns:

TransactionModel

settleTransaction

public TransactionModel settleTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 SettleTransactionModel model)
                                   throws Exception

Perform multiple actions on a transaction Performs one or more actions against the current transaction uniquely identified by this URL. The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. This API is available for users who want to execute more than one action at a time. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to settle

documentType - (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The data from an external system to reconcile against AvaTax

Returns:

TransactionModel

Throws:

Exception

settleTransactionAsync

public Future<TransactionModel> settleTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 SettleTransactionModel model)

Perform multiple actions on a transaction Performs one or more actions against the current transaction uniquely identified by this URL. The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. This API is available for users who want to execute more than one action at a time. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to settle

documentType - (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The data from an external system to reconcile against AvaTax

Returns:

TransactionModel

uncommitTransaction

public TransactionModel uncommitTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)
                                     throws Exception

Uncommit a transaction for reporting Adjusts a transaction by changing it to an uncommitted status. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are no longer available to be uncommitted. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to Uncommit

documentType - (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

Throws:

Exception

uncommitTransactionAsync

public Future<TransactionModel> uncommitTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)

Uncommit a transaction for reporting Adjusts a transaction by changing it to an uncommitted status. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are no longer available to be uncommitted. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to Uncommit

documentType - (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

unvoidTransaction

public TransactionModel unvoidTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)
                                   throws Exception

Unvoids a transaction Unvoids a voided transaction You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to commit

documentType - (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

Throws:

Exception

unvoidTransactionAsync

public Future<TransactionModel> unvoidTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include)

Unvoids a transaction Unvoids a voided transaction You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to commit

documentType - (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

Returns:

TransactionModel

verifyTransaction

public TransactionModel verifyTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 VerifyTransactionModel model)
                                   throws Exception

Verify a transaction Verifies that the transaction uniquely identified by this URL matches certain expected values. If the transaction does not match these expected values, this API will return an error code indicating which value did not match. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to settle

documentType - (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The data from an external system to reconcile against AvaTax

Returns:

TransactionModel

Throws:

Exception

verifyTransactionAsync

public Future<TransactionModel> verifyTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 VerifyTransactionModel model)

Verify a transaction Verifies that the transaction uniquely identified by this URL matches certain expected values. If the transaction does not match these expected values, this API will return an error code indicating which value did not match. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to settle

documentType - (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The data from an external system to reconcile against AvaTax

Returns:

TransactionModel

voidTransaction

public TransactionModel voidTransaction(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 VoidTransactionModel model)
                                 throws Exception

Void a transaction Voids the current transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you void a transaction, that transaction's status is recorded as `DocVoided`. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are no longer available to be voided. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to void

documentType - (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'

Returns:

TransactionModel

Throws:

Exception

voidTransactionAsync

public Future<TransactionModel> voidTransactionAsync(String companyCode,
 String transactionCode,
 DocumentType documentType,
 String include,
 VoidTransactionModel model)

Void a transaction Voids the current transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). When you void a transaction, that transaction's status is recorded as `DocVoided`. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are no longer available to be voided. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines * Details (implies lines) * Summary (implies details) * Addresses * SummaryOnly (omit lines and details - reduces API response size) * LinesOnly (omit details - reduces API response size) * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyCode - The company code of the company that recorded this transaction

transactionCode - The transaction code to void

documentType - (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)

include - Specifies objects to include in this fetch call

model - The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'

Returns:

TransactionModel

createUPCs

public ArrayList<UPCModel> createUPCs(Integer companyId,
 ArrayList<UPCModel> model)
                               throws Exception

Create a new UPC Create one or more new UPC objects attached to this company. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this UPC.

model - The UPC you wish to create.

Returns:

ArrayList

Throws:

Exception

createUPCsAsync

public Future<ArrayList<UPCModel>> createUPCsAsync(Integer companyId,
 ArrayList<UPCModel> model)

Create a new UPC Create one or more new UPC objects attached to this company. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this UPC.

model - The UPC you wish to create.

Returns:

ArrayList

deleteUPC

public ArrayList<ErrorDetail> deleteUPC(Integer companyId,
 Integer id)
                                 throws Exception

Delete a single UPC Marks the UPC object identified by this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this UPC.

id - The ID of the UPC you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteUPCAsync

public Future<ArrayList<ErrorDetail>> deleteUPCAsync(Integer companyId,
 Integer id)

Delete a single UPC Marks the UPC object identified by this URL as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this UPC.

id - The ID of the UPC you wish to delete.

Returns:

ArrayList

getUPC

public UPCModel getUPC(Integer companyId,
 Integer id)
                throws Exception

Retrieve a single UPC Get the UPC object identified by this URL. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this UPC

id - The primary key of this UPC

Returns:

UPCModel

Throws:

Exception

getUPCAsync

public Future<UPCModel> getUPCAsync(Integer companyId,
 Integer id)

Retrieve a single UPC Get the UPC object identified by this URL. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns this UPC

id - The primary key of this UPC

Returns:

UPCModel

listUPCsByCompany

public FetchResult<UPCModel> listUPCsByCompany(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                        throws Exception

Retrieve UPCs for this company List all UPC objects attached to this company. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these UPCs

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listUPCsByCompanyAsync

public Future<FetchResult<UPCModel>> listUPCsByCompanyAsync(Integer companyId,
 String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve UPCs for this company List all UPC objects attached to this company. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that owns these UPCs

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryUPCs

public FetchResult<UPCModel> queryUPCs(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)
                                throws Exception

Retrieve all UPCs Get multiple UPC objects across all companies. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryUPCsAsync

public Future<FetchResult<UPCModel>> queryUPCsAsync(String filter,
 String include,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all UPCs Get multiple UPC objects across all companies. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).

include - A comma separated list of additional data to retrieve.

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateUPC

public UPCModel updateUPC(Integer companyId,
 Integer id,
 UPCModel model)
                   throws Exception

Update a single UPC Replace the existing UPC object at this URL with an updated object. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this UPC belongs to.

id - The ID of the UPC you wish to update

model - The UPC you wish to update.

Returns:

UPCModel

Throws:

Exception

updateUPCAsync

public Future<UPCModel> updateUPCAsync(Integer companyId,
 Integer id,
 UPCModel model)

Update a single UPC Replace the existing UPC object at this URL with an updated object. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaUpc. Swagger Name: AvaTaxClient

Parameters:

companyId - The ID of the company that this UPC belongs to.

id - The ID of the UPC you wish to update

model - The UPC you wish to update.

Returns:

UPCModel

deleteUserDefinedField

public ArrayList<ErrorDetail> deleteUserDefinedField(Integer companyId,
 Long id)
                                              throws Exception

Delete a User Defined Field by User Defined Field id for a company. Marks the existing user defined field for a company as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the User Defined Field belongs to.

id - The id of the User Defined Field you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteUserDefinedFieldAsync

public Future<ArrayList<ErrorDetail>> deleteUserDefinedFieldAsync(Integer companyId,
 Long id)

Delete a User Defined Field by User Defined Field id for a company. Marks the existing user defined field for a company as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the User Defined Field belongs to.

id - The id of the User Defined Field you wish to delete.

Returns:

ArrayList

listUserDefinedFieldsByCompanyId

public FetchResult<CompanyUserDefinedFieldModel> listUserDefinedFieldsByCompanyId(Integer companyId,
 UserDefinedFieldType udfType,
 Boolean allowDefaults)
                                                                           throws Exception

### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId -

udfType - Document or Line level UDF (See UserDefinedFieldType::* for a list of allowable values)

allowDefaults - If true this will add defaulted UDFs to the list that are not named yet

Returns:

FetchResult

Throws:

Exception

listUserDefinedFieldsByCompanyIdAsync

public Future<FetchResult<CompanyUserDefinedFieldModel>> listUserDefinedFieldsByCompanyIdAsync(Integer companyId,
 UserDefinedFieldType udfType,
 Boolean allowDefaults)

### Security 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. Swagger Name: AvaTaxClient

Parameters:

companyId -

udfType - Document or Line level UDF (See UserDefinedFieldType::* for a list of allowable values)

allowDefaults - If true this will add defaulted UDFs to the list that are not named yet

Returns:

FetchResult

updateUserDefinedField

public CompanyUserDefinedFieldModel updateUserDefinedField(Integer companyId,
 Long id,
 CompanyUserDefinedFieldModel model)
                                                    throws Exception

Update a User Defined Field identified by id for a company Updates a User Defined Field for a company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the user defined field belongs to.

id -

model -

Returns:

CompanyUserDefinedFieldModel

Throws:

Exception

updateUserDefinedFieldAsync

public Future<CompanyUserDefinedFieldModel> updateUserDefinedFieldAsync(Integer companyId,
 Long id,
 CompanyUserDefinedFieldModel model)

Update a User Defined Field identified by id for a company Updates a User Defined Field for a company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. Swagger Name: AvaTaxClient

Parameters:

companyId - The id of the company the user defined field belongs to.

id -

model -

Returns:

CompanyUserDefinedFieldModel

changePassword

public String changePassword(PasswordChangeModel model)
                      throws Exception

Change Password Allows a user to change their password via an API call. This API allows an authenticated user to change their password via an API call. This feature is only available for accounts that do not use SAML integrated password validation. This API only allows the currently authenticated user to change their password; it cannot be used to apply to a different user than the one authenticating the current API call. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

model - An object containing your current password and the new password.

Returns:

String

Throws:

Exception

changePasswordAsync

public Future<String> changePasswordAsync(PasswordChangeModel model)

Change Password Allows a user to change their password via an API call. This API allows an authenticated user to change their password via an API call. This feature is only available for accounts that do not use SAML integrated password validation. This API only allows the currently authenticated user to change their password; it cannot be used to apply to a different user than the one authenticating the current API call. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

model - An object containing your current password and the new password.

Returns:

String

createUsers

public ArrayList<UserModel> createUsers(Integer accountId,
 ArrayList<UserModel> model)
                                 throws Exception

Create new users Create one or more new user objects attached to this account. A user represents one person with access privileges to make API calls and work with a specific account. Users who are account administrators or company users are permitted to create user records to invite additional team members to work with AvaTax. A newly created user will receive an email inviting them to create their password. This means that you must provide a valid email address for all user accounts created. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The unique ID number of the account where these users will be created.

model - The user or array of users you wish to create.

Returns:

ArrayList

Throws:

Exception

createUsersAsync

public Future<ArrayList<UserModel>> createUsersAsync(Integer accountId,
 ArrayList<UserModel> model)

Create new users Create one or more new user objects attached to this account. A user represents one person with access privileges to make API calls and work with a specific account. Users who are account administrators or company users are permitted to create user records to invite additional team members to work with AvaTax. A newly created user will receive an email inviting them to create their password. This means that you must provide a valid email address for all user accounts created. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The unique ID number of the account where these users will be created.

model - The user or array of users you wish to create.

Returns:

ArrayList

deleteUser

public ArrayList<ErrorDetail> deleteUser(Integer id,
 Integer accountId)
                                  throws Exception

Delete a single user Mark the user object identified by this URL as deleted. This API is available for use by account and company administrators only. Account and company administrators may only delete users within the appropriate organizations they control. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user you wish to delete.

accountId - The accountID of the user you wish to delete.

Returns:

ArrayList

Throws:

Exception

deleteUserAsync

public Future<ArrayList<ErrorDetail>> deleteUserAsync(Integer id,
 Integer accountId)

Delete a single user Mark the user object identified by this URL as deleted. This API is available for use by account and company administrators only. Account and company administrators may only delete users within the appropriate organizations they control. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user you wish to delete.

accountId - The accountID of the user you wish to delete.

Returns:

ArrayList

getUser

public UserModel getUser(Integer id,
 Integer accountId,
 String include)
                  throws Exception

Retrieve a single user Get the user object identified by this URL. A user represents one person with access privileges to make API calls and work with a specific account. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user to retrieve.

accountId - The accountID of the user you wish to get.

include - Optional fetch commands.

Returns:

UserModel

Throws:

Exception

getUserAsync

public Future<UserModel> getUserAsync(Integer id,
 Integer accountId,
 String include)

Retrieve a single user Get the user object identified by this URL. A user represents one person with access privileges to make API calls and work with a specific account. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user to retrieve.

accountId - The accountID of the user you wish to get.

include - Optional fetch commands.

Returns:

UserModel

getUserEntitlements

public UserEntitlementModel getUserEntitlements(Integer id,
 Integer accountId)
                                         throws Exception

Retrieve all entitlements for a single user Return a list of all entitlements to which this user has rights to access. Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use. This API call is intended to provide a validation endpoint to determine, before making an API call, whether this call is likely to succeed. For example, if user 567 within account 999 is attempting to create a new child company underneath company 12345, you could preview the user's entitlements and predict whether this call would succeed: * Retrieve entitlements by calling '/api/v2/accounts/999/users/567/entitlements' . If the call fails, you do not have accurate credentials for this user. * If the 'accessLevel' field within entitlements is 'None', the call will fail. * If the 'accessLevel' field within entitlements is 'SingleCompany' or 'SingleAccount', the call will fail if the companies table does not contain the ID number 12345. * If the 'permissions' array within entitlements does not contain 'AccountSvc.CompanySave', the call will fail. For a full list of defined permissions, please use '/api/v2/definitions/permissions' . ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user to retrieve.

accountId - The accountID of the user you wish to get.

Returns:

UserEntitlementModel

Throws:

Exception

getUserEntitlementsAsync

public Future<UserEntitlementModel> getUserEntitlementsAsync(Integer id,
 Integer accountId)

Retrieve all entitlements for a single user Return a list of all entitlements to which this user has rights to access. Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use. This API call is intended to provide a validation endpoint to determine, before making an API call, whether this call is likely to succeed. For example, if user 567 within account 999 is attempting to create a new child company underneath company 12345, you could preview the user's entitlements and predict whether this call would succeed: * Retrieve entitlements by calling '/api/v2/accounts/999/users/567/entitlements' . If the call fails, you do not have accurate credentials for this user. * If the 'accessLevel' field within entitlements is 'None', the call will fail. * If the 'accessLevel' field within entitlements is 'SingleCompany' or 'SingleAccount', the call will fail if the companies table does not contain the ID number 12345. * If the 'permissions' array within entitlements does not contain 'AccountSvc.CompanySave', the call will fail. For a full list of defined permissions, please use '/api/v2/definitions/permissions' . ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user to retrieve.

accountId - The accountID of the user you wish to get.

Returns:

UserEntitlementModel

listUsersByAccount

public FetchResult<UserModel> listUsersByAccount(Integer accountId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                          throws Exception

Retrieve users for this account List all user objects attached to this account. A user represents one person with access privileges to make API calls and work with a specific account. When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The accountID of the user you wish to list.

include - Optional fetch commands.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

listUsersByAccountAsync

public Future<FetchResult<UserModel>> listUsersByAccountAsync(Integer accountId,
 String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve users for this account List all user objects attached to this account. A user represents one person with access privileges to make API calls and work with a specific account. When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

accountId - The accountID of the user you wish to list.

include - Optional fetch commands.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

queryUsers

public FetchResult<UserModel> queryUsers(String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)
                                  throws Exception

Retrieve all users Get multiple user objects across all accounts. A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key. When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

include - Optional fetch commands.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

Throws:

Exception

queryUsersAsync

public Future<FetchResult<UserModel>> queryUsersAsync(String include,
 String filter,
 Integer top,
 Integer skip,
 String orderBy)

Retrieve all users Get multiple user objects across all accounts. A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key. When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

include - Optional fetch commands.

filter - A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail

top - If nonzero, return no more than this number of results. Used with `$skip` to 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 - If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.

orderBy - A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.

Returns:

FetchResult

updateUser

public UserModel updateUser(Integer id,
 Integer accountId,
 UserModel model)
                     throws Exception

Update a single user Replace the existing user object at this URL with an updated object. A user represents one person with access privileges to make API calls and work with a specific account. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user you wish to update.

accountId - The accountID of the user you wish to update.

model - The user object you wish to update.

Returns:

UserModel

Throws:

Exception

updateUserAsync

public Future<UserModel> updateUserAsync(Integer id,
 Integer accountId,
 UserModel model)

Update a single user Replace the existing user object at this URL with an updated object. A user represents one person with access privileges to make API calls and work with a specific account. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

id - The ID of the user you wish to update.

accountId - The accountID of the user you wish to update.

model - The user object you wish to update.

Returns:

UserModel

getMySubscription

public SubscriptionModel getMySubscription(String serviceTypeId)
                                    throws Exception

Checks if the current user is subscribed to a specific service Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account. This API will return an error if it is called with invalid authentication credentials. This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use Swagger Name: AvaTaxClient

Parameters:

serviceTypeId - The service to check

Returns:

SubscriptionModel

Throws:

Exception

getMySubscriptionAsync

public Future<SubscriptionModel> getMySubscriptionAsync(String serviceTypeId)

Checks if the current user is subscribed to a specific service Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account. This API will return an error if it is called with invalid authentication credentials. This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use Swagger Name: AvaTaxClient

Parameters:

serviceTypeId - The service to check

Returns:

SubscriptionModel

listMySubscriptions

public FetchResult<SubscriptionModel> listMySubscriptions()
                                                   throws Exception

List all services to which the current user is subscribed Returns the list of all subscriptions enabled for the currently logged in user. This API will return an error if it is called with invalid authentication credentials. This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use Swagger Name: AvaTaxClient

Returns:

FetchResult

Throws:

Exception

listMySubscriptionsAsync

public Future<FetchResult<SubscriptionModel>> listMySubscriptionsAsync()

List all services to which the current user is subscribed Returns the list of all subscriptions enabled for the currently logged in user. This API will return an error if it is called with invalid authentication credentials. This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use Swagger Name: AvaTaxClient

Returns:

FetchResult

ping

public PingResultModel ping()
                     throws Exception

Tests connectivity and version of the service Check connectivity to AvaTax and return information about the AvaTax API server. This API is intended to help you verify that your connection is working. This API will always succeed and will never return a error. It provides basic information about the server you connect to: * `version` - The version number of the AvaTax API server that responded to your request. The AvaTax API version number is updated once per month during Avalara's update process. * `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request. * `authenticationType` - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication. * `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user. * `authenticatedUserId` - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user. * `authenticatedAccountId` - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user. This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even if you do not have verified connection credentials. If this API fails, either your computer is not connected to the internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available. For more information on the uptime of AvaTax, please see [Avalara's AvaTax Status Page](https://status.avalara.com/). ### Security Policies * This API may be called without providing authentication credentials. Swagger Name: AvaTaxClient

Returns:

PingResultModel

Throws:

Exception

pingAsync

public Future<PingResultModel> pingAsync()

Tests connectivity and version of the service Check connectivity to AvaTax and return information about the AvaTax API server. This API is intended to help you verify that your connection is working. This API will always succeed and will never return a error. It provides basic information about the server you connect to: * `version` - The version number of the AvaTax API server that responded to your request. The AvaTax API version number is updated once per month during Avalara's update process. * `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request. * `authenticationType` - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication. * `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user. * `authenticatedUserId` - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user. * `authenticatedAccountId` - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user. This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even if you do not have verified connection credentials. If this API fails, either your computer is not connected to the internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available. For more information on the uptime of AvaTax, please see [Avalara's AvaTax Status Page](https://status.avalara.com/). ### Security Policies * This API may be called without providing authentication credentials. Swagger Name: AvaTaxClient

Returns:

PingResultModel

verifyAge

public AgeVerifyResult verifyAge(String simulatedFailureCode,
 AgeVerifyRequest model)
                          throws Exception

Determines whether an individual meets or exceeds the minimum legal drinking age. The request must meet the following criteria in order to be evaluated: * *firstName*, *lastName*, and *address* are required fields. * One of the following sets of attributes are required for the *address*: * *line1, city, region* * *line1, postalCode* Optionally, the transaction and its lines may use the following parameters: * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21). * Beyond the required *address* fields above, a *country* field is permitted * The valid values for this attribute are [*US, USA*] **Security Policies** Swagger Name: AvaTaxBeverageClient

Parameters:

simulatedFailureCode - (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.

model - Information about the individual whose age is being verified.

Returns:

AgeVerifyResult

Throws:

Exception

verifyAgeAsync

public Future<AgeVerifyResult> verifyAgeAsync(String simulatedFailureCode,
 AgeVerifyRequest model)

Determines whether an individual meets or exceeds the minimum legal drinking age. The request must meet the following criteria in order to be evaluated: * *firstName*, *lastName*, and *address* are required fields. * One of the following sets of attributes are required for the *address*: * *line1, city, region* * *line1, postalCode* Optionally, the transaction and its lines may use the following parameters: * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21). * Beyond the required *address* fields above, a *country* field is permitted * The valid values for this attribute are [*US, USA*] **Security Policies** Swagger Name: AvaTaxBeverageClient

Parameters:

simulatedFailureCode - (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.

model - Information about the individual whose age is being verified.

Returns:

AgeVerifyResult

deregisterShipment

public Void deregisterShipment(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)
                        throws Exception

Removes the transaction from consideration when evaluating regulations that span multiple transactions. Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

Void

Throws:

Exception

deregisterShipmentAsync

public Future<Void> deregisterShipmentAsync(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)

Removes the transaction from consideration when evaluating regulations that span multiple transactions. Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

Void

registerShipment

public Void registerShipment(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)
                      throws Exception

Registers the transaction so that it may be included when evaluating regulations that span multiple transactions. Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

Void

Throws:

Exception

registerShipmentAsync

public Future<Void> registerShipmentAsync(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)

Registers the transaction so that it may be included when evaluating regulations that span multiple transactions. Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

Void

registerShipmentIfCompliant

public ShippingVerifyResult registerShipmentIfCompliant(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)
                                                 throws Exception

Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions. Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

ShippingVerifyResult

Throws:

Exception

registerShipmentIfCompliantAsync

public Future<ShippingVerifyResult> registerShipmentIfCompliantAsync(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)

Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions. Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

ShippingVerifyResult

verifyShipment

public ShippingVerifyResult verifyShipment(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)
                                    throws Exception

Evaluates a transaction against a set of direct-to-consumer shipping regulations. The transaction and its lines must meet the following criteria in order to be evaluated: * The transaction must be recorded. Using a type of *SalesInvoice* is recommended. * A parameter with the name *AlcoholRouteType* must be specified and the value must be one of the following: '*DTC*', '*Retailer DTC*' * A parameter with the name *RecipientName* must be specified and the value must be the name of the recipient. * Each alcohol line must include a *ContainerSize* parameter that describes the volume of a single container. Use the *unit* field to specify one of the following units: '*Litre*', '*Millilitre*', '*gallon (US fluid)*', '*quart (US fluid)*', '*ounce (fluid US customary)*' * Each alcohol line must include a *PackSize* parameter that describes the number of containers in a pack. Specify *Count* in the *unit* field. * Each alcohol line must include a *AlcoholContent* parameter that describes the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field. If unable to provide this parameter, use version 2.1 of the API. Optionally, the transaction and its lines may use the following parameters: * The *ShipDate* parameter may be used if the date of shipment is different than the date of the transaction. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *RecipientDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *PurchaserDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value. **Security Policies** Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

ShippingVerifyResult

Throws:

Exception

verifyShipmentAsync

public Future<ShippingVerifyResult> verifyShipmentAsync(String companyCode,
 String transactionCode,
 String documentType,
 String api_version,
 String x_avalara_version)

Evaluates a transaction against a set of direct-to-consumer shipping regulations. The transaction and its lines must meet the following criteria in order to be evaluated: * The transaction must be recorded. Using a type of *SalesInvoice* is recommended. * A parameter with the name *AlcoholRouteType* must be specified and the value must be one of the following: '*DTC*', '*Retailer DTC*' * A parameter with the name *RecipientName* must be specified and the value must be the name of the recipient. * Each alcohol line must include a *ContainerSize* parameter that describes the volume of a single container. Use the *unit* field to specify one of the following units: '*Litre*', '*Millilitre*', '*gallon (US fluid)*', '*quart (US fluid)*', '*ounce (fluid US customary)*' * Each alcohol line must include a *PackSize* parameter that describes the number of containers in a pack. Specify *Count* in the *unit* field. * Each alcohol line must include a *AlcoholContent* parameter that describes the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field. If unable to provide this parameter, use version 2.1 of the API. Optionally, the transaction and its lines may use the following parameters: * The *ShipDate* parameter may be used if the date of shipment is different than the date of the transaction. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *RecipientDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *PurchaserDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value. **Security Policies** Swagger Name: AvaTaxBeverageClient

Parameters:

companyCode - The company code of the company that recorded the transaction

transactionCode - The transaction code to retrieve

documentType - (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice"

api_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2

x_avalara_version - (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present.

Returns:

ShippingVerifyResult