From 9295c16acb7c0b91d0ef534b8f8f0cb2427ad580 Mon Sep 17 00:00:00 2001 From: Genevieve Conty Date: Tue, 16 Apr 2019 14:21:22 -0700 Subject: [PATCH 1/2] 19.4.0 update --- lib/AvaTaxClient.js | 3034 +++++++++++++++++++++++++++++-------------- package.json | 2 +- 2 files changed, 2039 insertions(+), 997 deletions(-) diff --git a/lib/AvaTaxClient.js b/lib/AvaTaxClient.js index 75f4d922..9eb8a8c8 100644 --- a/lib/AvaTaxClient.js +++ b/lib/AvaTaxClient.js @@ -10,7 +10,7 @@ * @author Ted Spence * @copyright 2004-2018 Avalara, Inc. * @license https://www.apache.org/licenses/LICENSE-2.0 - * @version 19.3.0 + * @version 19.4.0 * @link https://github.com/avadev/AvaTax-REST-V2-JS-SDK */ @@ -41,7 +41,7 @@ export default class AvaTaxClient { appName + '; ' + appVersion + - '; JavascriptSdk; 19.3.0; ' + + '; JavascriptSdk; 19.4.0; ' + machineName; } @@ -84,10 +84,7 @@ export default class AvaTaxClient { }, body: JSON.stringify(payload) }).then(res => { - - var contentType = res.headers._headers['content-type'] ? res.headers._headers['content-type'][0] : ''; - // Avatax currently responds with a Content-Type of 'test/csv' NOT 'text/csv' - if (contentType === 'application/vnd.ms-excel' || /te[xs]t\/csv/.test(contentType)) { + if (res.headers._headers['content-type'][0] === 'application/vnd.ms-excel') { return res; } return res.json(); @@ -143,6 +140,10 @@ export default class AvaTaxClient { * * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param int id The ID of the account you wish to update. @@ -170,6 +171,10 @@ export default class AvaTaxClient { * * 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. * * * @param int id The ID of the account to activate @@ -201,6 +206,10 @@ export default class AvaTaxClient { * * 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. * * * @param int id The ID of the account you wish to audit. @@ -231,6 +240,10 @@ export default class AvaTaxClient { * * * 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. * * * @param int id The ID of the account to retrieve @@ -262,6 +275,10 @@ export default class AvaTaxClient { * * 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. * * * @param int id @@ -290,6 +307,10 @@ export default class AvaTaxClient { * * 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. * * * @param string 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. @@ -328,6 +349,10 @@ export default class AvaTaxClient { * * 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. * * * @param int id @@ -345,12 +370,17 @@ export default class AvaTaxClient { /** * 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 + * 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. + * + * ### 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. * * * @param string line1 Line 1 @@ -383,12 +413,17 @@ export default class AvaTaxClient { /** * 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 + * 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. * * * @param object model The address to resolve @@ -407,6 +442,12 @@ export default class AvaTaxClient { * * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param object[] model The AvaFileForm you wish to create. @@ -424,6 +465,12 @@ export default class AvaTaxClient { * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The ID of the AvaFileForm you wish to delete. @@ -441,6 +488,12 @@ export default class AvaTaxClient { * 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 is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int id The primary key of this AvaFileForm @@ -459,6 +512,12 @@ export default class AvaTaxClient { * * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param string 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 @@ -487,6 +546,12 @@ export default class AvaTaxClient { * * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The ID of the AvaFileForm you wish to update @@ -518,6 +583,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that owns this batch. @@ -545,6 +614,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that owns this batch. @@ -563,6 +636,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that owns this batch @@ -596,6 +673,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that owns this batch @@ -634,6 +715,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that owns these batches @@ -679,6 +764,10 @@ export default class AvaTaxClient { * 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. * * * @param string 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 @@ -720,6 +809,11 @@ export default class AvaTaxClient { * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that will record certificates @@ -753,6 +847,11 @@ export default class AvaTaxClient { * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that issued this invitation @@ -789,6 +888,11 @@ export default class AvaTaxClient { * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that issued this invitation @@ -817,24 +921,29 @@ export default class AvaTaxClient { * 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 + * 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: - * + * * * A list of exposure zones 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 - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * storage for this company, call `RequestCertificateSetup`. + * + * ### 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. * * * @param int companyId The ID number of the company recording this certificate @@ -856,18 +965,23 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -886,19 +1000,24 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -922,22 +1041,27 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The ID number of the company that recorded this certificate @@ -959,12 +1083,17 @@ export default class AvaTaxClient { * 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 + * + * 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. * * * @param int companyId The company ID to check @@ -982,19 +1111,24 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -1014,20 +1148,25 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -1047,19 +1186,24 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -1078,24 +1222,29 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate * @param int id The unique ID number of this certificate - * @param string include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. + * @param string include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. * @return FetchResult */ listCustomersForCertificate({ companyId, id, include } = {}) { @@ -1112,22 +1261,27 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The ID number of the company to search @@ -1156,14 +1310,19 @@ export default class AvaTaxClient { * 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 + * + * 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. * * * @param int companyId @@ -1181,19 +1340,24 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -1213,21 +1377,26 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -1247,16 +1416,21 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The ID number of the company that recorded this certificate @@ -1276,19 +1450,24 @@ export default class AvaTaxClient { * 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 + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this certificate @@ -1320,6 +1499,10 @@ export default class AvaTaxClient { * * 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, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param int id @@ -1349,6 +1532,10 @@ export default class AvaTaxClient { * 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. * * * @param object model Information about the company you wish to create. @@ -1368,6 +1555,10 @@ export default class AvaTaxClient { * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param object[] model Either a single company object or an array of companies to create @@ -1394,6 +1585,10 @@ export default class AvaTaxClient { * 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 requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param int id The unique identifier of the company @@ -1412,6 +1607,10 @@ export default class AvaTaxClient { * 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. * * * @param int id The ID of the company you wish to delete. @@ -1432,6 +1631,12 @@ export default class AvaTaxClient { * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique identifier of the company @@ -1452,6 +1657,12 @@ export default class AvaTaxClient { * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique identifier of the company @@ -1483,10 +1694,14 @@ export default class AvaTaxClient { * * TaxCodes * * TaxRules * * UPC + * + * ### 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. * * * @param int id The ID of the company to retrieve. - * @param string 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", or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects. + * @param string 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. * @return object */ getCompany({ id, include } = {}) { @@ -1514,6 +1729,10 @@ export default class AvaTaxClient { * * 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. * * * @param int id @@ -1543,6 +1762,10 @@ export default class AvaTaxClient { * * `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. + * + * ### 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. * * * @param int id @@ -1563,6 +1786,10 @@ export default class AvaTaxClient { * 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 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. * * * @param int id The unique identifier of the company @@ -1582,6 +1809,10 @@ export default class AvaTaxClient { * 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. * * * @return FetchResult @@ -1613,10 +1844,14 @@ export default class AvaTaxClient { * * TaxCodes * * TaxRules * * UPC + * + * ### 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. * * * @param string 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. - * @param string 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:* contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, exemptCerts + * @param string 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:* contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -1651,6 +1886,10 @@ export default class AvaTaxClient { * * 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. * * * @param int id @@ -1677,6 +1916,10 @@ export default class AvaTaxClient { * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param int id The ID of the company you wish to update. @@ -1692,255 +1935,68 @@ export default class AvaTaxClient { } /** - * Retrieve a single tax rate. + * Create a new contact * - * This API is available by invitation only. + * 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. * * - * @param int id The ID of the tax rate to retrieve. - * @return object + * @param int companyId The ID of the company that owns this contact. + * @param object[] model The contacts you wish to create. + * @return object[] */ - getTaxRate({ id } = {}) { + createContacts({ companyId, model } = {}) { var path = this.buildUrl({ - url: `/api/v2/compliance/taxrates/${id}`, + url: `/api/v2/companies/${companyId}/contacts`, parameters: {} }); - return this.restCall({ url: path, verb: 'get', payload: null }); + return this.restCall({ url: path, verb: 'post', payload: model }); } /** - * Retrieve a single tax region. + * Delete a single contact * - * This API is available by invitation only. + * 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. * * - * @param int id The ID of the tax region to retrieve. - * @return object + * @param int companyId The ID of the company that owns this contact. + * @param int id The ID of the contact you wish to delete. + * @return object[] */ - getTaxRegion({ id } = {}) { + deleteContact({ companyId, id } = {}) { var path = this.buildUrl({ - url: `/api/v2/compliance/taxregions/${id}`, + url: `/api/v2/companies/${companyId}/contacts/${id}`, parameters: {} }); - return this.restCall({ url: path, verb: 'get', payload: null }); + return this.restCall({ url: path, verb: 'delete', payload: null }); } /** - * Retrieve jurisdictions and rates in a combined format. + * Retrieve a single contact * - * This API is available by invitation only. + * 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. * * - * @param string effectiveDate Used to limit the jurisdictions returned. - * @param string endDate Used to limit the jurisdictions returned. - * @param string 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/). - * @param string include A comma separated list of objects to fetch underneath this jurisdiction. - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @param int companyId The ID of the company for this contact + * @param int id The primary key of this contact * @return object */ - queryJurisdictionRates({ effectiveDate, endDate, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/compliance/jurisdictionrates`, - parameters: { - effectiveDate: effectiveDate, - endDate: endDate, - $filter: filter, - $include: include, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all unique jurisdictions. - * - * This API is available by invitation only. - * - * 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: - * - * * TaxRates - * - * - * @param string country The two-character ISO-3166 code for the country. - * @param string region The two or three character region code for the region. - * @param string effectiveDate Used to limit the jurisdictions or rates returned. - * @param string endDate Used to limit the jurisdictions or rates returned. - * @param string aggregationOption Aggregation method used if rates are returned using the '$include' parameter. (See StackAggregationOption::* for a list of allowable values) - * @param string include A comma separated list of objects to fetch underneath this tax rate. - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @return object - */ - queryJurisdictions({ country, region, effectiveDate, endDate, aggregationOption, include, top, skip } = {}) { - var path = this.buildUrl({ - url: `/api/v2/compliance/jurisdictions/${country}/${region}`, - parameters: { - effectiveDate: effectiveDate, - endDate: endDate, - aggregationOption: aggregationOption, - $include: include, - $top: top, - $skip: skip - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all tax rates. - * - * This API is available by invitation only. - * - * - * @param string 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/). - * @param string include A comma separated list of objects to fetch underneath this tax rate. - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return object - */ - queryTaxRates({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/compliance/taxrates`, - parameters: { - $filter: filter, - $include: include, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all tax region jurisdictions. - * - * This API is available by invitation only. - * - * - * @param string 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/). - * @param string include A comma separated list of objects to fetch underneath this tax region jurisdiction. - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return object - */ - queryTaxRegionJurisdictions({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/compliance/taxregionjurisdictions`, - parameters: { - $filter: filter, - $include: include, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all tax regions. - * - * This API is available by invitation only. - * - * - * @param string 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/). - * @param string include A comma separated list of objects to fetch underneath this tax region. - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return object - */ - queryTaxRegions({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/compliance/taxregions`, - parameters: { - $filter: filter, - $include: include, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * API to modify the reference fields at the document and the line level. - * - * - * - * - * @param int companyId - * @param object[] model - * @return FetchResult - */ - tagTransaction({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/transactions/tag`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: 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. - * - * - * @param int companyId The ID of the company that owns this contact. - * @param object[] model The contacts you wish to create. - * @return object[] - */ - createContacts({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single contact - * - * Mark the existing contact object at this URL as deleted. - * - * - * @param int companyId The ID of the company that owns this contact. - * @param int id The ID of the contact you wish to delete. - * @return object[] - */ - deleteContact({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * 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. - * - * - * @param int companyId The ID of the company for this contact - * @param int id The primary key of this contact - * @return object - */ - getContact({ companyId, id } = {}) { + getContact({ companyId, id } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyId}/contacts/${id}`, parameters: {} @@ -1955,6 +2011,10 @@ export default class AvaTaxClient { * * 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. * * * @param int companyId The ID of the company that owns these contacts @@ -1988,6 +2048,10 @@ export default class AvaTaxClient { * * 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. * * * @param string 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/). @@ -2019,6 +2083,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that this contact belongs to. @@ -2038,20 +2106,25 @@ export default class AvaTaxClient { * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2070,17 +2143,22 @@ export default class AvaTaxClient { * 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`. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2099,22 +2177,27 @@ export default class AvaTaxClient { * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2136,17 +2219,22 @@ export default class AvaTaxClient { * 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`. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2166,18 +2254,23 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The unique ID number of the company defining customers. @@ -2197,17 +2290,22 @@ export default class AvaTaxClient { * 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`. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2237,20 +2335,25 @@ export default class AvaTaxClient { * List active 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. - * + * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2271,21 +2374,26 @@ export default class AvaTaxClient { * 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. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2314,17 +2422,22 @@ export default class AvaTaxClient { * 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`. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2344,17 +2457,22 @@ export default class AvaTaxClient { * 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`. - * + * * Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates. * Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document + * certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document * 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. * * * @param int companyId The unique ID number of the company that recorded this customer @@ -2374,6 +2492,11 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The id of the company you which to create the datasources @@ -2392,6 +2515,11 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The id of the company the datasource belongs to. @@ -2410,6 +2538,11 @@ export default class AvaTaxClient { * 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. * * * @param int companyId @@ -2428,6 +2561,11 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The id of the company you wish to retrieve the datasources. @@ -2454,9 +2592,14 @@ export default class AvaTaxClient { * 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. * * * @param string 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 @@ -2482,6 +2625,11 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The id of the company the datasource belongs to. @@ -2501,15 +2649,19 @@ export default class AvaTaxClient { * 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. - * + * + * 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. - * + * 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. * * * @param string country The name or code of the destination country. @@ -2554,10 +2706,10 @@ export default class AvaTaxClient { /** * Retrieve the full list of the AvaFile Forms available * - * This API is deprecated. - * + * This API is deprecated. + * * Please use the ListTaxForms API. - * + * * Returns the full list of Avalara-supported AvaFile Forms * This API is intended to be useful to identify all the different AvaFile Forms * @@ -2585,10 +2737,10 @@ export default class AvaTaxClient { * List certificate attributes used by a company * * List the certificate attributes defined by a 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 * check and provision account. * @@ -2616,10 +2768,10 @@ export default class AvaTaxClient { * 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 * check and provision account. * @@ -2647,10 +2799,10 @@ export default class AvaTaxClient { * 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 * check and provision account. * @@ -2756,7 +2908,7 @@ export default class AvaTaxClient { * 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 + * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for * a shipping address. * * @@ -2783,11 +2935,11 @@ export default class AvaTaxClient { * 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 + * 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 * check and provision account. * @@ -2814,14 +2966,18 @@ export default class AvaTaxClient { /** * 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. - * + * 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 + * 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. * * * @param string country The name or code of the destination country. @@ -2848,12 +3004,16 @@ export default class AvaTaxClient { /** * 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 + * 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 + * + * 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. * * * @return FetchResult @@ -2870,7 +3030,7 @@ export default class AvaTaxClient { * 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 * `currencyCode` field in a `CreateTransactionModel`. * @@ -2953,7 +3113,7 @@ export default class AvaTaxClient { * 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' * @@ -2981,9 +3141,9 @@ export default class AvaTaxClient { * 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 + * 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. * * The results of this API call can be passed to the `CreateJurisdictionOverride` API call. @@ -3100,12 +3260,12 @@ export default class AvaTaxClient { /** * 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. - * + * Returns the full list of all Avalara-supported nexus for all countries and regions. + * * This API is intended to be useful if your user interface needs to display a selectable list of nexus. * * - * @param string 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, taxAuthorityId + * @param string 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, taxAuthorityId * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -3141,7 +3301,7 @@ export default class AvaTaxClient { * @param string 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`. * @param string postalCode The postal code or zip code portion of this address. * @param string 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`. - * @param string 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, taxAuthorityId + * @param string 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, taxAuthorityId * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -3171,12 +3331,12 @@ export default class AvaTaxClient { * Retrieve the full list of Avalara-supported nexus for a country. * * Returns all Avalara-supported nexus for the specified country. - * + * * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country. * * * @param string country The country in which you want to fetch the system nexus - * @param string 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, taxAuthorityId + * @param string 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, taxAuthorityId * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -3199,13 +3359,13 @@ export default class AvaTaxClient { * Retrieve the full list of Avalara-supported nexus for a country and region. * * Returns all Avalara-supported nexus for the specified country and region. - * + * * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region. * * * @param string country The two-character ISO-3166 code for the country. * @param string region The two or three character region code for the region. - * @param string 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, taxAuthorityId + * @param string 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, taxAuthorityId * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -3228,16 +3388,20 @@ export default class AvaTaxClient { * 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 + * 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. * * * @param string formCode The form code that we are looking up the nexus for @@ -3542,6 +3706,10 @@ export default class AvaTaxClient { * Retrieve the parameters by companyCode and itemCode. * * Returns the list of parameters based on the company country and state jurisdiction and the item code. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * * @param string companyCode Company code. @@ -3616,11 +3784,11 @@ export default class AvaTaxClient { * 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 * the program. @@ -3649,7 +3817,7 @@ export default class AvaTaxClient { * 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. * More than one tax authority might use the same product classification system, but they might charge different tax rates for products. * @@ -3677,7 +3845,7 @@ export default class AvaTaxClient { * 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. * @@ -3733,7 +3901,7 @@ export default class AvaTaxClient { * 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 + * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region * within the country for a shipping addresses. * * @@ -3760,7 +3928,7 @@ export default class AvaTaxClient { * 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 + * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region * within the country for a shipping addresses. * * @@ -3896,7 +4064,7 @@ export default class AvaTaxClient { * * 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 + * Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically * based on the customer's AvaTax data. * * @@ -3953,6 +4121,10 @@ export default class AvaTaxClient { * 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. * * * @param string 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/). @@ -4079,7 +4251,7 @@ export default class AvaTaxClient { * List all defined units of measurement * * List all units of measurement systems defined by Avalara. - * + * * A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others. * * @@ -4110,6 +4282,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The unique ID number of the company that owns this DistanceThreshold @@ -4132,6 +4308,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The unique ID number of the company that owns this DistanceThreshold @@ -4154,6 +4334,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company that owns this DistanceThreshold object @@ -4176,6 +4360,10 @@ export default class AvaTaxClient { * 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. * * * @param int companyId The ID of the company whose DistanceThreshold objects you wish to list. @@ -4211,6 +4399,10 @@ export default class AvaTaxClient { * * 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. * * * @param string 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/). @@ -4245,6 +4437,10 @@ export default class AvaTaxClient { * * 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. * * * @param int companyId The unique ID number of the company that owns this DistanceThreshold object. @@ -4260,116 +4456,6 @@ export default class AvaTaxClient { return this.restCall({ url: path, verb: 'put', payload: model }); } - /** - * Bridge API for integration of validated certificates - * - * This API is for use by invitation only. - * - * - * @param object[] model Either a single exempt certificate or an array of certificates to create - * @return object[] - */ - certCaptureBridge({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/certcapturebridge`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Get an ECMS identified by company id and ECMS id - * - * Get an ECMS identified by company id and ECMS id. - * An ECMS data represents a documentation based on which companies can claim tax exemption - * You may attach nested data objects such as exempt cert detail, and those objects will be created with certificate. - * 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: - * - * * Details - * - * - * @param int companyId company to retrieve exempt certificate for - * @param int ecmsId exempt certificate Id - * @param string include - * @return object - */ - getECMSById({ companyId, ecmsId, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/ecms/${ecmsId}`, - parameters: { - $include: include - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get list of ECMS data for this company - * - * Get list of ECMS data for this company - * An ECMS data represents a documentation based on which companies can claim tax exemption - * You may attach nested data objects such as ECMS detail, and those objects will be created with certificate. - * 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: - * - * * Details - * - * - * @param int companyId which company to retrieve certificates from - * @param string 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/). - * @param string include - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return object[] - */ - listECMSByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/ecms`, - parameters: { - $filter: filter, - $include: include, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get all exempt certificates - * - * Get all ECMS currently available in database. - * An ECMS data represents a documentation based on which companies can claim tax exemption - * You may attach nested data objects such as ECMS detail, and those objects will be created with certificate. - * 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: - * - * * Details - * - * - * @param string 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/). - * @param string include - * @param int 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. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return object[] - */ - queryECMS({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/ecms`, - parameters: { - $filter: filter, - $include: include, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - /** * Approve existing Filing Request * @@ -4377,6 +4463,12 @@ export default class AvaTaxClient { * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. * The filing request must be in the "ChangeRequest" status to be approved. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing request object @@ -4397,6 +4489,12 @@ export default class AvaTaxClient { * This API is available by invitation only. * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing request object @@ -4415,9 +4513,15 @@ export default class AvaTaxClient { * Create a new filing request to cancel a filing calendar * * This API is available by invitation only. - * + * * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing calendar object @@ -4438,6 +4542,12 @@ export default class AvaTaxClient { * * This API is available by invitation only and only available for users with Compliance access * A "filing request" represents information that compliance uses to file a return + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that will add the new filing calendar @@ -4458,6 +4568,12 @@ export default class AvaTaxClient { * This API is available by invitation only. * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that will add the new filing calendar @@ -4476,6 +4592,12 @@ export default class AvaTaxClient { * Returns a list of options for adding the specified form. * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing calendar object @@ -4496,6 +4618,12 @@ export default class AvaTaxClient { * Indicates when changes are allowed to be made to a filing calendar. * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing calendar object @@ -4515,6 +4643,12 @@ export default class AvaTaxClient { * Returns a list of options for expiring a filing calendar * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing calendar object @@ -4536,6 +4670,12 @@ export default class AvaTaxClient { * Mark the existing notice object at this URL as deleted. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this filing calendar. @@ -4554,6 +4694,12 @@ export default class AvaTaxClient { * Retrieve a single filing calendar * * This API is available by invitation only. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this filing calendar @@ -4574,6 +4720,12 @@ export default class AvaTaxClient { * This API is available by invitation only. * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this filing calendar @@ -4592,6 +4744,12 @@ export default class AvaTaxClient { * Retrieve all filing calendars for this company * * This API is available by invitation only. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns these batches @@ -4624,6 +4782,12 @@ export default class AvaTaxClient { * This API is available by invitation only. * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns these batches @@ -4652,8 +4816,14 @@ export default class AvaTaxClient { * New request for getting for validating customer's login credentials * * This API is available by invitation only. - * + * * This API verifies that a customer has submitted correct login credentials for a tax authority's online filing system. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param object model The model of the login information we are verifying @@ -4671,9 +4841,15 @@ export default class AvaTaxClient { * Gets the request status and Login Result * * This API is available by invitation only. - * - * This API checks the status of a login verification request. It may only be called by authorized users from the account + * + * This API checks the status of a login verification request. It may only be called by authorized users from the account * that initially requested the login verification. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int jobId The unique ID number of this login request @@ -4691,8 +4867,14 @@ export default class AvaTaxClient { * Retrieve all filing calendars * * This API is available by invitation only. - * + * * This API is deprecated - please use POST `/api/v2/filingrequests/query` API. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param string 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:* formCountry, formRegion, taxFormCode, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings @@ -4722,9 +4904,15 @@ export default class AvaTaxClient { * Retrieve all filing calendars * * This API is available by invitation only. - * + * * This API is intended to replace the GET `/api/v2/filingcalendars` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters. * The documentation of the GET API shows how filtering, sorting and pagination works. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param string returnCountry If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes. @@ -4747,14 +4935,20 @@ export default class AvaTaxClient { * Retrieve all filing requests * * This API is available by invitation only. - * + * * This API is deprecated - please use POST `/api/v2/filingrequests/query` API. - * + * * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. - * + * * 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int filingCalendarId Specific filing calendar id for the request @@ -4782,9 +4976,15 @@ export default class AvaTaxClient { * Retrieve all filing requests * * This API is available by invitation only. - * + * * This API is intended to replace the GET `/api/v2/filingrequests` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters. * The documentation of the GET API shows how filtering, sorting and pagination works. + * + * ### 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. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int filingCalendarId Specific filing calendar id for the request @@ -4805,12 +5005,18 @@ export default class AvaTaxClient { * Create a new filing request to edit a filing calendar * * This API is available by invitation only. - * + * * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. - * + * * Certain users may not update filing calendars directly. Instead, they may submit an edit request * to modify the value of a filing calendar using this API. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing calendar object @@ -4830,6 +5036,12 @@ export default class AvaTaxClient { * Edit existing Filing Calendar * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing calendar object @@ -4851,6 +5063,12 @@ export default class AvaTaxClient { * This API is available by invitation only. * A "filing request" represents a request to change an existing filing calendar. Filing requests * are reviewed and validated by Avalara Compliance before being implemented. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the filing request object @@ -4871,11 +5089,17 @@ export default class AvaTaxClient { * * This API is available by invitation only. * Approving a return means the customer is ready to let Avalara file that return. - * Customer either approves themselves from admin console, + * Customer either approves themselves from admin console, * else system auto-approves the night before the filing cycle. * Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -4897,11 +5121,17 @@ export default class AvaTaxClient { * * This API is available by invitation only. * Approving a return means the customer is ready to let Avalara file that return. - * Customer either approves themselves from admin console, + * Customer either approves themselves from admin console, * else system auto-approves the night before the filing cycle. * Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -4924,11 +5154,17 @@ export default class AvaTaxClient { * * This API is available by invitation only. * Approving a return means the customer is ready to let Avalara file that return. - * Customer either approves themselves from admin console, + * Customer either approves themselves from admin console, * else system auto-approves the night before the filing cycle * Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -4952,10 +5188,16 @@ export default class AvaTaxClient { * * This API is available by invitation only. * An "Adjustment" is usually an increase or decrease to customer funding to Avalara, - * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. + * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. * Sometimes may be a manual change in tax liability similar to an augmentation. * This API creates a new adjustment for an existing tax filing. * This API can only be used when the filing has not yet been approved. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being adjusted. @@ -4979,10 +5221,16 @@ export default class AvaTaxClient { * Add an augmentation for a given filing. * * This API is available by invitation only. - * An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara + * An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara * usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax. * This API creates a new augmentation for an existing tax filing. * This API can only be used when the filing has not been approved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being changed. @@ -5007,10 +5255,16 @@ export default class AvaTaxClient { * * This API is available by invitation only. * An "Payment" is usually an increase or decrease to customer funding to Avalara, - * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. + * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. * Sometimes may be a manual change in tax liability similar to an augmentation. * This API creates a new payment for an existing tax filing. * This API can only be used when the filing has not yet been approved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being adjusted. @@ -5035,10 +5289,16 @@ export default class AvaTaxClient { * * This API is available by invitation only. * An "Adjustment" is usually an increase or decrease to customer funding to Avalara, - * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. + * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. * Sometimes may be a manual change in tax liability similar to an augmentation. * This API deletes an adjustment for an existing tax filing. * This API can only be used when the filing has been unapproved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being adjusted. @@ -5057,10 +5317,16 @@ export default class AvaTaxClient { * Delete an augmentation for a given filing. * * This API is available by invitation only. - * An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara + * An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara * usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax. * This API deletes an augmentation for an existing tax filing. * This API can only be used when the filing has been unapproved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being changed. @@ -5080,10 +5346,16 @@ export default class AvaTaxClient { * * This API is available by invitation only. * An "Payment" is usually an increase or decrease to customer funding to Avalara, - * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. + * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. * Sometimes may be a manual change in tax liability similar to an augmentation. * This API deletes an payment for an existing tax filing. * This API can only be used when the filing has been unapproved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being adjusted. @@ -5102,6 +5374,12 @@ export default class AvaTaxClient { * Retrieve worksheet checkup report for company and filing period. * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int filingsId The unique id of the worksheet. @@ -5120,6 +5398,12 @@ export default class AvaTaxClient { * Retrieve worksheet checkup report for company and filing period. * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The unique ID of the company that owns the worksheets object. @@ -5138,7 +5422,9 @@ export default class AvaTaxClient { /** * Retrieve a list of filings for the specified accrual return. * - * + * ### 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. * * * @param int companyId The ID of the company that owns these batches @@ -5157,6 +5443,12 @@ export default class AvaTaxClient { * Retrieve a single attachment for a filing * * This API is available by invitation only. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -5178,8 +5470,14 @@ export default class AvaTaxClient { * Retrieve a list of filings for the specified company in the year and month of a given filing period. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -5199,8 +5497,14 @@ export default class AvaTaxClient { * Retrieve a single trace file for a company filing period * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -5220,8 +5524,14 @@ export default class AvaTaxClient { * Retrieve a filing for the specified company and id. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -5243,8 +5553,14 @@ export default class AvaTaxClient { * Retrieve a list of filings for the specified company in the year and month of a given filing period. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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 is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5264,8 +5580,14 @@ export default class AvaTaxClient { * Retrieve a list of filings for the specified company in the given filing period and country. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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 is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5286,8 +5608,14 @@ export default class AvaTaxClient { * Retrieve a list of filings for the specified company in the filing period, country and region. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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 is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5309,8 +5637,14 @@ export default class AvaTaxClient { * Retrieve a list of filings for the specified company in the given filing period, country, region and form. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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 is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5330,10 +5664,14 @@ export default class AvaTaxClient { } /** - * Retrieve a list of filings for the specified company in the year and month of a given filing period. + * Retrieve a list of filings for the specified company in the year and month of a given filing period. This gets the basic information from the filings and doesn't include anything extra. * - * + * ### 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 is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns these batches @@ -5366,8 +5704,14 @@ This gets the basic information from the filings and doesn't include anything ex * Retrieve a list of filings for the specified company in the year and month of a given filing period. * * This API is available by invitation only. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. + * + * ### 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filings. @@ -5398,9 +5742,15 @@ This gets the basic information from the filings and doesn't include anything ex * This API is available by invitation only. * Rebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing. * Rebuilding has to be done whenever a customer adds transactions to a filing. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. * This API requires filing to be unapproved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5423,9 +5773,15 @@ This gets the basic information from the filings and doesn't include anything ex * This API is available by invitation only. * Rebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing. * Rebuilding has to be done whenever a customer adds transactions to a filing. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. * This API requires filing to be unapproved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5448,10 +5804,16 @@ This gets the basic information from the filings and doesn't include anything ex * * This API is available by invitation only.audit.CheckAuthorizationReturns(null, companyId); * Rebuilding a return means re-creating or updating the amounts to be filed for a filing. - * Rebuilding has to be done whenever a customer adds transactions to a filing. - * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, + * Rebuilding has to be done whenever a customer adds transactions to a filing. + * A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing, * based on filing frequency of filing. * This API requires filing to be unapproved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * * @param int companyId The ID of the company that owns the filings. @@ -5475,10 +5837,16 @@ This gets the basic information from the filings and doesn't include anything ex * * This API is available by invitation only. * An "Adjustment" is usually an increase or decrease to customer funding to Avalara, - * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. + * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. * Sometimes may be a manual change in tax liability similar to an augmentation. * This API modifies an adjustment for an existing tax filing. * This API can only be used when the filing has not yet been approved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being adjusted. @@ -5498,10 +5866,16 @@ This gets the basic information from the filings and doesn't include anything ex * Edit an augmentation for a given filing. * * This API is available by invitation only. - * An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara + * An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara * usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax. * This API modifies an augmentation for an existing tax filing. * This API can only be used when the filing has not been approved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being changed. @@ -5522,10 +5896,16 @@ This gets the basic information from the filings and doesn't include anything ex * * This API is available by invitation only. * An "Payment" is usually an increase or decrease to customer funding to Avalara, - * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. + * such as early filer discount amounts that are refunded to the customer, or efile fees from websites. * Sometimes may be a manual change in tax liability similar to an augmentation. * This API modifies an payment for an existing tax filing. * This API can only be used when the filing has not yet been approved. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns the filing being adjusted. @@ -5554,6 +5934,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param object model Required information to provision a free trial account. @@ -5684,6 +6068,12 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The unique ID number of this funding request @@ -5710,6 +6100,12 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The unique ID number of this funding request @@ -5727,12 +6123,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id. @@ -5752,16 +6152,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this item parameter. @@ -5781,7 +6185,7 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -5789,6 +6193,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this item. @@ -5807,14 +6215,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this item. @@ -5833,10 +6245,14 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id. @@ -5856,12 +6272,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id @@ -5881,12 +6301,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this item object @@ -5908,10 +6332,14 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id. @@ -5931,12 +6359,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id @@ -5956,13 +6388,17 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id. @@ -5990,15 +6426,19 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id @@ -6026,21 +6466,25 @@ This gets the basic information from the filings and doesn't include anything ex * 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 one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * * * Parameters * * Classifications + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * * @param int companyId The ID of the company that defined these items @@ -6069,16 +6513,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param string 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, classifications, parameters @@ -6102,50 +6550,25 @@ This gets the basic information from the filings and doesn't include anything ex return this.restCall({ url: path, verb: 'get', payload: null }); } - /** - * 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. - * - * - * @param int companyId The ID of the company that owns this item. - * @param object model The request object. - * @return object - */ - syncItems({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/sync`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: 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, + * + * 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. * * * @param int companyId The ID of the company that this item belongs to. @@ -6165,12 +6588,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id. @@ -6191,12 +6618,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The company id. @@ -6217,11 +6648,15 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that owns this override @@ -6240,6 +6675,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that owns this override @@ -6258,11 +6697,15 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that owns this override @@ -6281,14 +6724,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that owns this override @@ -6317,14 +6764,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param string 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 @@ -6352,6 +6803,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that this jurisdictionoverride belongs to. @@ -6371,6 +6826,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this location. @@ -6389,6 +6848,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this location. @@ -6415,6 +6878,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * ### 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. * * * @param int companyId The ID of the company that owns this location @@ -6446,6 +6913,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * ### 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. * * * @param int companyId The ID of the company that owns these locations @@ -6485,6 +6956,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * ### 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. * * * @param string 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:* settings @@ -6514,6 +6989,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that this location belongs to. @@ -6535,6 +7014,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * * @param int companyId The ID of the company that owns this location @@ -6553,15 +7036,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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`. - * + * + * 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. + * + * ### 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. * * * @param string code The transaction code for this MultiDocument transaction @@ -6585,18 +7073,23 @@ This gets the basic information from the filings and doesn't include anything ex * * Retrieve audit information about a MultiDocument transaction stored in AvaTax. * - * The audit API retrieves audit information related to a specific MultiDocument transaction. This audit + * 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). + * + * ### 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. * * * @param string code The transaction code for this MultiDocument transaction @@ -6615,13 +7108,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### 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. * * * @param object model The commit request you wish to execute @@ -6639,26 +7137,26 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -6670,6 +7168,11 @@ This gets the basic information from the filings and doesn't include anything ex * * 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`. + * + * ### 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. * * * @param string include Specifies objects to include in the response after transaction is created @@ -6690,9 +7193,9 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -6701,6 +7204,11 @@ This gets the basic information from the filings and doesn't include anything ex * * Addresses * * SummaryOnly (omit lines and details - reduces API response size) * * LinesOnly (omit details - reduces API response size) + * + * ### 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. * * * @param string code @@ -6722,18 +7230,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -6742,6 +7250,11 @@ This gets the basic information from the filings and doesn't include anything ex * * Addresses * * SummaryOnly (omit lines and details - reduces API response size) * * LinesOnly (omit details - reduces API response size) + * + * ### 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. * * * @param int id The unique ID number of the MultiDocument transaction to retrieve @@ -6762,16 +7275,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -6780,6 +7293,11 @@ This gets the basic information from the filings and doesn't include anything ex * * Addresses * * SummaryOnly (omit lines and details - reduces API response size) * * LinesOnly (omit details - reduces API response size) + * + * ### 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. * * * @param string 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 @@ -6807,31 +7325,31 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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 @@ -6842,6 +7360,11 @@ This gets the basic information from the filings and doesn't include anything ex * * 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, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * This API depends on the following active services
*Required* (all): AvaTaxPro. * * * @param string code The code of this MultiDocument transaction @@ -6864,11 +7387,16 @@ This gets the basic information from the filings and doesn't include anything ex * 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). + * + * ### 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. * * * @param object model Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax @@ -6886,14 +7414,19 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### 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. * * * @param string code The transaction code for this MultiDocument transaction @@ -6913,24 +7446,28 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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 + * 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`, + * + * 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. * * * @param int companyId The ID of the company that owns this nexus. @@ -6948,21 +7485,25 @@ This gets the basic information from the filings and doesn't include anything ex /** * 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 + * 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 + * + * 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. * * * @param int companyId The ID of the company that will own this nexus. @@ -6981,13 +7522,17 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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. * * * @param int companyId The ID of the company that owns this nexus. @@ -7006,10 +7551,14 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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. + * + * ### 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. * * * @param int companyId The ID of the company that owns this nexus object @@ -7028,14 +7577,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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 + * 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. * * * @param int companyId The ID of the company that owns this nexus object @@ -7054,17 +7607,21 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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. + * + * ### 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. * * * @param int companyId The ID of the company that owns these nexus objects - * @param string 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, taxAuthorityId + * @param string 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, taxAuthorityId * @param string include A comma separated list of additional data to retrieve. * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. @@ -7085,45 +7642,24 @@ This gets the basic information from the filings and doesn't include anything ex return this.restCall({ url: path, verb: 'get', payload: null }); } - /** - * Summarize nexus by NexusTaxTypeGroup for this company - * - * Provides a summary of nexus information useful for quickly displaying key information. - * - * 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 produces only basic information about your company's nexus declarations. For example, it will show - * the number of nexus declarations of each tax type. To request more information about your company's nexus - * declarations, please use `QueryNexus` or `ListNexusByCompany`. - * - * - * @param int companyId The ID of the company that owns these nexus objects - * @return object - */ - nexusSummary({ companyId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/summary`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - /** * 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 + * + * 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. + * + * ### 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. * * - * @param string 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, taxAuthorityId + * @param string 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, taxAuthorityId * @param string include A comma separated list of additional data to retrieve. * @param int 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. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. @@ -7148,24 +7684,28 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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 + * 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`, + * + * 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. * * * @param int companyId The ID of the company that this nexus belongs to. @@ -7188,6 +7728,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7211,6 +7757,12 @@ This gets the basic information from the filings and doesn't include anything ex * as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7233,6 +7785,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7255,6 +7813,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice root causes' are are those who are responsible for the notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7277,6 +7841,12 @@ This gets the basic information from the filings and doesn't include anything ex * Create one or more new notice objects. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7298,6 +7868,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7321,6 +7897,12 @@ This gets the basic information from the filings and doesn't include anything ex * as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7343,6 +7925,12 @@ This gets the basic information from the filings and doesn't include anything ex * Mark the existing notice object at this URL as deleted. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7364,6 +7952,12 @@ This gets the basic information from the filings and doesn't include anything ex * Mark the existing notice object at this URL as deleted. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7386,6 +7980,12 @@ This gets the basic information from the filings and doesn't include anything ex * Mark the existing notice object at this URL as deleted. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns this notice. @@ -7406,6 +8006,12 @@ This gets the basic information from the filings and doesn't include anything ex * * This API is available by invitation only. * Get the file attachment identified by this URL. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company for this attachment. @@ -7427,6 +8033,12 @@ This gets the basic information from the filings and doesn't include anything ex * Get the tax notice object identified by this URL. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company for this notice. @@ -7448,6 +8060,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The ID of the notice. @@ -7470,6 +8088,12 @@ This gets the basic information from the filings and doesn't include anything ex * as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The ID of the company that owns these notices. @@ -7491,6 +8115,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice responsibilities' are are those who are responsible for the notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The ID of the notice. @@ -7512,6 +8142,12 @@ This gets the basic information from the filings and doesn't include anything ex * 'Notice root causes' are are those who are responsible for the notice. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int id The ID of the notice. @@ -7536,6 +8172,12 @@ This gets the basic information from the filings and doesn't include anything ex * * 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 Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that owns these notices. @@ -7564,15 +8206,21 @@ This gets the basic information from the filings and doesn't include anything ex * Retrieve all notices. * * This API is available by invitation only. - * + * * This API is deprecated - please use POST `/api/v2/notices/query` API. - * + * * Get multiple notice objects across all companies. * A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. * * 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 Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param string 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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause @@ -7600,9 +8248,15 @@ This gets the basic information from the filings and doesn't include anything ex * Retrieve all notices. * * This API is available by invitation only. - * + * * This API is intended to replace the GET `/api/v2/notices` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters. * The documentation of the GET API shows how filtering, sorting and pagination works. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param object model Query object to filter, sort and paginate the filing calendars. @@ -7622,6 +8276,12 @@ This gets the basic information from the filings and doesn't include anything ex * This API is available by invitation only. * 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, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that this notice finance detail belongs to. @@ -7647,6 +8307,12 @@ This gets the basic information from the filings and doesn't include anything ex * Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities. * 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, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that this notice belongs to. @@ -7668,6 +8334,12 @@ This gets the basic information from the filings and doesn't include anything ex * This API is available by invitation only. * 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, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company that this notice comment belongs to. @@ -7688,11 +8360,18 @@ This gets the basic information from the filings and doesn't include anything ex * Retrieve a single attachment * * This API is available by invitation only. - * Get the file attachment identified by this URL. + * + * Uploads a file attachment for a tax notice. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param int companyId The ID of the company for this attachment. - * @param object model The ResourceFileId of the attachment to download. + * @param object model The upload request. * @return object */ uploadAttachment({ companyId, model } = {}) { @@ -7707,17 +8386,21 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param int id The id of the notification you wish to mark as dismissed. @@ -7735,13 +8418,17 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int id The id of the notification to retrieve. @@ -7759,16 +8446,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param string 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/). @@ -7807,6 +8498,12 @@ This gets the basic information from the filings and doesn't include anything ex * 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. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Onboarding] for your servers. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount]. * * * @param object model Information about the account you wish to create and the selected product offerings. @@ -7825,6 +8522,12 @@ This gets the basic information from the filings and doesn't include anything ex * * This API is for use by partner onboarding 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. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Onboarding] for your servers. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount]. * * * @param int id The avatax account id of the customer @@ -7847,6 +8550,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param object model The account you wish to create. @@ -7864,15 +8571,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. - * + * * 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]. * * * @param object[] model The notifications you wish to create. @@ -7889,12 +8601,15 @@ This gets the basic information from the filings and doesn't include anything ex /** * Create a new subscription * - * # For Registrar Use Only - * This API is for use by Avalara Registrar administrative users only. - * + * 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. * * * @param int accountId The ID of the account that owns this subscription. @@ -7917,6 +8632,10 @@ This gets the basic information from the filings and doesn't include anything ex * * Delete an account. * Deleting an account will delete all companies and all account level users attached to this account. + * + * ### Security Policies + * + * * This API requires the user role SystemAdmin. * * * @param int id The ID of the account you wish to delete. @@ -7934,15 +8653,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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]. * * * @param int id The id of the notification you wish to delete. @@ -7961,8 +8685,12 @@ This gets the basic information from the filings and doesn't include anything ex * * # 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. * * * @param int accountId The ID of the account that owns this subscription. @@ -7986,6 +8714,11 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int userId The unique ID of the user whose password will be changed @@ -8010,6 +8743,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int id The ID of the account you wish to update. @@ -8028,15 +8765,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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]. * * * @param int id The id of the notification you wish to update. @@ -8056,12 +8798,16 @@ This gets the basic information from the filings and doesn't include anything ex * * # 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. + * 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. * * * @param int accountId The ID of the account that this subscription belongs to. @@ -8081,19 +8827,23 @@ This gets the basic information from the filings and doesn't include anything ex * 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. - * + * * This API works for all report types. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * * @param int id The unique ID number of this report @@ -8110,14 +8860,18 @@ This gets the basic information from the filings and doesn't include anything ex /** * Intiate and download an ExportDocumentLine report * - * This API is deprecated. - * + * This API is deprecated. + * * Please use the asynchronous reports APIs: - * + * * * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * * @param int companyId The unique ID number of the company to report on. @@ -8136,15 +8890,15 @@ This gets the basic information from the filings and doesn't include anything ex * 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. - * + * * This API call returns information about any report type. * * @@ -8163,16 +8917,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * * @param int companyId The unique ID number of the company to report on. @@ -8191,16 +8949,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @return FetchResult @@ -8226,6 +8988,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * * @param int companyId The ID of the company that owns this setting. @@ -8253,6 +9019,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this setting. @@ -8280,6 +9050,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this setting @@ -8310,6 +9084,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns these settings @@ -8350,6 +9128,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param string 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/). @@ -8390,6 +9172,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that this setting belongs to. @@ -8411,6 +9197,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that owns this subscription @@ -8431,9 +9221,13 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The ID of the account that owns these subscriptions @@ -8462,9 +9256,13 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param string 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 @@ -8494,6 +9292,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this tax code. @@ -8512,6 +9314,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this tax code. @@ -8534,6 +9340,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this tax code @@ -8559,6 +9369,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns these tax codes @@ -8594,6 +9408,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param string 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/). @@ -8627,6 +9445,10 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that this tax code belongs to. @@ -8668,6 +9490,11 @@ This gets the basic information from the filings and doesn't include anything ex * 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, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * This API depends on the following active services
*Required* (all): AvaTaxPro. * * * @param object model Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include. @@ -8707,6 +9534,11 @@ This gets the basic information from the filings and doesn't include anything ex * 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, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * This API depends on the following active services
*Required* (all): AvaTaxPro. * * * @param int companyId The ID number of the company that owns this location. @@ -8730,30 +9562,6 @@ This gets the basic information from the filings and doesn't include anything ex return this.restCall({ url: path, verb: 'get', payload: null }); } - /** - * Retrieve send-sale tax content for this company. - * - * This API is available by invitation only. - * - * - * @param string date The date for which we are fetching tax content. - * @param string taxCode The tax code for which we are fetching tax content. - * @param int companyId The unique ID number of the company which is fetching tax content. - * @param string format Requests a specific data format for this content file. (See SendSalesOutputFileFormat::* for a list of allowable values) - * @param string type Requests a specific encoding for this content file. (See SendSalesFileType::* for a list of allowable values) - * @return object - */ - downloadSendSalesRateFile({ date, taxCode, companyId, format, type } = {}) { - var path = this.buildUrl({ - url: `/api/v2/sendsalescontent/download/${companyId}/${taxCode}/${date}`, - parameters: { - format: format, - type: type - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - /** * Download a file listing tax rates by postal code * @@ -8797,6 +9605,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * * @param string date The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31 @@ -8813,50 +9625,6 @@ This gets the basic information from the filings and doesn't include anything ex return this.restCall({ url: path, verb: 'get', payload: null }); } - /** - * Export the tax profile of this company to a backup file - * - * Exports the tax profile of a company to a file, containing all information that affects tax calculation for this company. - * - * A tax profile is a series of decisions and configuration choices that affect your company's tax calculation. These decisions - * include your nexus declarations, your item catalog, your custom tax rules, and so on. - * - * This API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this - * profile to a different company or compare it over time to see if your profile has been changed. - * - * - * @param int companyId The unique ID number of the company whose profile you wish to retrieve. - * @return object - */ - exportTaxProfile({ companyId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxprofile`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Import a tax profile. - * - * Imports a tax profile to a new company, along with the option to import account settings. - * - * - * @param int accountId The account id of the account to which the tax profile will be imported. - * @param string newCompanyCode The companyCode to use for the imported company. - * @param boolean replaceAccountSettings Replace the current account settings with the ones in the tax profile. - * @param boolean bypassNexusValidation Enable invalid nexus to be imported. - * @param object taxProfile The taxProfile - * @return object - */ - importTaxProfile({ accountId, newCompanyCode, replaceAccountSettings, bypassNexusValidation, taxProfile } = {}) { - var path = this.buildUrl({ - url: `/api/v2/taxprofile`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - /** * Create a new tax rule * @@ -8873,6 +9641,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns this tax rule. @@ -8903,6 +9675,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns this tax rule. @@ -8933,6 +9709,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns this tax rule @@ -8966,6 +9746,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns these tax rules @@ -9009,6 +9793,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param string 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, rateTypeCode, taxTypeGroup, taxSubType @@ -9048,6 +9836,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that this tax rule belongs to. @@ -9071,21 +9863,26 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * 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. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9106,29 +9903,46 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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. + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to adjust * @param string documentType (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values) + * @param string include Specifies objects to include in this fetch call * @param object model The adjustment you wish to make * @return object */ - adjustTransaction({ companyCode, transactionCode, documentType, model } = {}) { + adjustTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/adjust`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9139,19 +9953,24 @@ This gets the basic information from the filings and doesn't include anything ex * * Retrieve audit information about a transaction stored in AvaTax. * - * The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit + * 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). + * + * ### 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. * * * @param string companyCode The code identifying the company that owns this transaction @@ -9171,19 +9990,24 @@ This gets the basic information from the filings and doesn't include anything ex * * Retrieve audit information about a transaction stored in AvaTax. * - * The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit + * 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). + * + * ### 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. * * * @param string companyCode The code identifying the company that owns this transaction @@ -9203,12 +10027,17 @@ This gets the basic information from the filings and doesn't include anything ex * 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 depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers. * * * @param object model bulk lock request @@ -9226,29 +10055,46 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### 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, AvaTaxST. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to change * @param string 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) + * @param string include Specifies objects to include in this fetch call * @param object model The code change request you wish to execute * @return object */ - changeTransactionCode({ companyCode, transactionCode, documentType, model } = {}) { + changeTransactionCode({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/changecode`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9258,28 +10104,44 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to commit * @param string 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) + * @param string include Specifies objects to include in this fetch call * @param object model The commit request you wish to execute * @return object */ - commitTransaction({ companyCode, transactionCode, documentType, model } = {}) { + commitTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/commit`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9289,20 +10151,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * 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 `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: @@ -9316,6 +10178,11 @@ This gets the basic information from the filings and doesn't include anything ex * * 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`. + * + * ### 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. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9336,28 +10203,28 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -9368,8 +10235,13 @@ This gets the basic information from the filings and doesn't include anything ex * * 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`. + * + * ### 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. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9397,15 +10269,20 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9426,15 +10303,15 @@ This gets the basic information from the filings and doesn't include anything ex * 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`. - * + * + * 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 + * 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 @@ -9443,6 +10320,11 @@ This gets the basic information from the filings and doesn't include anything ex * * Addresses * * SummaryOnly (omit lines and details - reduces API response size) * * LinesOnly (omit details - reduces API response size) + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9466,6 +10348,11 @@ This gets the basic information from the filings and doesn't include anything ex * Retrieve a single transaction by code * * DEPRECATED: Please use the `GetTransactionByCode` API instead. + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9488,13 +10375,13 @@ This gets the basic information from the filings and doesn't include anything ex * 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 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 @@ -9504,6 +10391,11 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int id The unique ID number of the transaction to retrieve @@ -9524,18 +10416,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -9544,6 +10436,11 @@ This gets the basic information from the filings and doesn't include anything ex * * Addresses * * SummaryOnly (omit lines and details - reduces API response size) * * LinesOnly (omit details - reduces API response size) + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9573,30 +10470,47 @@ This gets the basic information from the filings and doesn't include anything ex /** * Lock a single transaction * - * Lock a transaction uniquely identified by this URL. - * + * Lock a transaction uniquely identified by this URL. + * * This API is mainly used for connector developer to simulate what happens when 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. + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to lock * @param string 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) + * @param string include Specifies objects to include in this fetch call * @param object model The lock request you wish to execute * @return object */ - lockTransaction({ companyCode, transactionCode, documentType, model } = {}) { + lockTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/lock`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9606,26 +10520,26 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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 @@ -9634,8 +10548,13 @@ This gets the basic information from the filings and doesn't include anything ex * * 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`. + * + * ### 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. * * * @param string companyCode The code of the company that made the original sale @@ -9662,28 +10581,44 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to settle * @param string 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) + * @param string include Specifies objects to include in this fetch call * @param object model The data from an external system to reconcile against AvaTax * @return object */ - settleTransaction({ companyCode, transactionCode, documentType, model } = {}) { + settleTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/settle`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9693,21 +10628,38 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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. + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to commit * @param string 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) + * @param string include Specifies objects to include in this fetch call * @return object */ - uncommitTransaction({ companyCode, transactionCode, documentType } = {}) { + uncommitTransaction({ companyCode, transactionCode, documentType, include } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/uncommit`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: null }); @@ -9717,26 +10669,43 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to settle * @param string 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) + * @param string include Specifies objects to include in this fetch call * @param object model The data from an external system to reconcile against AvaTax * @return object */ - verifyTransaction({ companyCode, transactionCode, documentType, model } = {}) { + verifyTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/verify`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9746,28 +10715,45 @@ This gets the basic information from the filings and doesn't include anything ex * 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. + * + * ### 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. * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to void * @param string 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) + * @param string include Specifies objects to include in this fetch call * @param object model The void request you wish to execute. To void a transaction the code must be set to 'DocVoided' * @return object */ - voidTransaction({ companyCode, transactionCode, documentType, model } = {}) { + voidTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { var path = this.buildUrl({ url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/void`, parameters: { - documentType: documentType + documentType: documentType, + $include: include } }); return this.restCall({ url: path, verb: 'post', payload: model }); @@ -9778,6 +10764,11 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns this UPC. @@ -9796,6 +10787,11 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int companyId The ID of the company that owns this UPC. @@ -9815,6 +10811,11 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns this UPC @@ -9834,9 +10835,14 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int companyId The ID of the company that owns these UPCs @@ -9866,9 +10872,14 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param string 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/). @@ -9897,8 +10908,13 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. + * 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. * * * @param int companyId The ID of the company that this UPC belongs to. @@ -9924,6 +10940,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param object model An object containing your current password and the new password. @@ -9941,14 +10961,18 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int accountId The unique ID number of the account where these users will be created. @@ -9967,11 +10991,15 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param int id The ID of the user you wish to delete. @@ -9991,6 +11019,14 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int id The ID of the user to retrieve. @@ -10012,13 +11048,13 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * 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 + * * 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 @@ -10026,6 +11062,10 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. * * * @param int id The ID of the user to retrieve. @@ -10040,39 +11080,25 @@ This gets the basic information from the filings and doesn't include anything ex return this.restCall({ url: path, verb: 'get', payload: null }); } - /** - * Get information about a username. - * - * You may call this API prior to creating a user, to check if a particular username is available for use. Using this API, you can - * present a friendly experience prior to attempting to create a new user object. - * - * Please ensure that the query string is url encoded if you wish to check information for a user that contains url-sensitive characters. - * - * - * @param string username The username to search. - * @return object - */ - getUsername({ username } = {}) { - var path = this.buildUrl({ - url: `/api/v2/usernames`, - parameters: { - username: username - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - /** * 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. * * * @param int accountId The accountID of the user you wish to list. @@ -10101,15 +11127,23 @@ This gets the basic information from the filings and doesn't include anything ex * 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. * * * @param string include Optional fetch commands. @@ -10138,8 +11172,12 @@ This gets the basic information from the filings and doesn't include anything ex * * 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. + * 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. * * * @param int id The ID of the user you wish to update. @@ -10159,9 +11197,9 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -10183,9 +11221,9 @@ This gets the basic information from the filings and doesn't include anything ex * 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 @@ -10206,21 +11244,25 @@ This gets the basic information from the filings and doesn't include anything ex * 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 + * + * 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. * * * @return object diff --git a/package.json b/package.json index 4cbfbd48..2576332a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "avatax", - "version": "19.3.0", + "version": "19.4.0", "description": "AvaTax v2 SDK for languages using JavaScript", "main": "index.js", "homepage": "https://github.com/avadev/AvaTax-REST-V2-JS-SDK", From 2d65563937de0906b00a006b62bdca3e31c2f1b9 Mon Sep 17 00:00:00 2001 From: Genevieve Conty Date: Tue, 16 Apr 2019 15:54:34 -0700 Subject: [PATCH 2/2] 19.4.0 update: put pack in contentType fix --- lib/AvaTaxClient.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/AvaTaxClient.js b/lib/AvaTaxClient.js index 9eb8a8c8..e21a3225 100644 --- a/lib/AvaTaxClient.js +++ b/lib/AvaTaxClient.js @@ -84,7 +84,9 @@ export default class AvaTaxClient { }, body: JSON.stringify(payload) }).then(res => { - if (res.headers._headers['content-type'][0] === 'application/vnd.ms-excel') { + var contentType = res.headers._headers['content-type'] ? res.headers._headers['content-type'][0] : ''; + + if (contentType === 'application/vnd.ms-excel' || /te[xs]t\/csv/.test(contentType)) { return res; } return res.json();