diff --git a/lib/AvaTaxClient.js b/lib/AvaTaxClient.js index 670ed320..80e9c8b7 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 20.9.0 + * @version 20.12.1 * @link https://github.com/avadev/AvaTax-REST-V2-JS-SDK */ @@ -42,7 +42,7 @@ export default class AvaTaxClient { appName + '; ' + appVersion + - '; JavascriptSdk; 20.9.0; ' + + '; JavascriptSdk; 20.12.1; ' + machineName; } @@ -479,7 +479,7 @@ export default class AvaTaxClient { * This is the same API as the POST /api/v2/addresses/resolve endpoint. * Both verbs are supported to provide for flexible implementation. * - * Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs: + * In order to get any evaluation for an address, please provide at least one of the following fields/pairs: * 1. postal code * 2. line1 + city + region * 3. line1 + postal code @@ -487,7 +487,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AutoAddress. * * * @param string line1 Line 1 @@ -530,7 +530,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AutoAddress. * * * @param object model The address to resolve @@ -664,7 +664,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires the user role Compliance Root User. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param object[] model The AvaFileForm you wish to create. @@ -686,7 +686,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int id The ID of the AvaFileForm you wish to delete. @@ -708,7 +708,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int id The primary key of this AvaFileForm @@ -731,7 +731,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @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 @@ -762,7 +762,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires the user role Compliance Root User. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int id The ID of the AvaFileForm you wish to update @@ -1092,15 +1092,15 @@ export default class AvaTaxClient { * Using CertExpress with this API will ensure that your certificates are automatically linked correctly into * your company so that they can be used for tax exemptions. * - * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1130,15 +1130,15 @@ export default class AvaTaxClient { * Using CertExpress with this API will ensure that your certificates are automatically linked correctly into * your company so that they can be used for tax exemptions. * - * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1171,15 +1171,15 @@ export default class AvaTaxClient { * Using CertExpress with this API will ensure that your certificates are automatically linked correctly into * your company so that they can be used for tax exemptions. * - * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1222,17 +1222,17 @@ export default class AvaTaxClient { * * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * If the users specified in the certificates do not exist, the API will create the user and link them to the certificate * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The ID number of the company recording this certificate @@ -1262,15 +1262,15 @@ export default class AvaTaxClient { * * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1298,15 +1298,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1342,15 +1342,15 @@ export default class AvaTaxClient { * * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The ID number of the company that recorded this certificate @@ -1382,7 +1382,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The company ID to check @@ -1409,15 +1409,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1447,15 +1447,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1484,15 +1484,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1520,15 +1520,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1562,15 +1562,15 @@ export default class AvaTaxClient { * * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The ID number of the company to search @@ -1611,7 +1611,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId @@ -1638,15 +1638,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1677,15 +1677,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1711,15 +1711,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The ID number of the company that recorded this certificate @@ -1748,15 +1748,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -1954,7 +1954,7 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * @@ -2029,7 +2029,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int companyId The unique identifier of the company @@ -2054,7 +2054,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int companyId The unique identifier of the company @@ -2249,7 +2249,7 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * @@ -2313,7 +2313,7 @@ export default class AvaTaxClient { * * * @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters + * @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers * @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`. @@ -2623,15 +2623,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -2657,15 +2657,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -2697,15 +2697,15 @@ export default class AvaTaxClient { * * CustomFields - Fetch a list of custom fields associated to this customer. * * attributes - Retrieves all attributes applied to the 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -2737,15 +2737,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The unique ID number of the company that recorded the provided customer @@ -2772,15 +2772,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -2816,7 +2816,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The unique ID number of the company defining customers. @@ -2846,15 +2846,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The unique ID number of the company that recorded the provided customer @@ -2880,15 +2880,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -2928,15 +2928,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -2969,15 +2969,15 @@ export default class AvaTaxClient { * * Certificates - Fetch a list of certificates linked to this customer. * * attributes - Retrieves all attributes applied to the 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -3016,15 +3016,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The unique ID number of the company that recorded the customer @@ -3051,15 +3051,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -3086,15 +3086,15 @@ export default class AvaTaxClient { * 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 - * storage for this company, call `RequestCertificateSetup`. + * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * 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 @@ -3118,7 +3118,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param int companyId The id of the company you which to create the datasources @@ -3141,7 +3141,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param int companyId The id of the company the datasource belongs to. @@ -3164,7 +3164,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param int companyId @@ -3187,7 +3187,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param int companyId The id of the company you wish to retrieve the datasources. @@ -3221,7 +3221,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @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, name, externalState @@ -3251,7 +3251,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param int companyId The id of the company the datasource belongs to. @@ -3283,7 +3283,7 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API depends on the following active services
*Required* (all): AvaTaxGlobal. + * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. * * * @param string country The name or code of the destination country. @@ -3601,7 +3601,7 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API depends on the following active services
*Required* (all): AvaTaxGlobal. + * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. * * * @param string country The name or code of the destination country. @@ -3637,7 +3637,7 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API depends on the following active services
*Required* (all): AvaTaxGlobal. + * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. * * * @return FetchResult @@ -5152,7 +5152,7 @@ export default class AvaTaxClient { * * @param int companyId The company ID that will be issued this certificate. * @param object model - * @return FetchResult + * @return object */ createECommerceToken({ companyId, model } = {}) { var path = this.buildUrl({ @@ -5186,6 +5186,30 @@ export default class AvaTaxClient { return this.restCall({ url: path, verb: 'put', payload: model }); } + /** + * Add or Edit options + * + * Returns a list of options for adding tax forms for the company and tax form code specified. + * Returns edit options when modifying a filing calendar. + * This API is available by invitation only. + * + * ### Security Policies + * + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * + * + * @param int companyId The unique ID of the company that owns the filing calendar object + * @param object model Cycle Safe Options Request + * @return object + */ + cycleSafeOptions({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/filingcalendars/edit/cycleSafeOptions`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + /** * Delete a company return setting * @@ -5235,8 +5259,8 @@ export default class AvaTaxClient { * ### 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 is available by invitation only.
*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int companyId The ID of the company that owns these batches @@ -5618,7 +5642,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int id The unique ID number of this funding request @@ -5649,7 +5673,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param int id The unique ID number of this funding request @@ -6684,7 +6708,7 @@ export default class AvaTaxClient { * * * @param int companyId The ID of the company that owns these locations - * @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, parameters + * @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:* isMarketplaceOutsideUsa, settings, parameters * @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. @@ -6727,7 +6751,7 @@ export default class AvaTaxClient { * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, 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, parameters + * @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:* isMarketplaceOutsideUsa, settings, parameters * @param string include A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings. * @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. @@ -6852,7 +6876,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param string code The transaction code for this MultiDocument transaction @@ -6900,7 +6924,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param string code The transaction code for this MultiDocument transaction @@ -6938,7 +6962,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param object model The commit request you wish to execute @@ -6999,7 +7023,7 @@ export default class AvaTaxClient { * ### 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. + * * 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 @@ -7043,11 +7067,11 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * - * @param string code - * @param string type (See DocumentType::* for a list of allowable values) + * @param string code The multidocument code to retrieve + * @param string type The transaction type to retrieve (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in the response after transaction is created * @return object */ @@ -7097,7 +7121,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int id The unique ID number of the MultiDocument transaction to retrieve @@ -7148,7 +7172,7 @@ export default class AvaTaxClient { * ### 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. + * * 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 @@ -7223,7 +7247,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param string code The code of this MultiDocument transaction @@ -7263,7 +7287,7 @@ export default class AvaTaxClient { * ### 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. + * * 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 @@ -7301,7 +7325,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param string code The transaction code for this MultiDocument transaction @@ -8898,7 +8922,7 @@ export default class AvaTaxClient { * ### 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. + * * 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. @@ -8942,7 +8966,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaTaxPro. * * * @param int companyId The ID number of the company that owns this location. @@ -9286,7 +9310,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9339,7 +9363,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9390,7 +9414,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The code identifying the company that owns this transaction @@ -9435,7 +9459,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The code identifying the company that owns this transaction @@ -9465,7 +9489,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires the user role Compliance Root User. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param object model bulk lock request @@ -9515,7 +9539,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9631,7 +9655,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9695,7 +9719,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9736,7 +9760,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string include Specifies objects to include in the response after transaction is created @@ -9786,7 +9810,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9822,7 +9846,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -9865,7 +9889,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param int id The unique ID number of the transaction to retrieve @@ -9918,13 +9942,13 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction * @param int dataSourceId Optionally filter transactions to those from a specific data source. * @param string include Specifies objects to include in this fetch call - * @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:* totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction + * @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction * @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`. @@ -9950,7 +9974,7 @@ export default class AvaTaxClient { * * 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. + * This API is mainly used for connector developers to simulate what happens when the Returns product locks a document. * After this API call succeeds, the document will be locked and can't be voided or adjusted. * * This API is only available to customers in Sandbox with AvaTaxPro subscription. On production servers, this API is available by invitation only. @@ -9981,7 +10005,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. + * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. * * * @param string companyCode The company code of the company that recorded this transaction @@ -10048,7 +10072,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The code of the company that made the original sale @@ -10155,7 +10179,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -10201,7 +10225,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -10254,7 +10278,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -10310,7 +10334,7 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. * * * @param string companyCode The company code of the company that recorded this transaction @@ -10340,7 +10364,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaUpc. * * * @param int companyId The ID of the company that owns this UPC. @@ -10363,7 +10387,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaUpc. * * * @param int companyId The ID of the company that owns this UPC. @@ -10387,7 +10411,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaUpc. * * * @param int companyId The ID of the company that owns this UPC @@ -10414,7 +10438,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaUpc. * * * @param int companyId The ID of the company that owns these UPCs @@ -10451,7 +10475,7 @@ export default class AvaTaxClient { * ### 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. + * * 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/). @@ -10486,7 +10510,7 @@ export default class AvaTaxClient { * ### 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. + * * This API depends on the following active services:*Required* (all): AvaUpc. * * * @param int companyId The ID of the company that this UPC belongs to. diff --git a/package.json b/package.json index 541efb55..bad485c4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "avatax", - "version": "20.9.0", + "version": "20.12.1", "description": "AvaTax v2 SDK for languages using JavaScript", "main": "index.js", "homepage": "https://github.com/avadev/AvaTax-REST-V2-JS-SDK",