diff --git a/lib/AvaTaxClient.js b/lib/AvaTaxClient.js index d3b41ea0..58e2711e 100644 --- a/lib/AvaTaxClient.js +++ b/lib/AvaTaxClient.js @@ -1,135 +1,134 @@ -/* - * AvaTax Software Development Kit for JavaScript - * - * (c) 2004-2018 Avalara, Inc. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - * - * @author Justin Soliz - * @author Ted Spence - * @copyright 2004-2018 Avalara, Inc. - * @license https://www.apache.org/licenses/LICENSE-2.0 - * @version 20.5.0 - * @link https://github.com/avadev/AvaTax-REST-V2-JS-SDK - */ - -import fetch from 'isomorphic-fetch'; -import { createBasicAuthHeader } from './utils/basic_auth'; -import { withTimeout } from './utils/withTimeout'; - -export default class AvaTaxClient { - /** - * Construct a new AvaTaxClient - * - * @constructor - * @param string appName Specify the name of your application here. Should not contain any semicolons. - * @param string appVersion Specify the version number of your application here. Should not contain any semicolons. - * @param string machineName Specify the machine name of the machine on which this code is executing here. Should not contain any semicolons. - * @param string environment Indicates which server to use; acceptable values are "sandbox" or "production", or the full URL of your AvaTax instance. - */ - constructor({ appName, appVersion, machineName, environment }) { - this.baseUrl = 'https://rest.avatax.com'; - if (environment == 'sandbox') { - this.baseUrl = 'https://sandbox-rest.avatax.com'; - } else if ( - environment.substring(0, 8) == 'https://' || - environment.substring(0, 7) == 'http://' - ) { - this.baseUrl = environment; - } - this.clientId = - appName + - '; ' + - appVersion + - '; JavascriptSdk; 20.5.0; ' + - machineName; - } - - /** - * Configure this client to use the specified username/password security settings - * - * @param string username The username for your AvaTax user account - * @param string password The password for your AvaTax user account - * @param int accountId The account ID of your avatax account - * @param string licenseKey The license key of your avatax account - * @param string bearerToken The OAuth 2.0 token provided by Avalara Identity - * @return AvaTaxClient - */ - withSecurity({ username, password, accountId, licenseKey, bearerToken }) { - if (username != null && password != null) { - this.auth = createBasicAuthHeader(username, password); - } else if (accountId != null && licenseKey != null) { - this.auth = createBasicAuthHeader(accountId, licenseKey); - } else if (bearerToken != null) { - this.auth = 'Bearer ' + bearerToken; - } - return this; - } - - /** - * Make a single REST call to the AvaTax v2 API server - * - * @param string url The relative path of the API on the server - * @param string verb The HTTP verb being used in this request - * @param string payload The request body, if this is being sent to a POST/PUT API call - */ - restCall({ url, verb, payload }) { - return withTimeout(1200000, fetch(url, { - method: verb, - headers: { - Accept: 'application/json', - 'Content-Type': 'application/json', - Authorization: this.auth, - 'X-Avalara-Client': this.clientId - }, - body: JSON.stringify(payload) - })).then(res => { - var contentType = res.headers._headers['content-type'][0]; - - if (contentType === 'application/vnd.ms-excel' || contentType === 'text/csv') { - return res; - } - return res.json(); - }).then(json => { - // handle error - if (json.error) { - let ex = new Error(json.error.message); - ex.code = json.error.code; - ex.target = json.error.target; - ex.details = json.error.details; - throw ex; - } else { - return json; - } - }) - } - - /** - * Construct a URL with query string parameters - * - * @param string url The root URL of the API being called - * @param string parameters A list of name-value pairs in a javascript object to create as query string parameters - */ - buildUrl({ url, parameters }) { - var qs = ''; - for (var key in parameters) { - var value = parameters[key]; - if (value) { - qs += encodeURIComponent(key) + '=' + encodeURIComponent(value) + '&'; - } - } - if (qs.length > 0) { - qs = qs.substring(0, qs.length - 1); //chop off last "&" - url = url + '?' + qs; - } - return this.baseUrl + url; - } - - - /** - * Reset this account's license key - * +/* + * AvaTax Software Development Kit for JavaScript + * + * (c) 2004-2018 Avalara, Inc. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + * + * @author Justin Soliz + * @author Ted Spence + * @copyright 2004-2018 Avalara, Inc. + * @license https://www.apache.org/licenses/LICENSE-2.0 + * @version 20.6.0 + * @link https://github.com/avadev/AvaTax-REST-V2-JS-SDK + */ + +import fetch from 'isomorphic-fetch'; +import { createBasicAuthHeader } from './utils/basic_auth'; + +export default class AvaTaxClient { + /** + * Construct a new AvaTaxClient + * + * @constructor + * @param string appName Specify the name of your application here. Should not contain any semicolons. + * @param string appVersion Specify the version number of your application here. Should not contain any semicolons. + * @param string machineName Specify the machine name of the machine on which this code is executing here. Should not contain any semicolons. + * @param string environment Indicates which server to use; acceptable values are "sandbox" or "production", or the full URL of your AvaTax instance. + */ + constructor({ appName, appVersion, machineName, environment }) { + this.baseUrl = 'https://rest.avatax.com'; + if (environment == 'sandbox') { + this.baseUrl = 'https://sandbox-rest.avatax.com'; + } else if ( + environment.substring(0, 8) == 'https://' || + environment.substring(0, 7) == 'http://' + ) { + this.baseUrl = environment; + } + this.clientId = + appName + + '; ' + + appVersion + + '; JavascriptSdk; 20.6.0; ' + + machineName; + } + + /** + * Configure this client to use the specified username/password security settings + * + * @param string username The username for your AvaTax user account + * @param string password The password for your AvaTax user account + * @param int accountId The account ID of your avatax account + * @param string licenseKey The license key of your avatax account + * @param string bearerToken The OAuth 2.0 token provided by Avalara Identity + * @return AvaTaxClient + */ + withSecurity({ username, password, accountId, licenseKey, bearerToken }) { + if (username != null && password != null) { + this.auth = createBasicAuthHeader(username, password); + } else if (accountId != null && licenseKey != null) { + this.auth = createBasicAuthHeader(accountId, licenseKey); + } else if (bearerToken != null) { + this.auth = 'Bearer ' + bearerToken; + } + return this; + } + + /** + * Make a single REST call to the AvaTax v2 API server + * + * @param string url The relative path of the API on the server + * @param string verb The HTTP verb being used in this request + * @param string payload The request body, if this is being sent to a POST/PUT API call + */ + restCall({ url, verb, payload }) { + return fetch(url, { + method: verb, + headers: { + Accept: 'application/json', + 'Content-Type': 'application/json', + Authorization: this.auth, + 'X-Avalara-Client': this.clientId + }, + body: JSON.stringify(payload) + }).then(res => { + var contentType = res.headers._headers['content-type'][0]; + + if (contentType === 'application/vnd.ms-excel' || contentType === 'text/csv') { + return res; + } + return res.json(); + }).then(json => { + // handle error + if (json.error) { + let ex = new Error(json.error.message); + ex.code = json.error.code; + ex.target = json.error.target; + ex.details = json.error.details; + throw ex; + } else { + return json; + } + }) + } + + /** + * Construct a URL with query string parameters + * + * @param string url The root URL of the API being called + * @param string parameters A list of name-value pairs in a javascript object to create as query string parameters + */ + buildUrl({ url, parameters }) { + var qs = ''; + for (var key in parameters) { + var value = parameters[key]; + if (value) { + qs += encodeURIComponent(key) + '=' + encodeURIComponent(value) + '&'; + } + } + if (qs.length > 0) { + qs = qs.substring(0, qs.length - 1); //chop off last "&" + url = url + '?' + qs; + } + return this.baseUrl + url; + } + + + /** + * Reset this account's license key + * * Resets the existing license key for this account to a new key. * * To reset your account, you must specify the ID of the account you wish to reset and confirm the action. @@ -147,24 +146,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int id The ID of the account you wish to update. - * @param object model A request confirming that you wish to reset the license key of this account. - * @return object - */ - accountResetLicenseKey({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/resetlicensekey`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Activate an account by accepting terms and conditions - * + * @param object model A request confirming that you wish to reset the license key of this account. + * @return object + */ + accountResetLicenseKey({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/resetlicensekey`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Activate an account by accepting terms and conditions + * * Activate the account specified by the unique accountId number. * * This activation request can only be called by account administrators. You must indicate @@ -178,24 +177,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int id The ID of the account to activate - * @param object model The activation request - * @return object - */ - activateAccount({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/activate`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Retrieve audit history for an account. - * + * @param object model The activation request + * @return object + */ + activateAccount({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/activate`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Retrieve audit history for an account. + * * Retrieve audit trace history for an account. * * Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate @@ -213,32 +212,32 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the account you wish to audit. * @param string start The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes. * @param string end The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time. * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @return FetchResult - */ - auditAccount({ id, start, end, top, skip } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/audit`, + * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return FetchResult + */ + auditAccount({ id, start, end, top, skip } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/audit`, parameters: { start: start, end: end, $top: top, $skip: skip } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create license key for this account - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create license key for this account + * * Creates a new license key for this account. * * To create a license key for your account, you must specify the ID of the account and license key name. @@ -252,24 +251,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int id The ID of the account you wish to update. - * @param object model - * @return object - */ - createLicenseKey({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/licensekey`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete license key for this account by license key name - * + * @param object model + * @return object + */ + createLicenseKey({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/licensekey`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete license key for this account by license key name + * * Deletes the license key for this account using license key name. * * To delete a license key for your account, you must specify the accountID of the account and license key name. @@ -278,24 +277,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int id The ID of the account you wish to update. - * @param string licensekeyname The license key name you wish to update. - * @return object[] - */ - deleteLicenseKey({ id, licensekeyname } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/licensekey/${licensekeyname}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single account - * + * @param string licensekeyname The license key name you wish to update. + * @return object[] + */ + deleteLicenseKey({ id, licensekeyname } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/licensekey/${licensekeyname}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single account + * * Get the account object identified by this URL. * You may use the '$include' parameter to fetch additional nested data: * @@ -304,26 +303,26 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the account to retrieve - * @param string include A comma separated list of special fetch options - * @return object - */ - getAccount({ id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}`, + * @param string include A comma separated list of special fetch options + * @return object + */ + getAccount({ id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get configuration settings for this account - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Get configuration settings for this account + * * Retrieve a list of all configuration settings tied to this account. * * Configuration settings provide you with the ability to control features of your account and of your @@ -339,64 +338,64 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * - * @param int id - * @return object[] - */ - getAccountConfiguration({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/configuration`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve license key by license key name - * + * @param int id + * @return object[] + */ + getAccountConfiguration({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/configuration`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve license key by license key name + * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the account to retrieve - * @param string licensekeyname The ID of the account to retrieve - * @return object - */ - getLicenseKey({ id, licensekeyname } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/licensekey/${licensekeyname}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all license keys for this account - * + * @param string licensekeyname The ID of the account to retrieve + * @return object + */ + getLicenseKey({ id, licensekeyname } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/licensekey/${licensekeyname}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all license keys for this account + * * Gets list of all the license keys used by the account. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * - * @param int id The ID of the account to retrieve - * @return object[] - */ - getLicenseKeys({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/licensekeys`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all accounts - * + * @param int id The ID of the account to retrieve + * @return object[] + */ + getLicenseKeys({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/licensekeys`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all accounts + * * List all account objects that can be seen by the current user. * * This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account. @@ -412,19 +411,19 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string include A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name. * @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:* subscriptions, users * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryAccounts({ include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryAccounts({ include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts`, parameters: { $include: include, $filter: filter, @@ -432,13 +431,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Change configuration settings for this account - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Change configuration settings for this account + * * Update configuration settings tied to this account. * * Configuration settings provide you with the ability to control features of your account and of your @@ -454,24 +453,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int id - * @param object[] model - * @return object[] - */ - setAccountConfiguration({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/configuration`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Retrieve geolocation information for a specified address - * + * @param object[] model + * @return object[] + */ + setAccountConfiguration({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/configuration`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Retrieve geolocation information for a specified address + * * Resolve an address against Avalara's address-validation system. If the address can be resolved, this API * provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used * to identify how closely this address can be located. If the address cannot be clearly located, use the @@ -487,8 +486,8 @@ 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 * @param string line2 Line 2 @@ -497,12 +496,12 @@ export default class AvaTaxClient { * @param string region State / Province / Region * @param string postalCode Postal Code / Zip Code * @param string country Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list) - * @param string textCase selectable text case for address validation (See TextCase::* for a list of allowable values) - * @return object - */ - resolveAddress({ line1, line2, line3, city, region, postalCode, country, textCase } = {}) { - var path = this.buildUrl({ - url: `/api/v2/addresses/resolve`, + * @param string textCase selectable text case for address validation (See TextCase::* for a list of allowable values) + * @return object + */ + resolveAddress({ line1, line2, line3, city, region, postalCode, country, textCase } = {}) { + var path = this.buildUrl({ + url: `/api/v2/addresses/resolve`, parameters: { line1: line1, line2: line2, @@ -513,13 +512,13 @@ export default class AvaTaxClient { country: country, textCase: textCase } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve geolocation information for a specified address - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve geolocation information for a specified address + * * Resolve an address against Avalara's address-validation system. If the address can be resolved, this API * provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used * to identify how closely this address can be located. If the address cannot be clearly located, use the @@ -530,237 +529,270 @@ 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. - * - * - * @param object model The address to resolve - * @return object - */ - resolveAddressPost({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/addresses/resolve`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a lookup file for a company - * - * - * + * * This API depends on the following active services
*Required* (all): AutoAddress. + * + * + * @param object model The address to resolve + * @return object + */ + resolveAddressPost({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/addresses/resolve`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a lookup file for a company + * + * + * * * @param int accountId The ID of the account for the company * @param int companyId The ID of the company for which the lookup file is to be created - * @param object model The lookup file you wish to create - * @return object - */ - createCompanyLookupFile({ accountId, companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/advancedrules/accounts/${accountId}/companies/${companyId}/lookupFiles`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a lookup file - * - * - * + * @param object model The lookup file you wish to create + * @return object + */ + createCompanyLookupFile({ accountId, companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/advancedrules/accounts/${accountId}/companies/${companyId}/lookupFiles`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a lookup file + * + * + * * * @param int accountId The ID of the account for the company the lookup file is for - * @param string id The unique ID/GUID for the company lookup file to be deleted - * @return object[] - */ - deleteLookupFile({ accountId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/advancedrules/accounts/${accountId}/lookupFiles/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Get the lookup files for a company - * - * - * + * @param string id The unique ID/GUID for the company lookup file to be deleted + * @return object[] + */ + deleteLookupFile({ accountId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/advancedrules/accounts/${accountId}/lookupFiles/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Get the lookup files for a company + * + * + * * * @param int accountId The account ID for the company - * @param int companyId The ID of the company for which to retrieve lookup files - * @return FetchResult - */ - getCompanyLookupFiles({ accountId, companyId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/advancedrules/accounts/${accountId}/companies/${companyId}/lookupFiles`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get a lookup file for an accountId and companyLookupFileId - * - * - * + * @param int companyId The ID of the company for which to retrieve lookup files + * @return FetchResult + */ + getCompanyLookupFiles({ accountId, companyId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/advancedrules/accounts/${accountId}/companies/${companyId}/lookupFiles`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Get a lookup file for an accountId and companyLookupFileId + * + * + * * * @param int accountId The ID of the account for the lookup file - * @param string id The unique ID/GUID of the company lookup file to return - * @return object - */ - getLookupFile({ accountId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/advancedrules/accounts/${accountId}/lookupFiles/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a lookup file - * - * - * + * @param string id The unique ID/GUID of the company lookup file to return + * @return object + */ + getLookupFile({ accountId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/advancedrules/accounts/${accountId}/lookupFiles/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a lookup file + * + * + * * * @param int accountId The ID of the account for the company the lookup file is for * @param string id The unique ID/GUID of the company lookup file to be updated - * @param object model The new values to update the lookup file - * @return object - */ - updateLookupFile({ accountId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/advancedrules/accounts/${accountId}/lookupFiles/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create a new AvaFileForm - * + * @param object model The new values to update the lookup file + * @return object + */ + updateLookupFile({ accountId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/advancedrules/accounts/${accountId}/lookupFiles/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create a new AvaFileForm + * * Create one or more AvaFileForms * A 'AvaFileForm' represents a form supported by our returns team * * ### Security Policies * * * This API requires the user role Compliance Root User. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - * - * - * @param object[] model The AvaFileForm you wish to create. - * @return object[] - */ - createAvaFileForms({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/avafileforms`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single AvaFileForm - * + * * 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. + * @return object[] + */ + createAvaFileForms({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/avafileforms`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single AvaFileForm + * * Marks the existing AvaFileForm object at this URL as deleted. * * ### Security Policies * * * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - * - * - * @param int id The ID of the AvaFileForm you wish to delete. - * @return object[] - */ - deleteAvaFileForm({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/avafileforms/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single AvaFileForm - * + * * 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. + * @return object[] + */ + deleteAvaFileForm({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/avafileforms/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single AvaFileForm + * * Get the AvaFileForm object identified by this URL. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - * - * - * @param int id The primary key of this AvaFileForm - * @return object - */ - getAvaFileForm({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/avafileforms/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all AvaFileForms - * + * * 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 + * @return object + */ + getAvaFileForm({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/avafileforms/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all AvaFileForms + * * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . * Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - * + * * 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 * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryAvaFileForms({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/avafileforms`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryAvaFileForms({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/avafileforms`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a AvaFileForm - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a AvaFileForm + * * All data from the existing object will be replaced with data in the object you PUT. * To set a field's value to null, you may either set its value to null or omit that field from the object you post. * * ### Security Policies * * * This API requires the user role Compliance Root User. - * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - * + * * 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 - * @param object model The AvaFileForm model you wish to update. - * @return object - */ - updateAvaFileForm({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/avafileforms/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create a new batch - * + * @param object model The AvaFileForm model you wish to update. + * @return object + */ + updateAvaFileForm({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/avafileforms/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Cancel an in progress batch + * + * Marks the in progress batch identified by this URL as cancelled. + * + * Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message. + * + * Only in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message. + * Cancelling an in progress batch does not delete any transactions that were created before the cancellation. + * + * Because the batch system processes with a degree of concurrency, and + * because of batch sizes in the queue vary, AvaTax API is unable to accurately + * predict when a batch will complete. If high performance processing is + * required, please use the + * [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + * + * + * @param int companyId The ID of the company that owns this batch. + * @param int id The ID of the batch to cancel. + * @return object + */ + cancelBatch({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches/${id}/cancel`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Create a new batch + * * Create one or more new batch objects attached to this company. * * Each batch object may have one or more file objects (currently only one file is supported). @@ -783,24 +815,62 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + * + * + * @param int companyId The ID of the company that owns this batch. + * @param object[] model The batch you wish to create. + * @return object[] + */ + createBatches({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new transaction batch + * + * Create a new transaction batch objects attached to this company. + * + * When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be + * processed as quickly as possible in the order it was received. To check the + * status of a batch, fetch the batch and retrieve the results of the batch + * operation. + * + * Because the batch system processes with a degree of concurrency, and + * because of batch sizes in the queue vary, AvaTax API is unable to accurately + * predict when a batch will complete. If high performance processing is + * required, please use the + * [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). + * + * The maximum content length of the request body is limited to 28.6 MB. If this limit + * is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if + * the API is called from a browser). In this situation, please split the request into + * smaller batches. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this batch. - * @param object[] model The batch you wish to create. - * @return object[] - */ - createBatches({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/batches`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single batch - * + * @param object model The transaction batch you wish to create. + * @return object + */ + createTransactionBatch({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches/transactions`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single batch + * * Marks the batch identified by this URL as deleted. * * If you attempt to delete a batch that is being processed, you will receive an error message. @@ -814,47 +884,47 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this batch. - * @param int id The ID of the batch to delete. - * @return object[] - */ - deleteBatch({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/batches/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Download a single batch file - * + * @param int id The ID of the batch to delete. + * @return object[] + */ + deleteBatch({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Download a single batch file + * * Download a single batch file identified by this URL. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this batch * @param int batchId The ID of the batch object - * @param int id The primary key of this batch file object - * @return object - */ - downloadBatch({ companyId, batchId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/batches/${batchId}/files/${id}/attachment`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single batch - * + * @param int id The primary key of this batch file object + * @return object + */ + downloadBatch({ companyId, batchId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches/${batchId}/files/${id}/attachment`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single batch + * * Get the batch object identified by this URL. A batch object is a large * collection of API calls stored in a compact file. * @@ -873,24 +943,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this batch - * @param int id The primary key of this batch - * @return object - */ - getBatch({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/batches/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all batches for this company - * + * @param int id The primary key of this batch + * @return object + */ + getBatch({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all batches for this company + * * List all batch objects attached to the specified company. * * A batch object is a large collection of API calls stored in a compact file. @@ -915,20 +985,20 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns these batches * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listBatchesByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/batches`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listBatchesByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/batches`, parameters: { $filter: filter, $include: include, @@ -936,13 +1006,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all batches - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all batches + * * Get multiple batch objects across all companies. * * A batch object is a large collection of API calls stored in a compact file. @@ -964,19 +1034,19 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryBatches({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/batches`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryBatches({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/batches`, parameters: { $filter: filter, $include: include, @@ -984,13 +1054,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create a CertExpress invitation - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create a CertExpress invitation + * * Creates an invitation for a customer to self-report certificates using the CertExpress website. * * This invitation is delivered by your choice of method, or you can present a hyperlink to the user @@ -1010,25 +1080,25 @@ export default class AvaTaxClient { * ### 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 * @param string customerCode The number of the customer where the request is sent to - * @param object[] model the requests to send out to customers - * @return object[] - */ - createCertExpressInvitation({ companyId, customerCode, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/certexpressinvites`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Retrieve a single CertExpress invitation - * + * @param object[] model the requests to send out to customers + * @return object[] + */ + createCertExpressInvitation({ companyId, customerCode, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/certexpressinvites`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Retrieve a single CertExpress invitation + * * Retrieve an existing CertExpress invitation sent to a customer. * * A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information @@ -1048,28 +1118,28 @@ 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 that issued this invitation * @param string customerCode The number of the customer where the request is sent to * @param int id The unique ID number of this CertExpress invitation - * @param string include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. - * @return object - */ - getCertExpressInvitation({ companyId, customerCode, id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/certexpressinvites/${id}`, + * @param string include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. + * @return object + */ + getCertExpressInvitation({ companyId, customerCode, id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/certexpressinvites/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List CertExpress invitations - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List CertExpress invitations + * * Retrieve CertExpress invitations sent by this company. * * A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information @@ -1089,20 +1159,20 @@ 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 that issued this invitation * @param string include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. * @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCertExpressInvitations({ companyId, include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certexpressinvites`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCertExpressInvitations({ companyId, include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certexpressinvites`, parameters: { $include: include, $filter: filter, @@ -1110,13 +1180,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create certificates for this company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create certificates for this company + * * Record one or more certificates document for this company. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1142,27 +1212,27 @@ export default class AvaTaxClient { * ### 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 * @param boolean preValidatedExemptionReason If set to true, the certificate will bypass the human verification process. - * @param object[] model Certificates to be created - * @return object[] - */ - createCertificates({ companyId, preValidatedExemptionReason, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates`, + * @param object[] model Certificates to be created + * @return object[] + */ + createCertificates({ companyId, preValidatedExemptionReason, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates`, parameters: { $preValidatedExemptionReason: preValidatedExemptionReason } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Revoke and delete a certificate - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Revoke and delete a certificate + * * Revoke the certificate identified by this URL, then delete it. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1180,24 +1250,24 @@ export default class AvaTaxClient { * ### 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 - * @param int id The unique ID number of this certificate - * @return object[] - */ - deleteCertificate({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Download an image for this certificate - * + * @param int id The unique ID number of this certificate + * @return object[] + */ + deleteCertificate({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Download an image for this certificate + * * Download an image or PDF file for this certificate. * * This API can be used to download either a single-page preview of the certificate or a full PDF document. @@ -1216,29 +1286,29 @@ 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 that recorded this certificate * @param int id The unique ID number of this certificate * @param int page If you choose `$type`=`Jpeg`, you must specify which page number to retrieve. - * @param string type The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values) - * @return object - */ - downloadCertificateImage({ companyId, id, page, type } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/attachment`, + * @param string type The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values) + * @return object + */ + downloadCertificateImage({ companyId, id, page, type } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/attachment`, parameters: { $page: page, $type: type } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single certificate - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single certificate + * * Get the current certificate identified by this URL. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1260,27 +1330,27 @@ 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 ID number of the company that recorded this certificate * @param int id The unique ID number of this certificate - * @param string include OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. - * @return object - */ - getCertificate({ companyId, id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}`, + * @param string include OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. + * @return object + */ + getCertificate({ companyId, id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Check a company's exemption certificate status. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Check a company's exemption certificate status. + * * Checks whether this company is configured to use exemption certificates in AvaTax. * * Exemption certificates are tracked through a different auditable data store than the one that @@ -1292,23 +1362,23 @@ 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. - * - * - * @param int companyId The company ID to check - * @return object - */ - getCertificateSetup({ companyId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/setup`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Link attributes to a certificate - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * + * + * @param int companyId The company ID to check + * @return object + */ + getCertificateSetup({ companyId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/setup`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Link attributes to a certificate + * * Link one or many attributes to a certificate. * * A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -1327,25 +1397,25 @@ export default class AvaTaxClient { * ### 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 * @param int id The unique ID number of this certificate - * @param object[] model The list of attributes to link to this certificate. - * @return FetchResult - */ - linkAttributesToCertificate({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/attributes/link`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Link customers to a certificate - * + * @param object[] model The list of attributes to link to this certificate. + * @return FetchResult + */ + linkAttributesToCertificate({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/attributes/link`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Link customers to a certificate + * * Link one or more customers to an existing certificate. * * Customers and certificates must be linked before a customer can make use of a certificate to obtain @@ -1365,25 +1435,25 @@ export default class AvaTaxClient { * ### 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 * @param int id The unique ID number of this certificate - * @param object model The list of customers needed be added to the Certificate for exemption - * @return FetchResult - */ - linkCustomersToCertificate({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/customers/link`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * List all attributes applied to this certificate - * + * @param object model The list of customers needed be added to the Certificate for exemption + * @return FetchResult + */ + linkCustomersToCertificate({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/customers/link`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * List all attributes applied to this certificate + * * Retrieve the list of attributes that are linked to this certificate. * * A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -1402,24 +1472,24 @@ export default class AvaTaxClient { * ### 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 - * @param int id The unique ID number of this certificate - * @return FetchResult - */ - listAttributesForCertificate({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/attributes`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List customers linked to this certificate - * + * @param int id The unique ID number of this certificate + * @return FetchResult + */ + listAttributesForCertificate({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/attributes`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List customers linked to this certificate + * * List all customers linked to this certificate. * * Customers must be linked to a certificate in order to make use of its tax exemption features. You @@ -1438,27 +1508,27 @@ export default class AvaTaxClient { * ### 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 * @param int id The unique ID number of this certificate - * @param string include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. - * @return FetchResult - */ - listCustomersForCertificate({ companyId, id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/customers`, + * @param string include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. + * @return FetchResult + */ + listCustomersForCertificate({ companyId, id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/customers`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all certificates for a company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all certificates for a company + * * List all certificates recorded by a company * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1480,20 +1550,20 @@ 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 ID number of the company to search * @param string include OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryCertificates({ companyId, include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryCertificates({ companyId, include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates`, parameters: { $include: include, $filter: filter, @@ -1501,13 +1571,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Request setup of exemption certificates for this company. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Request setup of exemption certificates for this company. + * * Requests the setup of exemption certificates for this company. * * Exemption certificates are tracked through a different auditable data store than the one that @@ -1521,23 +1591,23 @@ 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. - * - * - * @param int companyId - * @return object - */ - requestCertificateSetup({ companyId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/setup`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Unlink attributes from a certificate - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * + * + * @param int companyId + * @return object + */ + requestCertificateSetup({ companyId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/setup`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Unlink attributes from a certificate + * * Unlink one or many attributes from a certificate. * * A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -1556,25 +1626,25 @@ export default class AvaTaxClient { * ### 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 * @param int id The unique ID number of this certificate - * @param object[] model The list of attributes to unlink from this certificate. - * @return FetchResult - */ - unlinkAttributesFromCertificate({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/attributes/unlink`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Unlink customers from a certificate - * + * @param object[] model The list of attributes to unlink from this certificate. + * @return FetchResult + */ + unlinkAttributesFromCertificate({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/attributes/unlink`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Unlink customers from a certificate + * * Unlinks one or more customers from a certificate. * * Unlinking a certificate from a customer will prevent the certificate from being used to generate @@ -1595,25 +1665,25 @@ export default class AvaTaxClient { * ### 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 * @param int id The unique ID number of this certificate - * @param object model The list of customers to unlink from this certificate - * @return FetchResult - */ - unlinkCustomersFromCertificate({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/customers/unlink`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Update a single certificate - * + * @param object model The list of customers to unlink from this certificate + * @return FetchResult + */ + unlinkCustomersFromCertificate({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/customers/unlink`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Update a single certificate + * * Replace the certificate identified by this URL with a new one. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1629,25 +1699,25 @@ export default class AvaTaxClient { * ### 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 * @param int id The unique ID number of this certificate - * @param object model The new certificate object that will replace the existing one - * @return object - */ - updateCertificate({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Upload an image or PDF attachment for this certificate - * + * @param object model The new certificate object that will replace the existing one + * @return object + */ + updateCertificate({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Upload an image or PDF attachment for this certificate + * * Upload an image or PDF attachment for this certificate. * * Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please @@ -1666,25 +1736,25 @@ 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 that recorded this certificate * @param int id The unique ID number of this certificate - * @param object file The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG. - * @return string - */ - uploadCertificateImage({ companyId, id, file } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/certificates/${id}/attachment`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. - * + * @param object file The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG. + * @return string + */ + uploadCertificateImage({ companyId, id, file } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/certificates/${id}/attachment`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. + * * Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations. * For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the * written integrations for a company are sufficient enough to be delivered to the respective customers to start using it. @@ -1711,23 +1781,23 @@ 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. - * - * - * @param int id The ID of the company to check if its integration is certified. - * @return string - */ - certifyIntegration({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/certify`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Change the filing status of this company - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * + * + * @param int id The ID of the company to check if its integration is certified. + * @return string + */ + certifyIntegration({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/certify`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Change the filing status of this company + * * Changes the current filing status of this company. * * For customers using Avalara's Managed Returns Service, each company within their account can request @@ -1744,24 +1814,24 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id - * @param object model - * @return string - */ - changeFilingStatus({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/filingstatus`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Quick setup for a company with a single physical address - * + * @param object model + * @return string + */ + changeFilingStatus({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/filingstatus`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Quick setup for a company with a single physical address + * * Shortcut to quickly setup a single-physical-location company with critical information and activate it. * This API provides quick and simple company setup functionality and does the following things: * @@ -1777,23 +1847,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * - * - * @param object model Information about the company you wish to create. - * @return object - */ - companyInitialize({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/initialize`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create new companies - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * + * + * @param object model Information about the company you wish to create. + * @return object + */ + companyInitialize({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/initialize`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create new companies + * * Create one or more new company objects. * A 'company' represents a single corporation or individual that is registered to handle transactional taxes. * You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company. @@ -1802,23 +1872,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * - * - * @param object[] model Either a single company object or an array of companies to create - * @return object[] - */ - createCompanies({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Request managed returns funding setup for a company - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * + * + * @param object[] model Either a single company object or an array of companies to create + * @return object[] + */ + createCompanies({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Request managed returns funding setup for a company + * * This API is available by invitation only. * Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are * required to setup their funding configuration before Avalara can begin filing tax returns on their @@ -1833,45 +1903,45 @@ export default class AvaTaxClient { * ### Security Policies * * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The unique identifier of the company - * @param object model The funding initialization request - * @return object - */ - createFundingRequest({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/funding/setup`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single company - * + * @param object model The funding initialization request + * @return object + */ + createFundingRequest({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/funding/setup`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single company + * * Deleting a company will delete all child companies, and all users attached to this company. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + * * - * @param int id The ID of the company you wish to delete. - * @return object[] - */ - deleteCompany({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}`, + * @param int id The ID of the company you wish to delete. + * @return object[] + */ + deleteCompany({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}`, parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Check the funding configuration of a company - * + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Check the funding configuration of a company + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns the funding configuration of the requested company. @@ -1880,23 +1950,23 @@ 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. - * - * - * @param int companyId The unique identifier of the company - * @return object - */ - fundingConfigurationByCompany({ companyId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/funding/configuration`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Check the funding configuration of a company - * + * * 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 + * @return object + */ + fundingConfigurationByCompany({ companyId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/funding/configuration`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Check the funding configuration of a company + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns the funding configuration of the requested company. @@ -1905,26 +1975,26 @@ 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 - * @param string currency The currency of the funding. USD and CAD are the only valid currencies - * @return object[] - */ - fundingConfigurationsByCompanyAndCurrency({ companyId, currency } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/funding/configurations`, + * @param string currency The currency of the funding. USD and CAD are the only valid currencies + * @return object[] + */ + fundingConfigurationsByCompanyAndCurrency({ companyId, currency } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/funding/configurations`, parameters: { currency: currency } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single company + * * Get the company object identified by this URL. * A 'company' represents a single corporation or individual that is registered to handle transactional taxes. * You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: @@ -1941,26 +2011,26 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the company to retrieve. - * @param string include OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects. - * @return object - */ - getCompany({ id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}`, + * @param string include OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects. + * @return object + */ + getCompany({ id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get configuration settings for this company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Get configuration settings for this company + * * Retrieve a list of all configuration settings tied to this company. * * Configuration settings provide you with the ability to control features of your account and of your @@ -1976,23 +2046,23 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * - * @param int id - * @return object[] - */ - getCompanyConfiguration({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/configuration`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get this company's filing status - * + * @param int id + * @return object[] + */ + getCompanyConfiguration({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/configuration`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Get this company's filing status + * * Retrieve the current filing status of this company. * * For customers using Avalara's Managed Returns Service, each company within their account can request @@ -2009,23 +2079,23 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * - * @param int id - * @return string - */ - getFilingStatus({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/filingstatus`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Check managed returns funding status for a company - * + * @param int id + * @return string + */ + getFilingStatus({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/filingstatus`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Check managed returns funding status for a company + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns a list of funding setup requests and their current status. @@ -2034,45 +2104,45 @@ export default class AvaTaxClient { * ### Security Policies * * * This API depends on the following active services
*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * - * - * @param int id The unique identifier of the company - * @return object[] - */ - listFundingRequestsByCompany({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/funding`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a list of MRS Companies with account - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * + * + * @param int id The unique identifier of the company + * @return object[] + */ + listFundingRequestsByCompany({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/funding`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a list of MRS Companies with account + * * This API is available by invitation only. * * Get a list of companies with an active MRS service. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * - * - * @return FetchResult - */ - listMrsCompanies({ } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/mrs`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all companies - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * + * + * @return FetchResult + */ + listMrsCompanies({ } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/mrs`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all companies + * * Get multiple company objects. * * A `company` represents a single corporation or individual that is registered to handle transactional taxes. @@ -2093,19 +2163,19 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string include A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name. * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryCompanies({ include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryCompanies({ include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies`, parameters: { $include: include, $filter: filter, @@ -2113,13 +2183,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Change configuration settings for this company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Change configuration settings for this company + * * Update configuration settings tied to this company. * * Configuration settings provide you with the ability to control features of your account and of your @@ -2135,24 +2205,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int id - * @param object[] model - * @return object[] - */ - setCompanyConfiguration({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}/configuration`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Update a single company - * + * @param object[] model + * @return object[] + */ + setCompanyConfiguration({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}/configuration`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Update a single company + * * Replace the existing company object at this URL with an updated object. * * A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes. @@ -2167,112 +2237,112 @@ 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 requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int id The ID of the company you wish to update. - * @param object model The company object you wish to update. - * @return object - */ - updateCompany({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * API to modify the reference fields at the document and the line level. - * - * - * + * @param object model The company object you wish to update. + * @return object + */ + updateCompany({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * API to modify the reference fields at the document and the line level. + * + * + * * * @param int companyId - * @param object[] model - * @return FetchResult - */ - tagTransaction({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/transactions/tag`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create a new contact - * + * @param object[] model + * @return FetchResult + */ + tagTransaction({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/transactions/tag`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create a new contact + * * Create one or more new contact objects. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this contact. - * @param object[] model The contacts you wish to create. - * @return object[] - */ - createContacts({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single contact - * + * @param object[] model The contacts you wish to create. + * @return object[] + */ + createContacts({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/contacts`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single contact + * * Mark the existing contact object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this contact. - * @param int id The ID of the contact you wish to delete. - * @return object[] - */ - deleteContact({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single contact - * + * @param int id The ID of the contact you wish to delete. + * @return object[] + */ + deleteContact({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/contacts/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single contact + * * Get the contact object identified by this URL. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company for this contact - * @param int id The primary key of this contact - * @return object - */ - getContact({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve contacts for this company - * + * @param int id The primary key of this contact + * @return object + */ + getContact({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/contacts/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve contacts for this company + * * List all contact objects assigned to this company. * * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -2280,32 +2350,32 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company that owns these contacts * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listContactsByCompany({ companyId, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listContactsByCompany({ companyId, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/contacts`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all contacts - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all contacts + * * Get multiple contact objects across all companies. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. @@ -2315,31 +2385,31 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryContacts({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/contacts`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryContacts({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/contacts`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single contact - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single contact + * * Replace the existing contact object at this URL with an updated object. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. @@ -2348,25 +2418,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this contact belongs to. * @param int id The ID of the contact you wish to update - * @param object model The contact you wish to update. - * @return object - */ - updateContact({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/contacts/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create customers for this company - * + * @param object model The contact you wish to update. + * @return object + */ + updateContact({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/contacts/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create customers for this company + * * Create one or more customers for this company. * * A customer object defines information about a person or business that purchases products from your @@ -2386,24 +2456,24 @@ export default class AvaTaxClient { * ### 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 - * @param object[] model The list of customer objects to be created - * @return object[] - */ - createCustomers({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a customer record - * + * @param object[] model The list of customer objects to be created + * @return object[] + */ + createCustomers({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a customer record + * * Deletes the customer object referenced by this URL. * * A customer object defines information about a person or business that purchases products from your @@ -2420,24 +2490,24 @@ export default class AvaTaxClient { * ### 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 - * @param string customerCode The unique code representing this customer - * @return object - */ - deleteCustomer({ companyId, customerCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single customer - * + * @param string customerCode The unique code representing this customer + * @return object + */ + deleteCustomer({ companyId, customerCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single customer + * * Retrieve the customer identified by this URL. * * A customer object defines information about a person or business that purchases products from your @@ -2460,27 +2530,27 @@ 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 that recorded this customer * @param string customerCode The unique code representing this customer - * @param string include Specify optional additional objects to include in this fetch request - * @return object - */ - getCustomer({ companyId, customerCode, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}`, + * @param string include Specify optional additional objects to include in this fetch request + * @return object + */ + getCustomer({ companyId, customerCode, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Link attributes to a customer - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Link attributes to a customer + * * Link one or many attributes to a customer. * * A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -2500,25 +2570,25 @@ export default class AvaTaxClient { * ### 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 * @param string customerCode The unique code representing the current customer - * @param object[] model The list of attributes to link to the customer. - * @return FetchResult - */ - linkAttributesToCustomer({ companyId, customerCode, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/attributes/link`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Link certificates to a customer - * + * @param object[] model The list of attributes to link to the customer. + * @return FetchResult + */ + linkAttributesToCustomer({ companyId, customerCode, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/attributes/link`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Link certificates to a customer + * * Link one or more certificates to a customer. * * A customer object defines information about a person or business that purchases products from your @@ -2535,25 +2605,25 @@ 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 that recorded this customer * @param string customerCode The unique code representing this customer - * @param object model The list of certificates to link to this customer - * @return FetchResult - */ - linkCertificatesToCustomer({ companyId, customerCode, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates/link`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Link two customer records together - * + * @param object model The list of certificates to link to this customer + * @return FetchResult + */ + linkCertificatesToCustomer({ companyId, customerCode, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates/link`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Link two customer records together + * * Links a Ship-To customer record with a Bill-To customer record. * * Customer records represent businesses or individuals who can provide exemption certificates. Some customers @@ -2571,25 +2641,25 @@ 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. * @param string code The code of the bill-to customer to link. - * @param object model A list of information about ship-to customers to link to this bill-to customer. - * @return object - */ - linkShipToCustomersToBillCustomer({ companyId, code, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/billto/${code}/shipto/link`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Retrieve a customer's attributes - * + * @param object model A list of information about ship-to customers to link to this bill-to customer. + * @return object + */ + linkShipToCustomersToBillCustomer({ companyId, code, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/billto/${code}/shipto/link`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Retrieve a customer's attributes + * * Retrieve the attributes linked to the customer identified by this URL. * * A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -2609,24 +2679,24 @@ 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 that recorded the provided customer - * @param string customerCode The unique code representing the current customer - * @return FetchResult - */ - listAttributesForCustomer({ companyId, customerCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/attributes`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List certificates linked to a customer - * + * @param string customerCode The unique code representing the current customer + * @return FetchResult + */ + listAttributesForCustomer({ companyId, customerCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/attributes`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List certificates linked to a customer + * * List all certificates linked to a customer. * * A customer object defines information about a person or business that purchases products from your @@ -2643,8 +2713,8 @@ 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 that recorded this customer * @param string customerCode The unique code representing this customer @@ -2652,12 +2722,12 @@ export default class AvaTaxClient { * @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCertificatesForCustomer({ companyId, customerCode, include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCertificatesForCustomer({ companyId, customerCode, include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates`, parameters: { $include: include, $filter: filter, @@ -2665,13 +2735,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List valid certificates for a location - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List valid certificates for a location + * * List valid certificates linked to a customer in a particular country and region. * * This API is intended to help identify whether a customer has already provided a certificate that @@ -2691,26 +2761,26 @@ 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 that recorded this customer * @param string customerCode The unique code representing this customer * @param string country Search for certificates matching this country. Uses the ISO 3166 two character country code. - * @param string region Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code. - * @return object - */ - listValidCertificatesForCustomer({ companyId, customerCode, country, region } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates/${country}/${region}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all customers for this company - * + * @param string region Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code. + * @return object + */ + listValidCertificatesForCustomer({ companyId, customerCode, country, region } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates/${country}/${region}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all customers for this company + * * List all customers recorded by this company matching the specified criteria. * * A customer object defines information about a person or business that purchases products from your @@ -2732,20 +2802,20 @@ 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 that recorded this customer * @param string include OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer. * @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:* shipTos * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryCustomers({ companyId, include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryCustomers({ companyId, include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers`, parameters: { $include: include, $filter: filter, @@ -2753,13 +2823,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Unlink attributes from a customer - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Unlink attributes from a customer + * * Unlink one or many attributes from a customer. * * A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -2779,25 +2849,25 @@ export default class AvaTaxClient { * ### 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 * @param string customerCode The unique code representing the current customer - * @param object[] model The list of attributes to unlink from the customer. - * @return FetchResult - */ - unlinkAttributesFromCustomer({ companyId, customerCode, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/attributes/unlink`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Unlink certificates from a customer - * + * @param object[] model The list of attributes to unlink from the customer. + * @return FetchResult + */ + unlinkAttributesFromCustomer({ companyId, customerCode, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/attributes/unlink`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Unlink certificates from a customer + * * Remove one or more certificates to a customer. * * A customer object defines information about a person or business that purchases products from your @@ -2814,25 +2884,25 @@ 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 that recorded this customer * @param string customerCode The unique code representing this customer - * @param object model The list of certificates to link to this customer - * @return FetchResult - */ - unlinkCertificatesFromCustomer({ companyId, customerCode, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates/unlink`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Update a single customer - * + * @param object model The list of certificates to link to this customer + * @return FetchResult + */ + unlinkCertificatesFromCustomer({ companyId, customerCode, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}/certificates/unlink`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Update a single customer + * * Replace the customer object at this URL with a new record. * * A customer object defines information about a person or business that purchases products from your @@ -2849,125 +2919,125 @@ export default class AvaTaxClient { * ### 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 * @param string customerCode The unique code representing this customer - * @param object model The new customer model that will replace the existing record at this URL - * @return object - */ - updateCustomer({ companyId, customerCode, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/customers/${customerCode}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create and store new datasources for the respective companies. - * + * @param object model The new customer model that will replace the existing record at this URL + * @return object + */ + updateCustomer({ companyId, customerCode, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/customers/${customerCode}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create and store new datasources for the respective companies. + * * Create one or more datasource objects. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * * @param int companyId The id of the company you which to create the datasources - * @param object[] model - * @return object[] - */ - createDataSources({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/datasources`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a datasource by datasource id for a company. - * + * @param object[] model + * @return object[] + */ + createDataSources({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/datasources`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a datasource by datasource id for a company. + * * Marks the existing datasource for a company as deleted. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * * @param int companyId The id of the company the datasource belongs to. - * @param int id The id of the datasource you wish to delete. - * @return object[] - */ - deleteDataSource({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/datasources/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Get data source by data source id - * + * @param int id The id of the datasource you wish to delete. + * @return object[] + */ + deleteDataSource({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/datasources/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Get data source by data source id + * * Retrieve the data source by its unique ID number. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * * @param int companyId - * @param int id data source id - * @return object - */ - getDataSourceById({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/datasources/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all datasources for this company - * + * @param int id data source id + * @return object + */ + getDataSourceById({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/datasources/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all datasources for this company + * * Gets multiple datasource objects for a given company. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * * @param int companyId The id of the company you wish to retrieve the datasources. * @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 * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listDataSources({ companyId, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/datasources`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listDataSources({ companyId, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/datasources`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all datasources - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all datasources + * * Get multiple datasource objects across all companies. * * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -2976,55 +3046,55 @@ 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 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 * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryDataSources({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/datasources`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryDataSources({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/datasources`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a datasource identified by id for a company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a datasource identified by id for a company + * * Updates a datasource for a company. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * * @param int companyId The id of the company the datasource belongs to. * @param int id The id of the datasource you wish to delete. - * @param object model - * @return object - */ - updateDataSource({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/datasources/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Lists all parents of an HS Code. - * + * @param object model + * @return object + */ + updateDataSource({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/datasources/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Lists all parents of an HS Code. + * * Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings * * a list of HS Codes that are the parents and information branches of the HS Code for the given @@ -3038,100 +3108,100 @@ 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. - * @param string hsCode The partial or full HS Code for which you would like to view all of the parents. - * @return FetchResult - */ - getCrossBorderCode({ country, hsCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/crossborder/${country}/${hsCode}/hierarchy`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Test whether a form supports online login verification - * + * @param string hsCode The partial or full HS Code for which you would like to view all of the parents. + * @return FetchResult + */ + getCrossBorderCode({ country, hsCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/crossborder/${country}/${hsCode}/hierarchy`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Test whether a form supports online login verification + * * This API is intended to be useful to identify whether the user should be allowed - * to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification. - * + * to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification. + * * * @param string form The name of the form you would like to verify. This is the tax form code * @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - getLoginVerifierByForm({ form, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/filingcalendars/loginverifiers/${form}`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + getLoginVerifierByForm({ form, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/filingcalendars/loginverifiers/${form}`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of the AvaFile Forms available - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of the AvaFile Forms available + * * This API is deprecated. * * Please use the ListTaxForms API. * * Returns the full list of Avalara-supported AvaFile Forms - * This API is intended to be useful to identify all the different AvaFile Forms - * + * This API is intended to be useful to identify all the different AvaFile Forms + * * * @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 * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listAvaFileForms({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/avafileforms`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listAvaFileForms({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/avafileforms`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List certificate attributes used by a company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List certificate attributes used by a company + * * List the certificate attributes defined by a company either specified by the user or the user's default company. * * A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a * certificate at any time. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * + * check and provision account. + * * * @param int companyid Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company. * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCertificateAttributes({ companyid, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/certificateattributes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCertificateAttributes({ companyid, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/certificateattributes`, parameters: { companyid: companyid, $filter: filter, @@ -3139,180 +3209,180 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List the certificate exempt reasons defined by a company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List the certificate exempt reasons defined by a company + * * List the certificate exempt reasons defined by a company. * * An exemption reason defines why a certificate allows a customer to be exempt * for purposes of tax calculation. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * + * check and provision account. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCertificateExemptReasons({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/certificateexemptreasons`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCertificateExemptReasons({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/certificateexemptreasons`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List certificate exposure zones used by a company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List certificate exposure zones used by a company + * * List the certificate exposure zones defined by a company. * * An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing * authority or other legal entity to which a certificate may apply. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * + * check and provision account. + * * * @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:* id, companyId, name, tag, description, created, modified, region, country * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCertificateExposureZones({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/certificateexposurezones`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCertificateExposureZones({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/certificateexposurezones`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of communications service types - * - * Returns full list of service types for a given transaction type ID. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of communications service types + * + * Returns full list of service types for a given transaction type ID. + * * * @param int id The transaction type ID to examine * @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:* requiredParameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCommunicationsServiceTypes({ id, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/communications/transactiontypes/${id}/servicetypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCommunicationsServiceTypes({ id, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/communications/transactiontypes/${id}/servicetypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of communications transactiontypes - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of communications transactiontypes + * * Returns full list of communications transaction types which - * are accepted in communication tax calculation requests. - * + * are accepted in communication tax calculation requests. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCommunicationsTransactionTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/communications/transactiontypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCommunicationsTransactionTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/communications/transactiontypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of communications transaction/service type pairs - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of communications transaction/service type pairs + * * Returns full list of communications transaction/service type pairs which - * are accepted in communication tax calculation requests. - * + * are accepted in communication tax calculation requests. + * * * @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:* requiredParameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCommunicationsTSPairs({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/communications/tspairs`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCommunicationsTSPairs({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/communications/tspairs`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all ISO 3166 countries - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all ISO 3166 countries + * * Returns a list of all ISO 3166 country codes, and their US English friendly names. * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for - * a shipping address. - * + * a shipping address. + * * * @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:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCountries({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/countries`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCountries({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/countries`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List certificate exposure zones used by a company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List certificate exposure zones used by a company + * * List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. * * The CoverLetter model represents a message sent along with an invitation to use CertExpress to @@ -3320,31 +3390,31 @@ export default class AvaTaxClient { * certificates directly; this cover letter explains why the invitation was sent. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * + * check and provision account. + * * * @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:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCoverLetters({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/coverletters`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCoverLetters({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/coverletters`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Lists the next level of HS Codes given a destination country and HS Code prefix. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Lists the next level of HS Codes given a destination country and HS Code prefix. + * * Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if * additional children are available. * @@ -3356,33 +3426,33 @@ 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. * @param string hsCode The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available. * @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:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCrossBorderCodes({ country, hsCode, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/crossborder/${country}/${hsCode}`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCrossBorderCodes({ country, hsCode, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/crossborder/${country}/${hsCode}`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List top level HS Code Sections. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List top level HS Code Sections. + * * Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for * classifying tariff codes and the items to which they apply. HS Codes are organized * by Section/Chapter/Heading/Subheading/Classification. @@ -3392,143 +3462,143 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API depends on the following active services
*Required* (all): AvaTaxGlobal. - * - * - * @return FetchResult - */ - listCrossBorderSections({ } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/crossborder/sections`, + * * This API depends on the following active services
*Required* (all): AvaTaxGlobal. + * + * + * @return FetchResult + */ + listCrossBorderSections({ } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/crossborder/sections`, parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all ISO 4217 currencies supported by AvaTax. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all ISO 4217 currencies supported by AvaTax. + * * Lists all ISO 4217 currencies supported by AvaTax. * * This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the - * `currencyCode` field in a `CreateTransactionModel`. - * + * `currencyCode` field in a `CreateTransactionModel`. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listCurrencies({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/currencies`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listCurrencies({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/currencies`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported entity use codes - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported entity use codes + * * Returns the full list of Avalara-supported entity use codes. * Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction * is occurring. This information is generally used to determine taxability of the product. * In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for - * all transactions that are exempt. - * + * all transactions that are exempt. + * * * @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:* validCountries * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listEntityUseCodes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/entityusecodes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listEntityUseCodes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/entityusecodes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported filing frequencies. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported filing frequencies. + * * Returns the full list of Avalara-supported filing frequencies. - * This API is intended to be useful to identify all the different filing frequencies that can be used in notices. - * + * This API is intended to be useful to identify all the different filing frequencies that can be used in notices. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listFilingFrequencies({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/filingfrequencies`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listFilingFrequencies({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/filingfrequencies`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List jurisdictions based on the filter provided - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List jurisdictions based on the filter provided + * * Returns a list of all Avalara-supported taxing jurisdictions. * * This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying * SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' * - * The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API. - * + * The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API. + * * * @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:* rate, salesRate, signatureCode, useRate * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listJurisdictions({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/jurisdictions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listJurisdictions({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/jurisdictions`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List jurisdictions near a specific address - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List jurisdictions near a specific address + * * Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. * * This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information. * It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby * jurisdiction in AvaTax. * - * The results of this API call can be passed to the `CreateJurisdictionOverride` API call. - * + * The results of this API call can be passed to the `CreateJurisdictionOverride` API call. + * * * @param string line1 The first address line portion of this address. * @param string line2 The second address line portion of this address. @@ -3540,12 +3610,12 @@ export default class AvaTaxClient { * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listJurisdictionsByAddress({ line1, line2, line3, city, region, postalCode, country, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/jurisdictionsnearaddress`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listJurisdictionsByAddress({ line1, line2, line3, city, region, postalCode, country, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/jurisdictionsnearaddress`, parameters: { line1: line1, line2: line2, @@ -3559,20 +3629,20 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the list of questions that are required for a tax location - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the list of questions that are required for a tax location + * * Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. * Some tax jurisdictions require that you register or provide additional information to configure each physical place where * your company does business. * This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly. * You can call this API call for any address and obtain information about what questions must be answered in order to properly - * file tax in that location. - * + * file tax in that location. + * * * @param string line1 The first line of this location's address. * @param string line2 The second line of this location's address. @@ -3586,12 +3656,12 @@ export default class AvaTaxClient { * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listLocationQuestionsByAddress({ line1, line2, line3, city, region, postalCode, country, latitude, longitude, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/locationquestions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listLocationQuestionsByAddress({ line1, line2, line3, city, region, postalCode, country, latitude, longitude, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/locationquestions`, parameters: { line1: line1, line2: line2, @@ -3607,98 +3677,98 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all forms where logins can be verified automatically - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all forms where logins can be verified automatically + * * List all forms where logins can be verified automatically. * This API is intended to be useful to identify whether the user should be allowed - * to automatically verify their login and password. - * + * to automatically verify their login and password. + * * * @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listLoginVerifiers({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/filingcalendars/loginverifiers`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listLoginVerifiers({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/filingcalendars/loginverifiers`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the list of locations for a marketplace. - * - * Retrieves the list of suggested locations for a marketplace. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the list of locations for a marketplace. + * + * Retrieves the list of suggested locations for a marketplace. + * * * @param string marketplaceId MarketplaceId of a marketplace * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listMarketplaceLocations({ marketplaceId, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/marketplacelocations`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listMarketplaceLocations({ marketplaceId, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/marketplacelocations`, parameters: { marketplaceId: marketplaceId, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported nexus for all countries and regions. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported nexus for all countries and regions. + * * Returns the full list of all Avalara-supported nexus for all countries and regions. * - * This API is intended to be useful if your user interface needs to display a selectable list of nexus. - * + * This API is intended to be useful if your user interface needs to display a selectable list of nexus. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexus({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/nexus`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNexus({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/nexus`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all nexus that apply to a specific address. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all nexus that apply to a specific address. + * * Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. * This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale. * In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address * where the company does business. - * The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address. - * + * The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address. + * * * @param string line1 The first address line portion of this address. * @param string line2 The first address line portion of this address. @@ -3710,12 +3780,12 @@ export default class AvaTaxClient { * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexusByAddress({ line1, line2, line3, city, region, postalCode, country, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/nexus/byaddress`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNexusByAddress({ line1, line2, line3, city, region, postalCode, country, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/nexus/byaddress`, parameters: { line1: line1, line2: line2, @@ -3729,70 +3799,70 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported nexus for a country. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported nexus for a country. + * * Returns all Avalara-supported nexus for the specified country. * - * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country. - * + * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country. + * * * @param string country The country in which you want to fetch the system nexus * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexusByCountry({ country, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/nexus/${country}`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNexusByCountry({ country, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/nexus/${country}`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported nexus for a country and region. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported nexus for a country and region. + * * Returns all Avalara-supported nexus for the specified country and region. * - * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region. - * + * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region. + * * * @param string country The two-character ISO-3166 code for the country. * @param string region The two or three character region code for the region. * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexusByCountryAndRegion({ country, region, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/nexus/${country}/${region}`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNexusByCountryAndRegion({ country, region, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/nexus/${country}/${region}`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List nexus related to a tax form - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List nexus related to a tax form + * * Retrieves a list of nexus related to a tax form. * * The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated @@ -3807,415 +3877,415 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * - * @param string formCode The form code that we are looking up the nexus for - * @return object - */ - listNexusByFormCode({ formCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/nexus/byform/${formCode}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of nexus tax type groups - * + * @param string formCode The form code that we are looking up the nexus for + * @return object + */ + listNexusByFormCode({ formCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/nexus/byform/${formCode}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of nexus tax type groups + * * Returns the full list of Avalara-supported nexus tax type groups - * This API is intended to be useful to identify all the different tax sub-types. - * + * This API is intended to be useful to identify all the different tax sub-types. + * * * @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexusTaxTypeGroups({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/nexustaxtypegroups`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNexusTaxTypeGroups({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/nexustaxtypegroups`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice customer funding options. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice customer funding options. + * * Returns the full list of Avalara-supported tax notice customer funding options. - * This API is intended to be useful to identify all the different notice customer funding options that can be used in notices. - * + * This API is intended to be useful to identify all the different notice customer funding options that can be used in notices. + * * * @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:* activeFlag, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeCustomerFundingOptions({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticecustomerfundingoptions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeCustomerFundingOptions({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticecustomerfundingoptions`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice customer types. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice customer types. + * * Returns the full list of Avalara-supported tax notice customer types. - * This API is intended to be useful to identify all the different notice customer types. - * + * This API is intended to be useful to identify all the different notice customer types. + * * * @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:* activeFlag, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeCustomerTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticecustomertypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeCustomerTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticecustomertypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice filing types. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice filing types. + * * Returns the full list of Avalara-supported tax notice filing types. - * This API is intended to be useful to identify all the different notice filing types that can be used in notices. - * + * This API is intended to be useful to identify all the different notice filing types that can be used in notices. + * * * @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:* description, activeFlag, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeFilingtypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticefilingtypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeFilingtypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticefilingtypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice priorities. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice priorities. + * * Returns the full list of Avalara-supported tax notice priorities. - * This API is intended to be useful to identify all the different notice priorities that can be used in notices. - * + * This API is intended to be useful to identify all the different notice priorities that can be used in notices. + * * * @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:* activeFlag, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticePriorities({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticepriorities`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticePriorities({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticepriorities`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice reasons. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice reasons. + * * Returns the full list of Avalara-supported tax notice reasons. - * This API is intended to be useful to identify all the different tax notice reasons. - * + * This API is intended to be useful to identify all the different tax notice reasons. + * * * @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:* description, activeFlag, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeReasons({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticereasons`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeReasons({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticereasons`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice responsibility ids - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice responsibility ids + * * Returns the full list of Avalara-supported tax notice responsibility ids - * This API is intended to be useful to identify all the different tax notice responsibilities. - * + * This API is intended to be useful to identify all the different tax notice responsibilities. + * * * @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:* sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeResponsibilities({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticeresponsibilities`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeResponsibilities({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticeresponsibilities`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice root causes - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice root causes + * * Returns the full list of Avalara-supported tax notice root causes - * This API is intended to be useful to identify all the different tax notice root causes. - * + * This API is intended to be useful to identify all the different tax notice root causes. + * * * @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:* sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeRootCauses({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticerootcauses`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeRootCauses({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticerootcauses`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice statuses. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice statuses. + * * Returns the full list of Avalara-supported tax notice statuses. - * This API is intended to be useful to identify all the different tax notice statuses. - * + * This API is intended to be useful to identify all the different tax notice statuses. + * * * @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:* isOpen, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeStatuses({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticestatuses`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeStatuses({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticestatuses`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax notice types. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax notice types. + * * Returns the full list of Avalara-supported tax notice types. - * This API is intended to be useful to identify all the different notice types that can be used in notices. - * + * This API is intended to be useful to identify all the different notice types that can be used in notices. + * * * @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:* activeFlag, sortOrder * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNoticeTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/noticetypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNoticeTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/noticetypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported extra parameters for creating transactions. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported extra parameters for creating transactions. + * * Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. * This list of parameters is available for use when configuring your transaction. - * Some parameters are only available for use if you have subscribed to certain features of AvaTax. - * + * Some parameters are only available for use if you have subscribed to certain features of AvaTax. + * * * @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:* serviceTypes, regularExpression, values * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listParameters({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/parameters`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listParameters({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/parameters`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the parameters by companyCode and itemCode. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the parameters by companyCode and itemCode. + * * Returns the list of parameters based on the company country and state jurisdiction and the item code. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string companyCode Company code. * @param string itemCode Item code. * @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:* serviceTypes, regularExpression, values * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listParametersByItem({ companyCode, itemCode, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/parameters/byitem/${companyCode}/${itemCode}`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listParametersByItem({ companyCode, itemCode, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/parameters/byitem/${companyCode}/${itemCode}`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. + * * Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. * This list of parameters is available for use when configuring your transaction. - * Some parameters are only available for use if you have subscribed to certain features of AvaTax. - * + * Some parameters are only available for use if you have subscribed to certain features of AvaTax. + * * * @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:* values * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listParametersUsage({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/parametersusage`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listParametersUsage({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/parametersusage`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported permissions - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported permissions + * * Returns the full list of Avalara-supported permission types. - * This API is intended to be useful to identify the capabilities of a particular user logon. - * + * This API is intended to be useful to identify the capabilities of a particular user logon. + * * * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @return FetchResult - */ - listPermissions({ top, skip } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/permissions`, + * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return FetchResult + */ + listPermissions({ top, skip } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/permissions`, parameters: { $top: top, $skip: skip } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported postal codes. - * - * Retrieves the list of Avalara-supported postal codes. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported postal codes. + * + * Retrieves the list of Avalara-supported postal codes. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listPostalCodes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/postalcodes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listPostalCodes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/postalcodes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all customs duty programs recognized by AvaTax - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all customs duty programs recognized by AvaTax + * * List all preferred customs duty programs recognized by AvaTax. * * A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. @@ -4224,331 +4294,331 @@ export default class AvaTaxClient { * * To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your * preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of - * the program. - * + * the program. + * * * @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:* effectiveDate, endDate * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listPreferredPrograms({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/preferredprograms`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listPreferredPrograms({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/preferredprograms`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all available product classification systems. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all available product classification systems. + * * List all available product classification systems. * * Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. - * More than one tax authority might use the same product classification system, but they might charge different tax rates for products. - * + * More than one tax authority might use the same product classification system, but they might charge different tax rates for products. + * * * @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:* countries * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listProductClassificationSystems({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/productclassificationsystems`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listProductClassificationSystems({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/productclassificationsystems`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all product classification systems available to a company based on its nexus. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all product classification systems available to a company based on its nexus. + * * Lists all product classification systems available to a company based on its nexus. * * Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. - * More than one tax authority might use the same product classification system, but they might charge different tax rates for products. - * + * More than one tax authority might use the same product classification system, but they might charge different tax rates for products. + * * * @param string companyCode The company code. * @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:* countries * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listProductClassificationSystemsByCompany({ companyCode, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/productclassificationsystems/bycompany/${companyCode}`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listProductClassificationSystemsByCompany({ companyCode, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/productclassificationsystems/bycompany/${companyCode}`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of rate types for each country - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of rate types for each country + * * Returns the full list of Avalara-supported rate type file types - * This API is intended to be useful to identify all the different rate types. - * + * This API is intended to be useful to identify all the different rate types. + * * * @param string country The country to examine for rate types * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listRateTypesByCountry({ country, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/countries/${country}/ratetypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listRateTypesByCountry({ country, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/countries/${country}/ratetypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all ISO 3166 regions - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all ISO 3166 regions + * * Returns a list of all ISO 3166 region codes and their US English friendly names. * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region - * within the country for a shipping addresses. - * + * within the country for a shipping addresses. + * * * @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:* localizedNames * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listRegions({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/regions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listRegions({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/regions`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all ISO 3166 regions for a country - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all ISO 3166 regions for a country + * * Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region - * within the country for a shipping addresses. - * + * within the country for a shipping addresses. + * * * @param string country The country of which you want to fetch ISO 3166 regions * @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:* localizedNames * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listRegionsByCountry({ country, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/countries/${country}/regions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listRegionsByCountry({ country, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/countries/${country}/regions`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported resource file types - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported resource file types + * * Returns the full list of Avalara-supported resource file types - * This API is intended to be useful to identify all the different resource file types. - * + * This API is intended to be useful to identify all the different resource file types. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listResourceFileTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/resourcefiletypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listResourceFileTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/resourcefiletypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported permissions - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported permissions + * * Returns the full list of Avalara-supported permission types. * This API is intended to be useful when designing a user interface for selecting the security role of a user account. - * Some security roles are restricted for Avalara internal use. - * + * Some security roles are restricted for Avalara internal use. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listSecurityRoles({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/securityroles`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listSecurityRoles({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/securityroles`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported subscription types - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported subscription types + * * Returns the full list of Avalara-supported subscription types. * This API is intended to be useful for identifying which features you have added to your account. * You may always contact Avalara's sales department for information on available products or services. - * You cannot change your subscriptions directly through the API. - * + * You cannot change your subscriptions directly through the API. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listSubscriptionTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/subscriptiontypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listSubscriptionTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/subscriptiontypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax authorities. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax authorities. + * * Returns the full list of Avalara-supported tax authorities. - * This API is intended to be useful to identify all the different authorities that receive tax. - * + * This API is intended to be useful to identify all the different authorities that receive tax. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxAuthorities({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxauthorities`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxAuthorities({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxauthorities`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported forms for each tax authority. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported forms for each tax authority. + * * Returns the full list of Avalara-supported forms for each tax authority. * This list represents tax forms that Avalara recognizes. * Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically - * based on the customer's AvaTax data. - * + * based on the customer's AvaTax data. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxAuthorityForms({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxauthorityforms`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxAuthorityForms({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxauthorityforms`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax authority types. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax authority types. + * * Returns the full list of Avalara-supported tax authority types. - * This API is intended to be useful to identify all the different authority types. - * + * This API is intended to be useful to identify all the different authority types. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxAuthorityTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxauthoritytypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxAuthorityTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxauthoritytypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax codes. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax codes. + * * Retrieves the list of Avalara-supported system tax codes. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -4557,159 +4627,159 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxCodes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxcodes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxCodes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxcodes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of Avalara-supported tax code types. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of Avalara-supported tax code types. + * * Returns the full list of recognized tax code types. * A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode. - * This API is intended to be useful for broadly searching for tax codes by tax code type. - * + * This API is intended to be useful for broadly searching for tax codes by tax code type. + * * * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @return object - */ - listTaxCodeTypes({ top, skip } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxcodetypes`, + * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return object + */ + listTaxCodeTypes({ top, skip } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxcodetypes`, parameters: { $top: top, $skip: skip } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of the Tax Forms available - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of the Tax Forms available + * * Returns the full list of Avalara-supported Tax Forms - * This API is intended to be useful to identify all the different Tax Forms - * + * This API is intended to be useful to identify all the different Tax Forms + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxForms({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxforms`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxForms({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxforms`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of tax sub types - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of tax sub types + * * Returns the full list of Avalara-supported tax sub-types - * This API is intended to be useful to identify all the different tax sub-types. - * + * This API is intended to be useful to identify all the different tax sub-types. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxSubTypes({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxsubtypes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxSubTypes({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxsubtypes`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve the full list of tax type groups - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve the full list of tax type groups + * * Returns the full list of Avalara-supported tax type groups - * This API is intended to be useful to identify all the different tax type groups. - * + * This API is intended to be useful to identify all the different tax type groups. + * * * @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxTypeGroups({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/taxtypegroups`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxTypeGroups({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/taxtypegroups`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all defined units of measurement - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all defined units of measurement + * * List all units of measurement systems defined by Avalara. * - * A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others. - * + * A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others. + * * * @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:* id * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listUnitOfMeasurement({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/definitions/unitofmeasurements`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listUnitOfMeasurement({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/definitions/unitofmeasurements`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create one or more DistanceThreshold objects - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create one or more DistanceThreshold objects + * * Create one or more DistanceThreshold objects for this company. * * A company-distance-threshold model indicates the distance between a company @@ -4718,24 +4788,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The unique ID number of the company that owns this DistanceThreshold - * @param object[] model The DistanceThreshold object or objects you wish to create. - * @return object[] - */ - createDistanceThreshold({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/distancethresholds`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single DistanceThreshold object - * + * @param object[] model The DistanceThreshold object or objects you wish to create. + * @return object[] + */ + createDistanceThreshold({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/distancethresholds`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single DistanceThreshold object + * * Marks the DistanceThreshold object identified by this URL as deleted. * * A company-distance-threshold model indicates the distance between a company @@ -4744,24 +4814,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The unique ID number of the company that owns this DistanceThreshold - * @param int id The unique ID number of the DistanceThreshold object you wish to delete. - * @return object[] - */ - deleteDistanceThreshold({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/distancethresholds/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single DistanceThreshold - * + * @param int id The unique ID number of the DistanceThreshold object you wish to delete. + * @return object[] + */ + deleteDistanceThreshold({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/distancethresholds/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single DistanceThreshold + * * Retrieves a single DistanceThreshold object defined by this URL. * * A company-distance-threshold model indicates the distance between a company @@ -4770,24 +4840,24 @@ 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, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company that owns this DistanceThreshold object - * @param int id The unique ID number referring to this DistanceThreshold object - * @return object - */ - getDistanceThreshold({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/distancethresholds/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all DistanceThresholds for this company. - * + * @param int id The unique ID number referring to this DistanceThreshold object + * @return object + */ + getDistanceThreshold({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/distancethresholds/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all DistanceThresholds for this company. + * * Lists all DistanceThreshold objects that belong to this company. * * A company-distance-threshold model indicates the distance between a company @@ -4796,20 +4866,20 @@ 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, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company whose DistanceThreshold objects you wish to list. * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param string include A comma separated list of 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listDistanceThresholds({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/distancethresholds`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listDistanceThresholds({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/distancethresholds`, parameters: { $filter: filter, $include: include, @@ -4817,13 +4887,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all DistanceThreshold objects - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all DistanceThreshold objects + * * Lists all DistanceThreshold objects that belong to this account. * * A company-distance-threshold model indicates the distance between a company @@ -4835,19 +4905,19 @@ 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, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryDistanceThresholds({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/distancethresholds`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryDistanceThresholds({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/distancethresholds`, parameters: { $filter: filter, $include: include, @@ -4855,13 +4925,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a DistanceThreshold object - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a DistanceThreshold object + * * Replace the existing DistanceThreshold object at this URL with an updated object. * * A company-distance-threshold model indicates the distance between a company @@ -4873,54 +4943,54 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The unique ID number of the company that owns this DistanceThreshold object. * @param int id The unique ID number of the DistanceThreshold object to replace. - * @param object model The new DistanceThreshold object to store. - * @return object - */ - updateDistanceThreshold({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/distancethresholds/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Delete a company return setting - * + * @param object model The new DistanceThreshold object to store. + * @return object + */ + updateDistanceThreshold({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/distancethresholds/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Delete a company return setting + * * This API is available by invitation only and only available for users with Compliance access * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The unique ID of the company * @param int filingCalendarId The unique ID of the filing calendar that will remove setting - * @param int companyReturnSettingId The unique ID of the company return setting that will be deleted from the filing calendar - * @return object[] - */ - deleteCompanyReturnSettings({ companyId, filingCalendarId, companyReturnSettingId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/filingcalendars/${filingCalendarId}/setting/${companyReturnSettingId}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a list of filed returns for the specified company in the year and month of a given filing period. - * + * @param int companyReturnSettingId The unique ID of the company return setting that will be deleted from the filing calendar + * @return object[] + */ + deleteCompanyReturnSettings({ companyId, filingCalendarId, companyReturnSettingId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/filingcalendars/${filingCalendarId}/setting/${companyReturnSettingId}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a list of filed returns for the specified company in the year and month of a given filing period. + * * ### 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 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 * @param int endPeriodMonth The month of the period you are trying to retrieve @@ -4930,12 +5000,12 @@ export default class AvaTaxClient { * @param string country The country of the return(s) you are trying to retrieve * @param string region The region of the return(s) you are trying to retrieve * @param int filingCalendarId The filing calendar id of the return you are trying to retrieve - * @param string taxformCode The unique tax form code of the form. - * @return FetchResult - */ - getFiledReturns({ companyId, endPeriodMonth, endPeriodYear, frequency, status, country, region, filingCalendarId, taxformCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/filings/returns/filed`, + * @param string taxformCode The unique tax form code of the form. + * @return FetchResult + */ + getFiledReturns({ companyId, endPeriodMonth, endPeriodYear, frequency, status, country, region, filingCalendarId, taxformCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/filings/returns/filed`, parameters: { endPeriodMonth: endPeriodMonth, endPeriodYear: endPeriodYear, @@ -4946,34 +5016,34 @@ export default class AvaTaxClient { filingCalendarId: filingCalendarId, taxformCode: taxformCode } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Approves linkage to a firm for a client account - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Approves linkage to a firm for a client account + * * This API enables the account admin of a client account to approve linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * - * @param int id - * @return object - */ - approveFirmClientLinkage({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/${id}/approve`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Request a new FirmClient account and create an approved linkage to it - * + * @param int id + * @return object + */ + approveFirmClientLinkage({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/${id}/approve`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Request a new FirmClient account and create an approved linkage to it + * * This API is for use by Firms only. * * Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. @@ -4987,172 +5057,172 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. - * + * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. + * * - * @param object model Information about the account you wish to create. - * @return object - */ - createAndLinkNewFirmClientAccount({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/createandlinkclient`, + * @param object model Information about the account you wish to create. + * @return object + */ + createAndLinkNewFirmClientAccount({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/createandlinkclient`, parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Links a firm account with the client account - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Links a firm account with the client account + * * This API enables the firm admins/firm users to request the linkage of a firm account and a client account. * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * - * - * @param object model FirmClientLinkageInputModel - * @return object - */ - createFirmClientLinkage({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a linkage - * + * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * + * + * @param object model FirmClientLinkageInputModel + * @return object + */ + createFirmClientLinkage({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a linkage + * * This API marks a linkage between a firm and client as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * - * @param int id - * @return object[] - */ - deleteFirmClientLinkage({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Get linkage between a firm and client by id - * + * @param int id + * @return object[] + */ + deleteFirmClientLinkage({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Get linkage between a firm and client by id + * * This API enables the firm admins/firm users to request the linkage of a firm account and a client account. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * - * @param int id - * @return object - */ - getFirmClientLinkage({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List client linkages for a firm or client - * + * @param int id + * @return object + */ + getFirmClientLinkage({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List client linkages for a firm or client + * * This API enables the firm or account users to request the associated linkages to the account. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * - * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName - * @return FetchResult - */ - listFirmClientLinkage({ filter } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages`, + * @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:* firmAccountName, clientAccountName + * @return FetchResult + */ + listFirmClientLinkage({ filter } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages`, parameters: { $filter: filter } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Rejects linkage to a firm for a client account - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Rejects linkage to a firm for a client account + * * This API enables the account admin of a client account to reject linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * - * @param int id - * @return object - */ - rejectFirmClientLinkage({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/${id}/reject`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Reset linkage status between a client and firm back to requested - * + * @param int id + * @return object + */ + rejectFirmClientLinkage({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/${id}/reject`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Reset linkage status between a client and firm back to requested + * * This API enables the firm admin of a client account to reset a previously created linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * - * @param int id - * @return object - */ - resetFirmClientLinkage({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/${id}/reset`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Revokes previously approved linkage to a firm for a client account - * + * @param int id + * @return object + */ + resetFirmClientLinkage({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/${id}/reset`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Revokes previously approved linkage to a firm for a client account + * * This API enables the account admin of a client account to revoke a previously approved linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * - * @param int id - * @return object - */ - revokeFirmClientLinkage({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/firmclientlinkages/${id}/revoke`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * FREE API - Request a free trial of AvaTax - * + * @param int id + * @return object + */ + revokeFirmClientLinkage({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/firmclientlinkages/${id}/revoke`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * FREE API - Request a free trial of AvaTax + * * Call this API to obtain a free AvaTax account. * * This API is free to use. No authentication credentials are required to call this API. You must read and @@ -5166,23 +5236,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API may be called without providing authentication credentials. - * + * * This API may be called without providing authentication credentials. + * * - * @param object model Required information to provision a free trial account. - * @return object - */ - requestFreeTrial({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/freetrials/request`, + * @param object model Required information to provision a free trial account. + * @return object + */ + requestFreeTrial({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/freetrials/request`, parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * FREE API - Sales tax rates for a specified address - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * FREE API - Sales tax rates for a specified address + * * # Free-To-Use * * The TaxRates API is a free-to-use, no cost option for estimating sales tax rates. @@ -5207,8 +5277,8 @@ export default class AvaTaxClient { * * And more! * * Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) - * for information on how to upgrade to the full AvaTax CreateTransaction API. - * + * for information on how to upgrade to the full AvaTax CreateTransaction API. + * * * @param string line1 The street address of the location. * @param string line2 The street address of the location. @@ -5216,12 +5286,12 @@ export default class AvaTaxClient { * @param string city The city name of the location. * @param string region Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`. * @param string postalCode The postal code of the location. - * @param string country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`. - * @return object - */ - taxRatesByAddress({ line1, line2, line3, city, region, postalCode, country } = {}) { - var path = this.buildUrl({ - url: `/api/v2/taxrates/byaddress`, + * @param string country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`. + * @return object + */ + taxRatesByAddress({ line1, line2, line3, city, region, postalCode, country } = {}) { + var path = this.buildUrl({ + url: `/api/v2/taxrates/byaddress`, parameters: { line1: line1, line2: line2, @@ -5231,13 +5301,13 @@ export default class AvaTaxClient { postalCode: postalCode, country: country } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes. + * * # Free-To-Use * * This API is only available for a US postal codes. @@ -5264,27 +5334,27 @@ export default class AvaTaxClient { * * And more! * * Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) - * for information on how to upgrade to the full AvaTax CreateTransaction API. - * + * for information on how to upgrade to the full AvaTax CreateTransaction API. + * * * @param string country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`. - * @param string postalCode The postal code of the location. - * @return object - */ - taxRatesByPostalCode({ country, postalCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/taxrates/bypostalcode`, + * @param string postalCode The postal code of the location. + * @return object + */ + taxRatesByPostalCode({ country, postalCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/taxrates/bypostalcode`, parameters: { country: country, postalCode: postalCode } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Request the javascript for a funding setup widget - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Request the javascript for a funding setup widget + * * This API is available by invitation only. * Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are * required to setup their funding configuration before Avalara can begin filing tax returns on their @@ -5301,23 +5371,23 @@ 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. - * - * - * @param int id The unique ID number of this funding request - * @return object - */ - activateFundingRequest({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/fundingrequests/${id}/widget`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve status about a funding setup request - * + * * 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 + * @return object + */ + activateFundingRequest({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/fundingrequests/${id}/widget`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve status about a funding setup request + * * This API is available by invitation only. * Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are * required to setup their funding configuration before Avalara can begin filing tax returns on their @@ -5332,23 +5402,23 @@ 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. - * - * - * @param int id The unique ID number of this funding request - * @return object - */ - fundingRequestStatus({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/fundingrequests/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Delete all classifications for an item - * + * * 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 + * @return object + */ + fundingRequestStatus({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/fundingrequests/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Delete all classifications for an item + * * Delete all the classifications for a given item. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5357,24 +5427,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this item. - * @param int itemId The ID of the item you wish to delete the classifications. - * @return object[] - */ - batchDeleteItemClassifications({ companyId, itemId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/classifications`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete all parameters for an item - * + * @param int itemId The ID of the item you wish to delete the classifications. + * @return object[] + */ + batchDeleteItemClassifications({ companyId, itemId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/classifications`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Delete all parameters for an item + * * Delete all the parameters for a given item. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5385,24 +5455,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this item. - * @param int itemId The ID of the item you wish to delete the parameters. - * @return object[] - */ - batchDeleteItemParameters({ companyId, itemId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/parameters`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Add classifications to an item. - * + * @param int itemId The ID of the item you wish to delete the parameters. + * @return object[] + */ + batchDeleteItemParameters({ companyId, itemId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/parameters`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Add classifications to an item. + * * Add classifications to an item. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5413,25 +5483,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The company id. * @param int itemId The item id. - * @param object[] model The item classifications you wish to create. - * @return object[] - */ - createItemClassifications({ companyId, itemId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/classifications`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Add parameters to an item. - * + * @param object[] model The item classifications you wish to create. + * @return object[] + */ + createItemClassifications({ companyId, itemId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/classifications`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Add parameters to an item. + * * Add parameters to an item. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5446,25 +5516,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this item parameter. * @param int itemId The item id. - * @param object[] model The item parameters you wish to create. - * @return object[] - */ - createItemParameters({ companyId, itemId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/parameters`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a new item - * + * @param object[] model The item parameters you wish to create. + * @return object[] + */ + createItemParameters({ companyId, itemId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/parameters`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new item + * * Creates one or more new item objects attached to this company. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5477,24 +5547,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this item. - * @param object[] model The item you wish to create. - * @return object[] - */ - createItems({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single item - * + * @param object[] model The item you wish to create. + * @return object[] + */ + createItems({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single item + * * Deletes the item object at this URL. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5507,24 +5577,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this item. - * @param int id The ID of the item you wish to delete. - * @return object[] - */ - deleteItem({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete a single item classification. - * + * @param int id The ID of the item you wish to delete. + * @return object[] + */ + deleteItem({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Delete a single item classification. + * * Delete a single item classification. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5533,25 +5603,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The company id. * @param int itemId The item id. - * @param int id The item classification id. - * @return object[] - */ - deleteItemClassification({ companyId, itemId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/classifications/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete a single item parameter - * + * @param int id The item classification id. + * @return object[] + */ + deleteItemClassification({ companyId, itemId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/classifications/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Delete a single item parameter + * * Delete a single item parameter. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5562,25 +5632,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The company id * @param int itemId The item id - * @param int id The parameter id - * @return object[] - */ - deleteItemParameter({ companyId, itemId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/parameters/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single item - * + * @param int id The parameter id + * @return object[] + */ + deleteItemParameter({ companyId, itemId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/parameters/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single item + * * Get the `Item` object identified by this URL. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5591,27 +5661,27 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this item object * @param int id The primary key of this item - * @param string include A comma separated list of additional data to retrieve. - * @return object - */ - getItem({ companyId, id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${id}`, + * @param string include A comma separated list of additional data to retrieve. + * @return object + */ + getItem({ companyId, id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single item classification. - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single item classification. + * * Retrieve a single item classification. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5620,25 +5690,25 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The company id. * @param int itemId The item id. - * @param int id The item classification id. - * @return object - */ - getItemClassification({ companyId, itemId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/classifications/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single item parameter - * + * @param int id The item classification id. + * @return object + */ + getItemClassification({ companyId, itemId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/classifications/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single item parameter + * * Retrieve a single item parameter. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5649,25 +5719,25 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The company id * @param int itemId The item id - * @param int id The parameter id - * @return object - */ - getItemParameter({ companyId, itemId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/parameters/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve classifications for an item. - * + * @param int id The parameter id + * @return object + */ + getItemParameter({ companyId, itemId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/parameters/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve classifications for an item. + * * List classifications for an item. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5679,33 +5749,33 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The company id. * @param int itemId The item id. * @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:* productCode, systemCode * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listItemClassifications({ companyId, itemId, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/classifications`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listItemClassifications({ companyId, itemId, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/classifications`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve parameters for an item - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve parameters for an item + * * List parameters for an item. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5719,33 +5789,33 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The company id * @param int itemId The item id * @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:* name, unit * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listItemParameters({ companyId, itemId, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/parameters`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listItemParameters({ companyId, itemId, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/parameters`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve items for this company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve items for this company + * * List all items defined for the current company. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5765,20 +5835,20 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that defined these items * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, classifications, parameters * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listItemsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listItemsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items`, parameters: { $filter: filter, $include: include, @@ -5786,13 +5856,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all items - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all items + * * Get multiple item objects across all companies. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5807,19 +5877,19 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, classifications, parameters * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryItems({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/items`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryItems({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/items`, parameters: { $filter: filter, $include: include, @@ -5827,13 +5897,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Sync items from a product catalog - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Sync items from a product catalog + * * Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs * with AvaTax. * @@ -5849,24 +5919,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this item. - * @param object model The request object. - * @return object - */ - syncItems({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/sync`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Update a single item - * + * @param object model The request object. + * @return object + */ + syncItems({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/sync`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Update a single item + * * Replace the existing `Item` object at this URL with an updated object. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5882,25 +5952,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this item belongs to. * @param int id The ID of the item you wish to update - * @param object model The item object you wish to update. - * @return object - */ - updateItem({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Update an item classification. - * + * @param object model The item object you wish to update. + * @return object + */ + updateItem({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Update an item classification. + * * Update an item classification. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5911,26 +5981,26 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The company id. * @param int itemId The item id. * @param int id The item classification id. - * @param object model The item object you wish to update. - * @return object - */ - updateItemClassification({ companyId, itemId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/classifications/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Update an item parameter - * + * @param object model The item object you wish to update. + * @return object + */ + updateItemClassification({ companyId, itemId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/classifications/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Update an item parameter + * * Update an item parameter. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5941,26 +6011,26 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The company id. * @param int itemId The item id * @param int id The item parameter id - * @param object model The item object you wish to update. - * @return object - */ - updateItemParameter({ companyId, itemId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/items/${itemId}/parameters/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create one or more overrides - * + * @param object model The item object you wish to update. + * @return object + */ + updateItemParameter({ companyId, itemId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/items/${itemId}/parameters/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create one or more overrides + * * Creates one or more jurisdiction override objects for this account. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -5970,46 +6040,46 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int accountId The ID of the account that owns this override - * @param object[] model The jurisdiction override objects to create - * @return object[] - */ - createJurisdictionOverrides({ accountId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/jurisdictionoverrides`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single override - * + * @param object[] model The jurisdiction override objects to create + * @return object[] + */ + createJurisdictionOverrides({ accountId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/jurisdictionoverrides`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single override + * * Marks the item object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int accountId The ID of the account that owns this override - * @param int id The ID of the override you wish to delete - * @return object[] - */ - deleteJurisdictionOverride({ accountId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/jurisdictionoverrides/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single override - * + * @param int id The ID of the override you wish to delete + * @return object[] + */ + deleteJurisdictionOverride({ accountId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/jurisdictionoverrides/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single override + * * Get the item object identified by this URL. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6019,24 +6089,24 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int accountId The ID of the account that owns this override - * @param int id The primary key of this override - * @return object - */ - getJurisdictionOverride({ accountId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/jurisdictionoverrides/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve overrides for this account - * + * @param int id The primary key of this override + * @return object + */ + getJurisdictionOverride({ accountId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/jurisdictionoverrides/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve overrides for this account + * * List all jurisdiction override objects defined for this account. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6049,20 +6119,20 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int accountId The ID of the account that owns this override * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listJurisdictionOverridesByAccount({ accountId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/jurisdictionoverrides`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listJurisdictionOverridesByAccount({ accountId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/jurisdictionoverrides`, parameters: { $filter: filter, $include: include, @@ -6070,13 +6140,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all overrides - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all overrides + * * Get multiple jurisdiction override objects across all companies. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6089,19 +6159,19 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryJurisdictionOverrides({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/jurisdictionoverrides`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryJurisdictionOverrides({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/jurisdictionoverrides`, parameters: { $filter: filter, $include: include, @@ -6109,80 +6179,80 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single jurisdictionoverride - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single jurisdictionoverride + * * Replace the existing jurisdictionoverride object at this URL with an updated object. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int accountId The ID of the account that this jurisdictionoverride belongs to. * @param int id The ID of the jurisdictionoverride you wish to update - * @param object model The jurisdictionoverride object you wish to update. - * @return object - */ - updateJurisdictionOverride({ accountId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/jurisdictionoverrides/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create a new location - * + * @param object model The jurisdictionoverride object you wish to update. + * @return object + */ + updateJurisdictionOverride({ accountId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/jurisdictionoverrides/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create a new location + * * Create one or more new location objects attached to this company. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this location. - * @param object[] model The location you wish to create. - * @return object[] - */ - createLocations({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single location - * + * @param object[] model The location you wish to create. + * @return object[] + */ + createLocations({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single location + * * Mark the location object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this location. - * @param int id The ID of the location you wish to delete. - * @return object[] - */ - deleteLocation({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single location - * + * @param int id The ID of the location you wish to delete. + * @return object[] + */ + deleteLocation({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single location + * * Get the location object identified by this URL. * An 'Location' represents a physical address where a company does business. * Many taxing authorities require that you define a list of all locations where your company does business. @@ -6196,27 +6266,27 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company that owns this location * @param int id The primary key of this location - * @param string include A comma separated list of additional data to retrieve. - * @return object - */ - getLocation({ companyId, id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations/${id}`, + * @param string include A comma separated list of additional data to retrieve. + * @return object + */ + getLocation({ companyId, id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve locations for this company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve locations for this company + * * List all location objects defined for this company. * An 'Location' represents a physical address where a company does business. * Many taxing authorities require that you define a list of all locations where your company does business. @@ -6232,20 +6302,20 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company that owns these locations * @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 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listLocationsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listLocationsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations`, parameters: { $filter: filter, $include: include, @@ -6253,13 +6323,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all locations - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all locations + * * Get multiple location objects across all companies. * An 'Location' represents a physical address where a company does business. * Many taxing authorities require that you define a list of all locations where your company does business. @@ -6276,19 +6346,19 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* settings, 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryLocations({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/locations`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryLocations({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/locations`, parameters: { $filter: filter, $include: include, @@ -6296,62 +6366,62 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single location - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single location + * * Replace the existing location object at this URL with an updated object. * All data from the existing object will be replaced with data in the object you PUT. * To set a field's value to null, you may either set its value to null or omit that field from the object you post. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this location belongs to. * @param int id The ID of the location you wish to update - * @param object model The location you wish to update. - * @return object - */ - updateLocation({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Validate the location against local requirements - * + * @param object model The location you wish to update. + * @return object + */ + updateLocation({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Validate the location against local requirements + * * Returns validation information for this location. * This API call is intended to compare this location against the currently known taxing authority rules and regulations, * and provide information about what additional work is required to completely setup this location. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int companyId The ID of the company that owns this location - * @param int id The primary key of this location - * @return object - */ - validateLocation({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations/${id}/validate`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Adjust a MultiDocument transaction - * + * @param int id The primary key of this location + * @return object + */ + validateLocation({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations/${id}/validate`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Adjust a MultiDocument transaction + * * Adjusts the current MultiDocument transaction uniquely identified by this URL. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -6372,28 +6442,28 @@ 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 * @param string type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The adjust request you wish to execute - * @return object - */ - adjustMultiDocumentTransaction({ code, type, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/${code}/type/${type}/adjust`, + * @param object model The adjust request you wish to execute + * @return object + */ + adjustMultiDocumentTransaction({ code, type, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/${code}/type/${type}/adjust`, parameters: { include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Get audit information about a MultiDocument transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Get audit information about a MultiDocument transaction + * * Retrieve audit information about a MultiDocument transaction stored in AvaTax. * * The audit API retrieves audit information related to a specific MultiDocument transaction. This audit @@ -6418,24 +6488,24 @@ 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 - * @param string type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) - * @return object - */ - auditMultiDocumentTransaction({ code, type } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/${code}/type/${type}/audit`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Commit a MultiDocument transaction - * + * @param string type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) + * @return object + */ + auditMultiDocumentTransaction({ code, type } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/${code}/type/${type}/audit`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Commit a MultiDocument transaction + * * Marks a list of transactions by changing its status to `Committed`. * * Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. @@ -6454,23 +6524,23 @@ 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. - * - * - * @param object model The commit request you wish to execute - * @return object - */ - commitMultiDocumentTransaction({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/commit`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a new MultiDocument transaction - * + * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * + * + * @param object model The commit request you wish to execute + * @return object + */ + commitMultiDocumentTransaction({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/commit`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new MultiDocument transaction + * * Records a new MultiDocument transaction in AvaTax. * * A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can @@ -6513,26 +6583,26 @@ 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 - * @param object model the multi document transaction model - * @return object - */ - createMultiDocumentTransaction({ include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument`, + * @param object model the multi document transaction model + * @return object + */ + createMultiDocumentTransaction({ include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Retrieve a MultiDocument transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Retrieve a MultiDocument transaction + * * Get the current MultiDocument transaction identified by this URL. * * If this transaction was adjusted, the return value of this API will be the current transaction with this code. @@ -6555,27 +6625,27 @@ 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 include Specifies objects to include in the response after transaction is created - * @return object - */ - getMultiDocumentTransactionByCodeAndType({ code, type, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/${code}/type/${type}`, + * @param string include Specifies objects to include in the response after transaction is created + * @return object + */ + getMultiDocumentTransactionByCodeAndType({ code, type, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/${code}/type/${type}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a MultiDocument transaction by ID - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a MultiDocument transaction by ID + * * Get the unique MultiDocument transaction identified by this URL. * * A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can @@ -6607,26 +6677,26 @@ 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 - * @param string include Specifies objects to include in the response after transaction is created - * @return object - */ - getMultiDocumentTransactionById({ id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/${id}`, + * @param string include Specifies objects to include in the response after transaction is created + * @return object + */ + getMultiDocumentTransactionById({ id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all MultiDocument transactions - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all MultiDocument transactions + * * List all MultiDocument transactions within this account. * * This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument @@ -6656,19 +6726,19 @@ 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 * @param string include Specifies objects to include in the response after transaction is created * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listMultiDocumentTransactions({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listMultiDocumentTransactions({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument`, parameters: { $filter: filter, $include: include, @@ -6676,13 +6746,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create a refund for a MultiDocument transaction - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create a refund for a MultiDocument transaction + * * Create a refund for a MultiDocument transaction. * * A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can @@ -6729,28 +6799,28 @@ 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 * @param string type The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in the response after transaction is created - * @param object model Information about the refund to create - * @return object - */ - refundMultiDocumentTransaction({ code, type, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/${code}/type/${type}/refund`, + * @param object model Information about the refund to create + * @return object + */ + refundMultiDocumentTransaction({ code, type, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/${code}/type/${type}/refund`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Verify a MultiDocument transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Verify a MultiDocument transaction + * * Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values. * * If the transaction does not match these expected values, this API will return an error code indicating which value did not match. @@ -6767,23 +6837,23 @@ 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. - * - * - * @param object model Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax - * @return object - */ - verifyMultiDocumentTransaction({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/verify`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Void a MultiDocument transaction - * + * * 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 + * @return object + */ + verifyMultiDocumentTransaction({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/verify`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Void a MultiDocument transaction + * * Voids the current transaction uniquely identified by this URL. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -6803,25 +6873,25 @@ 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 * @param string type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) - * @param object model The void request you wish to execute - * @return object - */ - voidMultiDocumentTransaction({ code, type, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/multidocument/${code}/type/${type}/void`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a new nexus - * + * @param object model The void request you wish to execute + * @return object + */ + voidMultiDocumentTransaction({ code, type, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/multidocument/${code}/type/${type}/void`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new nexus + * * Creates one or more new nexus declarations attached to this company. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -6844,56 +6914,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this nexus. - * @param object[] model The nexus you wish to create. - * @return object[] - */ - createNexus({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Add parameters to a nexus. - * - * Add parameters to the nexus. - * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". - * - * A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. - * - * A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. - * - * To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus` - * - * Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. - * - * ### Security Policies - * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * - * - * @param int companyId The ID of the company that owns this nexus parameter. - * @param int nexusId The nexus id. - * @param object[] model The nexus parameters you wish to create. - * @return object[] - */ - createNexusParameters({ companyId, nexusId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${nexusId}/parameters`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Creates nexus for a list of addresses. - * + * @param object[] model The nexus you wish to create. + * @return object[] + */ + createNexus({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Creates nexus for a list of addresses. + * * This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this * API declares nexus for this company, for the list of addresses provided, * for the date range provided. You may also use this API to extend effective date on an already-declared nexus. @@ -6912,24 +6950,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that will own this nexus. - * @param object[] model The nexus you wish to create. - * @return object[] - */ - declareNexusByAddress({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/byaddress`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single nexus - * + * @param object[] model The nexus you wish to create. + * @return object[] + */ + declareNexusByAddress({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus/byaddress`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single nexus + * * Marks the existing nexus object at this URL as deleted. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -6941,82 +6979,27 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this nexus. * @param int id The ID of the nexus you wish to delete. - * @param boolean cascadeDelete If true, deletes all the child nexus if they exist along with parent nexus - * @return object[] - */ - deleteNexus({ companyId, id, cascadeDelete } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${id}`, + * @param boolean cascadeDelete If true, deletes all the child nexus if they exist along with parent nexus + * @return object[] + */ + deleteNexus({ companyId, id, cascadeDelete } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus/${id}`, parameters: { cascadeDelete: cascadeDelete } - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete a single nexus parameter - * - * Delete a single nexus parameter. - * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". - * - * A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. - * - * A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. - * - * ### Security Policies - * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * - * - * @param int companyId The company id - * @param int nexusId The nexus id - * @param int id The parameter id - * @return object[] - */ - deleteNexusParameter({ companyId, nexusId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${nexusId}/parameters/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete all parameters for an nexus - * - * Delete all the parameters for a given nexus. - * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". - * - * A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. - * - * A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. - * - * ### Security Policies - * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * - * - * @param int companyId The ID of the company that owns this nexus. - * @param int nexusId The ID of the nexus you wish to delete the parameters. - * @return object[] - */ - deleteNexusParameters({ companyId, nexusId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${nexusId}/parameters`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single nexus - * + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single nexus + * * Get the nexus object identified by this URL. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7028,27 +7011,27 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this nexus object * @param int id The primary key of this nexus - * @param string include - * @return object - */ - getNexus({ companyId, id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${id}`, + * @param string include + * @return object + */ + getNexus({ companyId, id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List company nexus related to a tax form - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List company nexus related to a tax form + * * Retrieves a list of nexus related to a tax form. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7064,55 +7047,27 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this nexus object * @param string formCode The form code that we are looking up the nexus for - * @param string include - * @return object - */ - getNexusByFormCode({ companyId, formCode, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/byform/${formCode}`, + * @param string include + * @return object + */ + getNexusByFormCode({ companyId, formCode, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus/byform/${formCode}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single nexus parameter - * - * Retrieve a single nexus parameter. - * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters". - * - * A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. - * - * A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. - * - * ### Security Policies - * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * - * - * @param int companyId The company id - * @param int nexusId The nexus id - * @param int id The parameter id - * @return object - */ - getNexusParameter({ companyId, nexusId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${nexusId}/parameters/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve nexus for this company - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve nexus for this company + * * List all nexus objects defined for this company. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7127,20 +7082,20 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns these nexus objects * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexusByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNexusByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus`, parameters: { $filter: filter, $include: include, @@ -7148,52 +7103,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve parameters for a nexus - * - * List parameters for a nexus. - * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". - * - * A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus. - * - * A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. - * - * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . - * Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. - * - * ### Security Policies - * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * - * - * @param int companyId The company id - * @param int nexusId The nexus id - * @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:* name, unit - * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. - * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNexusParameters({ companyId, nexusId, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${nexusId}/parameters`, - parameters: { - $filter: filter, - $top: top, - $skip: skip, - $orderBy: orderBy - } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all nexus - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all nexus + * * Get multiple nexus objects across all companies. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7208,19 +7124,19 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryNexus({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/nexus`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryNexus({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/nexus`, parameters: { $filter: filter, $include: include, @@ -7228,13 +7144,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single nexus - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single nexus + * * Replace the existing nexus declaration object at this URL with an updated object. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7257,55 +7173,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this nexus belongs to. * @param int id The ID of the nexus you wish to update - * @param object model The nexus object you wish to update. - * @return object - */ - updateNexus({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Update an nexus parameter - * - * Update an nexus parameter. - * - * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". - * - * A parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added. - * - * A parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this? - * - * ### Security Policies - * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * - * - * @param int companyId The company id. - * @param int nexusId The nexus id - * @param int id The nexus parameter id - * @param object model The nexus object you wish to update. - * @return object - */ - updateNexusParameter({ companyId, nexusId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/nexus/${nexusId}/parameters/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Mark a single notification as dismissed. - * + * @param object model The nexus object you wish to update. + * @return object + */ + updateNexus({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/nexus/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Mark a single notification as dismissed. + * * Marks the notification identified by this URL as dismissed. * * A notification is a message from Avalara that may have relevance to your business. You may want @@ -7323,23 +7209,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * - * @param int id The id of the notification you wish to mark as dismissed. - * @return object - */ - dismissNotification({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/notifications/${id}/dismiss`, + * @param int id The id of the notification you wish to mark as dismissed. + * @return object + */ + dismissNotification({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/notifications/${id}/dismiss`, parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: null }); - } - - /** - * Retrieve a single notification. - * + }); + return this.restCall({ url: path, verb: 'put', payload: null }); + } + + /** + * Retrieve a single notification. + * * Retrieve a single notification by its unique ID number. * * A notification is a message from Avalara that may have relevance to your business. You may want @@ -7351,23 +7237,23 @@ 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. - * - * - * @param int id The id of the notification to retrieve. - * @return object - */ - getNotification({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/notifications/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all notifications. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * + * + * @param int id The id of the notification to retrieve. + * @return object + */ + getNotification({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/notifications/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all notifications. + * * List all notifications. * * A notification is a message from Avalara that may have relevance to your business. You may want @@ -7382,31 +7268,31 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listNotifications({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/notifications`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listNotifications({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/notifications`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Request a new Avalara account - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Request a new Avalara account + * * This API is for use by partner provisioning services customers only. * * Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features @@ -7426,23 +7312,23 @@ export default class AvaTaxClient { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. - * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. - * - * - * @param object model Information about the account you wish to create and the selected product offerings. - * @return object - */ - requestNewAccount({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/request`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Request a new entitilement to an existing customer - * + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. + * + * + * @param object model Information about the account you wish to create and the selected product offerings. + * @return object + */ + requestNewAccount({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/request`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Request a new entitilement to an existing customer + * * This API is for use by partner provisioning services customers only. This will allow the partners to allow * the add new entitlement to an existing customer * @@ -7450,24 +7336,24 @@ export default class AvaTaxClient { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. - * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. - * + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. + * * * @param int id The avatax account id of the customer - * @param string offer The offer to be added to an already existing customer - * @return object - */ - requestNewEntitlement({ id, offer } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}/entitlements/${offer}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Create a new account - * + * @param string offer The offer to be added to an already existing customer + * @return object + */ + requestNewEntitlement({ id, offer } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}/entitlements/${offer}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Create a new account + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -7476,23 +7362,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * - * - * @param object model The account you wish to create. - * @return object[] - */ - createAccount({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create new notifications. - * + * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * + * + * @param object model The account you wish to create. + * @return object[] + */ + createAccount({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create new notifications. + * * This API is available by invitation only. * * Create a single notification. @@ -7510,23 +7396,23 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - * - * - * @param object[] model The notifications you wish to create. - * @return object[] - */ - createNotifications({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/notifications`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a new subscription - * + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. + * + * + * @param object[] model The notifications you wish to create. + * @return object[] + */ + createNotifications({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/notifications`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new subscription + * * This API is for use by Avalara Registrar administrative users only. * * Create one or more new subscription objects attached to this account. @@ -7535,24 +7421,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int accountId The ID of the account that owns this subscription. - * @param object[] model The subscription you wish to create. - * @return object[] - */ - createSubscriptions({ accountId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/subscriptions`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single account - * + * @param object[] model The subscription you wish to create. + * @return object[] + */ + createSubscriptions({ accountId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/subscriptions`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single account + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -7561,23 +7447,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires the user role SystemAdmin. - * + * * This API requires the user role SystemAdmin. + * * - * @param int id The ID of the account you wish to delete. - * @return object[] - */ - deleteAccount({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}`, + * @param int id The ID of the account you wish to delete. + * @return object[] + */ + deleteAccount({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}`, parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete a single notification. - * + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Delete a single notification. + * * This API is available by invitation only. * * Delete the existing notification identified by this URL. @@ -7592,23 +7478,23 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - * - * - * @param int id The id of the notification you wish to delete. - * @return object[] - */ - deleteNotification({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/notifications/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Delete a single subscription - * + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. + * + * + * @param int id The id of the notification you wish to delete. + * @return object[] + */ + deleteNotification({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/notifications/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Delete a single subscription + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -7616,24 +7502,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int accountId The ID of the account that owns this subscription. - * @param int id The ID of the subscription you wish to delete. - * @return object[] - */ - deleteSubscription({ accountId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/subscriptions/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Reset a user's password programmatically - * + * @param int id The ID of the subscription you wish to delete. + * @return object[] + */ + deleteSubscription({ accountId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/subscriptions/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Reset a user's password programmatically + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -7644,27 +7530,27 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API is available to Avalara system-level (registrar-level) users only. - * + * * This API is available to Avalara system-level (registrar-level) users only. + * * * @param int userId The unique ID of the user whose password will be changed * @param boolean unmigrateFromAi If user's password was migrated to AI, undo this. - * @param object model The new password for this user - * @return string - */ - resetPassword({ userId, unmigrateFromAi, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/passwords/${userId}/reset`, + * @param object model The new password for this user + * @return string + */ + resetPassword({ userId, unmigrateFromAi, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/passwords/${userId}/reset`, parameters: { unmigrateFromAi: unmigrateFromAi } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Update a single account - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Update a single account + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -7672,24 +7558,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int id The ID of the account you wish to update. - * @param object model The account object you wish to update. - * @return object - */ - updateAccount({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Update a single notification. - * + * @param object model The account object you wish to update. + * @return object + */ + updateAccount({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Update a single notification. + * * This API is available by invitation only. * * Replaces the notification identified by this URL with a new notification. @@ -7704,24 +7590,24 @@ export default class AvaTaxClient { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - * + * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. + * * * @param int id The id of the notification you wish to update. - * @param object model The notification object you wish to update. - * @return object - */ - updateNotification({ id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/notifications/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Update a single subscription - * + * @param object model The notification object you wish to update. + * @return object + */ + updateNotification({ id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/notifications/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Update a single subscription + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -7733,25 +7619,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int accountId The ID of the account that this subscription belongs to. * @param int id The ID of the subscription you wish to update - * @param object model The subscription you wish to update. - * @return object - */ - updateSubscription({ accountId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/subscriptions/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Download a report - * + * @param object model The subscription you wish to update. + * @return object + */ + updateSubscription({ accountId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/subscriptions/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Download a report + * * This API downloads the file associated with a report. * * If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete, @@ -7769,23 +7655,23 @@ 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. - * - * - * @param int id The unique ID number of this report - * @return object - */ - downloadReport({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/reports/${id}/attachment`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single report - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * + * + * @param int id The unique ID number of this report + * @return object + */ + downloadReport({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/reports/${id}/attachment`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single report + * * Retrieve a single report by its unique ID number. * * Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download @@ -7796,23 +7682,23 @@ export default class AvaTaxClient { * * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. * - * This API call returns information about any report type. - * - * - * @param int id The unique ID number of the report to retrieve - * @return object - */ - getReport({ id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/reports/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Initiate an ExportDocumentLine report task - * + * This API call returns information about any report type. + * + * + * @param int id The unique ID number of the report to retrieve + * @return object + */ + getReport({ id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/reports/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Initiate an ExportDocumentLine report task + * * Begins running an `ExportDocumentLine` report task and returns the identity of the report. * * Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download @@ -7827,24 +7713,24 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The unique ID number of the company to report on. - * @param object model Options that may be configured to customize the report. - * @return object[] - */ - initiateExportDocumentLineReport({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/reports/exportdocumentline/initiate`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * List all report tasks for account - * + * @param object model Options that may be configured to customize the report. + * @return object[] + */ + initiateExportDocumentLineReport({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/reports/exportdocumentline/initiate`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * List all report tasks for account + * * List all report tasks for your account. * * Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download @@ -7859,31 +7745,31 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The id of the company for which to get reports. * @param string pageKey Provide a page key to retrieve the next page of results. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @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. - * @return FetchResult - */ - listReports({ companyId, pageKey, skip, top } = {}) { - var path = this.buildUrl({ - url: `/api/v2/reports`, + * @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. + * @return FetchResult + */ + listReports({ companyId, pageKey, skip, top } = {}) { + var path = this.buildUrl({ + url: `/api/v2/reports`, parameters: { companyId: companyId, pageKey: pageKey, $skip: skip, $top: top } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create a new setting - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create a new setting + * * Create one or more new setting objects attached to this company. * * The company settings system is a metadata system that you can use to store extra information @@ -7897,24 +7783,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this setting. - * @param object[] model The setting you wish to create. - * @return object[] - */ - createSettings({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/settings`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single setting - * + * @param object[] model The setting you wish to create. + * @return object[] + */ + createSettings({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/settings`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single setting + * * Mark the setting object at this URL as deleted. * * The company settings system is a metadata system that you can use to store extra information @@ -7928,24 +7814,24 @@ 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 requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this setting. - * @param int id The ID of the setting you wish to delete. - * @return object[] - */ - deleteSetting({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/settings/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single setting - * + * @param int id The ID of the setting you wish to delete. + * @return object[] + */ + deleteSetting({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/settings/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single setting + * * Get a single setting object by its unique ID. * * The company settings system is a metadata system that you can use to store extra information @@ -7959,24 +7845,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this setting - * @param int id The primary key of this setting - * @return object - */ - getSetting({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/settings/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all settings for this company - * + * @param int id The primary key of this setting + * @return object + */ + getSetting({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/settings/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all settings for this company + * * List all setting objects attached to this company. * * The company settings system is a metadata system that you can use to store extra information @@ -7993,20 +7879,20 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns these settings * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param string include A comma separated list of 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listSettingsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/settings`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listSettingsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/settings`, parameters: { $filter: filter, $include: include, @@ -8014,13 +7900,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all settings - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all settings + * * Get multiple setting objects across all companies. * * The company settings system is a metadata system that you can use to store extra information @@ -8037,19 +7923,19 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - querySettings({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/settings`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + querySettings({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/settings`, parameters: { $filter: filter, $include: include, @@ -8057,13 +7943,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single setting - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single setting + * * Replace the existing setting object at this URL with an updated object. * * The company settings system is a metadata system that you can use to store extra information @@ -8081,49 +7967,49 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this setting belongs to. * @param int id The ID of the setting you wish to update - * @param object model The setting you wish to update. - * @return object - */ - updateSetting({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/settings/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Retrieve a single subscription - * + * @param object model The setting you wish to update. + * @return object + */ + updateSetting({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/settings/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Retrieve a single subscription + * * Get the subscription object identified by this URL. * A 'subscription' indicates a licensed subscription to a named Avalara service. * To request or remove subscriptions, please contact Avalara sales or your customer account manager. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int accountId The ID of the account that owns this subscription - * @param int id The primary key of this subscription - * @return object - */ - getSubscription({ accountId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/subscriptions/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve subscriptions for this account - * + * @param int id The primary key of this subscription + * @return object + */ + getSubscription({ accountId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/subscriptions/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve subscriptions for this account + * * List all subscription objects attached to this account. * A 'subscription' indicates a licensed subscription to a named Avalara service. * To request or remove subscriptions, please contact Avalara sales or your customer account manager. @@ -8133,32 +8019,32 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int accountId The ID of the account that owns these subscriptions * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listSubscriptionsByAccount({ accountId, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/subscriptions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listSubscriptionsByAccount({ accountId, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/subscriptions`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all subscriptions - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all subscriptions + * * Get multiple subscription objects across all accounts. * A 'subscription' indicates a licensed subscription to a named Avalara service. * To request or remove subscriptions, please contact Avalara sales or your customer account manager. @@ -8168,31 +8054,31 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - querySubscriptions({ filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/subscriptions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + querySubscriptions({ filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/subscriptions`, parameters: { $filter: filter, $top: top, $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create a new tax code - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create a new tax code + * * Create one or more new taxcode objects attached to this company. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -8201,46 +8087,46 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this tax code. - * @param object[] model The tax code you wish to create. - * @return object[] - */ - createTaxCodes({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxcodes`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single tax code - * + * @param object[] model The tax code you wish to create. + * @return object[] + */ + createTaxCodes({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxcodes`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single tax code + * * Marks the existing TaxCode object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this tax code. - * @param int id The ID of the tax code you wish to delete. - * @return object[] - */ - deleteTaxCode({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxcodes/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single tax code - * + * @param int id The ID of the tax code you wish to delete. + * @return object[] + */ + deleteTaxCode({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxcodes/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single tax code + * * Get the taxcode object identified by this URL. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -8249,24 +8135,24 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this tax code - * @param int id The primary key of this tax code - * @return object - */ - getTaxCode({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxcodes/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve tax codes for this company - * + * @param int id The primary key of this tax code + * @return object + */ + getTaxCode({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxcodes/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve tax codes for this company + * * List all taxcode objects attached to this company. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -8278,20 +8164,20 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns these tax codes * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param string include A comma separated list of 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxCodesByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxcodes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxCodesByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxcodes`, parameters: { $filter: filter, $include: include, @@ -8299,13 +8185,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all tax codes - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all tax codes + * * Get multiple taxcode objects across all companies. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -8317,19 +8203,19 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryTaxCodes({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/taxcodes`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryTaxCodes({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/taxcodes`, parameters: { $filter: filter, $include: include, @@ -8337,13 +8223,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single tax code - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single tax code + * * Replace the existing taxcode object at this URL with an updated object. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -8354,25 +8240,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this tax code belongs to. * @param int id The ID of the tax code you wish to update - * @param object model The tax code you wish to update. - * @return object - */ - updateTaxCode({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxcodes/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Build a multi-location tax content file - * + * @param object model The tax code you wish to update. + * @return object + */ + updateTaxCode({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxcodes/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Build a multi-location tax content file + * * Builds a tax content file containing information useful for a retail point-of-sale solution. * * Since tax rates may change based on decisions made by a variety of tax authorities, we recommend @@ -8400,23 +8286,23 @@ 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. - * - * - * @param object model Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include. - * @return object - */ - buildTaxContentFile({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/pointofsaledata/build`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Build a tax content file for a single location - * + * * 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. + * @return object + */ + buildTaxContentFile({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/pointofsaledata/build`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Build a tax content file for a single location + * * Builds a tax content file containing information useful for a retail point-of-sale solution. * * Since tax rates may change based on decisions made by a variety of tax authorities, we recommend @@ -8444,33 +8330,33 @@ 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. * @param int id The ID number of the location to retrieve point-of-sale data. * @param string date The date for which point-of-sale data would be calculated (today by default) * @param string format The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values) * @param string partnerId If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values) - * @param boolean includeJurisCodes When true, the file will include jurisdiction codes in the result. - * @return object - */ - buildTaxContentFileForLocation({ companyId, id, date, format, partnerId, includeJurisCodes } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/locations/${id}/pointofsaledata`, + * @param boolean includeJurisCodes When true, the file will include jurisdiction codes in the result. + * @return object + */ + buildTaxContentFileForLocation({ companyId, id, date, format, partnerId, includeJurisCodes } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/locations/${id}/pointofsaledata`, parameters: { date: date, format: format, partnerId: partnerId, includeJurisCodes: includeJurisCodes } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Download a file listing tax rates by postal code - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Download a file listing tax rates by postal code + * * Download a CSV file containing all five digit postal codes in the United States and their sales * and use tax rates for tangible personal property. * @@ -8514,26 +8400,26 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string date The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31 - * @param string region A two character region code which limits results to a specific region. - * @return object - */ - downloadTaxRatesByZipCode({ date, region } = {}) { - var path = this.buildUrl({ - url: `/api/v2/taxratesbyzipcode/download/${date}`, + * @param string region A two character region code which limits results to a specific region. + * @return object + */ + downloadTaxRatesByZipCode({ date, region } = {}) { + var path = this.buildUrl({ + url: `/api/v2/taxratesbyzipcode/download/${date}`, parameters: { region: region } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Create a new tax rule - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Create a new tax rule + * * Create one or more custom tax rules attached to this company. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -8550,24 +8436,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this tax rule. - * @param object[] model The tax rule you wish to create. - * @return object[] - */ - createTaxRules({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxrules`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single tax rule - * + * @param object[] model The tax rule you wish to create. + * @return object[] + */ + createTaxRules({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxrules`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single tax rule + * * Mark the custom tax rule identified by this URL as deleted. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -8584,24 +8470,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that owns this tax rule. - * @param int id The ID of the tax rule you wish to delete. - * @return object[] - */ - deleteTaxRule({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxrules/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single tax rule - * + * @param int id The ID of the tax rule you wish to delete. + * @return object[] + */ + deleteTaxRule({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxrules/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single tax rule + * * Get the taxrule object identified by this URL. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -8618,24 +8504,24 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns this tax rule - * @param int id The primary key of this tax rule - * @return object - */ - getTaxRule({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxrules/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve tax rules for this company - * + * @param int id The primary key of this tax rule + * @return object + */ + getTaxRule({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxrules/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve tax rules for this company + * * List all taxrule objects attached to this company. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -8655,20 +8541,20 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param int companyId The ID of the company that owns these tax rules * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, rateTypeCode, taxTypeGroup, taxSubType * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTaxRules({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxrules`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTaxRules({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxrules`, parameters: { $filter: filter, $include: include, @@ -8676,13 +8562,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all tax rules - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all tax rules + * * Get multiple taxrule objects across all companies. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -8702,19 +8588,19 @@ 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * * * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, rateTypeCode, taxTypeGroup, taxSubType * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryTaxRules({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/taxrules`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryTaxRules({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/taxrules`, parameters: { $filter: filter, $include: include, @@ -8722,13 +8608,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single tax rule - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single tax rule + * * Replace the existing custom tax rule object at this URL with an updated object. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -8745,25 +8631,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * * * @param int companyId The ID of the company that this tax rule belongs to. * @param int id The ID of the tax rule you wish to update - * @param object model The tax rule you wish to update. - * @return object - */ - updateTaxRule({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/taxrules/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Add lines to an existing unlocked transaction - * + * @param object model The tax rule you wish to update. + * @return object + */ + updateTaxRule({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/taxrules/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Add lines to an existing unlocked transaction + * * Add lines to an existing unlocked transaction. * * The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will @@ -8788,26 +8674,26 @@ 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 include Specifies objects to include in the response after transaction is created - * @param object model information about the transaction and lines to be added - * @return object - */ - addLines({ include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/transactions/lines/add`, + * @param object model information about the transaction and lines to be added + * @return object + */ + addLines({ include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/transactions/lines/add`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Correct a previously created transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Correct a previously created transaction + * * Replaces the current transaction uniquely identified by this URL with a new transaction. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -8839,30 +8725,30 @@ 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 companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to adjust * @param string documentType (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The adjustment you wish to make - * @return object - */ - adjustTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/adjust`, + * @param object model The adjustment you wish to make + * @return object + */ + adjustTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/adjust`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Get audit information about a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Get audit information about a transaction + * * Retrieve audit information about a transaction stored in AvaTax. * * The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit @@ -8888,24 +8774,24 @@ 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 companyCode The code identifying the company that owns this transaction - * @param string transactionCode The code identifying the transaction - * @return object - */ - auditTransaction({ companyCode, transactionCode } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/audit`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Get audit information about a transaction - * + * @param string transactionCode The code identifying the transaction + * @return object + */ + auditTransaction({ companyCode, transactionCode } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/audit`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Get audit information about a transaction + * * Retrieve audit information about a transaction stored in AvaTax. * * The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit @@ -8931,25 +8817,25 @@ 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 companyCode The code identifying the company that owns this transaction * @param string transactionCode The code identifying the transaction - * @param string documentType The document type of the original transaction (See DocumentType::* for a list of allowable values) - * @return object - */ - auditTransactionWithType({ companyCode, transactionCode, documentType } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/types/${documentType}/audit`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Lock a set of documents - * + * @param string documentType The document type of the original transaction (See DocumentType::* for a list of allowable values) + * @return object + */ + auditTransactionWithType({ companyCode, transactionCode, documentType } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/types/${documentType}/audit`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Lock a set of documents + * * This API is available by invitation only. * * Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once. @@ -8961,23 +8847,23 @@ 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. - * - * - * @param object model bulk lock request - * @return object - */ - bulkLockTransaction({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/lock`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Change a transaction's code - * + * * 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 + * @return object + */ + bulkLockTransaction({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/lock`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Change a transaction's code + * * Renames a transaction uniquely identified by this URL by changing its `code` value. * * This API is available as long as the transaction is in `saved` or `posted` status. When a transaction @@ -9009,30 +8895,30 @@ 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 string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to change * @param string documentType (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The code change request you wish to execute - * @return object - */ - changeTransactionCode({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/changecode`, + * @param object model The code change request you wish to execute + * @return object + */ + changeTransactionCode({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/changecode`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Commit a transaction for reporting - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Commit a transaction for reporting + * * Marks a transaction by changing its status to `Committed`. * * Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. @@ -9062,30 +8948,30 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. + * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to commit * @param string documentType (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The commit request you wish to execute - * @return object - */ - commitTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/commit`, + * @param object model The commit request you wish to execute + * @return object + */ + commitTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/commit`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create or adjust a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create or adjust a transaction + * * Records a new transaction or adjust an existing transaction in AvaTax. * * The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API @@ -9123,26 +9009,26 @@ 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 - * @param object model The transaction you wish to create or adjust - * @return object - */ - createOrAdjustTransaction({ include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/createoradjust`, + * @param object model The transaction you wish to create or adjust + * @return object + */ + createOrAdjustTransaction({ include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/createoradjust`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a new transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new transaction + * * Records a new transaction in AvaTax. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -9187,26 +9073,26 @@ 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 - * @param object model The transaction you wish to create - * @return object - */ - createTransaction({ include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/create`, + * @param object model The transaction you wish to create + * @return object + */ + createTransaction({ include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/create`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Remove lines from an existing unlocked transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Remove lines from an existing unlocked transaction + * * Remove lines to an existing unlocked transaction. * * The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will @@ -9228,26 +9114,26 @@ 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 include Specifies objects to include in the response after transaction is created - * @param object model information about the transaction and lines to be removed - * @return object - */ - deleteLines({ include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/transactions/lines/delete`, + * @param object model information about the transaction and lines to be removed + * @return object + */ + deleteLines({ include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/transactions/lines/delete`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Retrieve a single transaction by code - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Retrieve a single transaction by code + * * Get the current transaction identified by this company code, transaction code, and document type. * * A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`. @@ -9276,29 +9162,29 @@ 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 string transactionCode The transaction code to retrieve * @param string documentType (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values) - * @param string include Specifies objects to include in this fetch call - * @return object - */ - getTransactionByCode({ companyCode, transactionCode, documentType, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}`, + * @param string include Specifies objects to include in this fetch call + * @return object + */ + getTransactionByCode({ companyCode, transactionCode, documentType, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single transaction by code - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single transaction by code + * * DEPRECATED: Please use the `GetTransactionByCode` API instead. * * NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: @@ -9310,28 +9196,28 @@ 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 string transactionCode The transaction code to retrieve * @param string documentType The transaction type to retrieve (See DocumentType::* for a list of allowable values) - * @param string include Specifies objects to include in this fetch call - * @return object - */ - getTransactionByCodeAndType({ companyCode, transactionCode, documentType, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/types/${documentType}`, + * @param string include Specifies objects to include in this fetch call + * @return object + */ + getTransactionByCodeAndType({ companyCode, transactionCode, documentType, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/types/${documentType}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve a single transaction by ID - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve a single transaction by ID + * * Get the unique transaction identified by this URL. * * This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted @@ -9353,26 +9239,26 @@ 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 - * @param string include Specifies objects to include in this fetch call - * @return object - */ - getTransactionById({ id, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/transactions/${id}`, + * @param string include Specifies objects to include in this fetch call + * @return object + */ + getTransactionById({ id, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/transactions/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all transactions - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all transactions + * * List all transactions attached to this company. * * This endpoint is limited to returning 1,000 transactions at a time maximum. @@ -9404,8 +9290,8 @@ 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. @@ -9413,12 +9299,12 @@ export default class AvaTaxClient { * @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 int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listTransactionsByCompany({ companyCode, dataSourceId, include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listTransactionsByCompany({ companyCode, dataSourceId, include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions`, parameters: { dataSourceId: dataSourceId, $include: include, @@ -9427,13 +9313,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Lock a single transaction - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Lock a single transaction + * * 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. @@ -9465,30 +9351,30 @@ 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 * @param string transactionCode The transaction code to lock * @param string documentType (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The lock request you wish to execute - * @return object - */ - lockTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/lock`, + * @param object model The lock request you wish to execute + * @return object + */ + lockTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/lock`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a refund for a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a refund for a transaction + * * Create a refund for a transaction. * * The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund @@ -9530,32 +9416,32 @@ 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 companyCode The code of the company that made the original sale * @param string transactionCode The transaction code of the original sale * @param string include Specifies objects to include in the response after transaction is created * @param string documentType (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param boolean useTaxDateOverride (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states). - * @param object model Information about the refund to create - * @return object - */ - refundTransaction({ companyCode, transactionCode, include, documentType, useTaxDateOverride, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/refund`, + * @param object model Information about the refund to create + * @return object + */ + refundTransaction({ companyCode, transactionCode, include, documentType, useTaxDateOverride, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/refund`, parameters: { $include: include, documentType: documentType, useTaxDateOverride: useTaxDateOverride } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Perform multiple actions on a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Perform multiple actions on a transaction + * * Performs one or more actions against the current transaction uniquely identified by this URL. * * The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`. @@ -9585,30 +9471,30 @@ 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 requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. + * * * @param string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to settle * @param string documentType (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The data from an external system to reconcile against AvaTax - * @return object - */ - settleTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/settle`, + * @param object model The data from an external system to reconcile against AvaTax + * @return object + */ + settleTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/settle`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Uncommit a transaction for reporting - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Uncommit a transaction for reporting + * * Adjusts a transaction by changing it to an uncommitted status. * * Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are @@ -9633,29 +9519,29 @@ 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 companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to Uncommit * @param string documentType (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) - * @param string include Specifies objects to include in this fetch call - * @return object - */ - uncommitTransaction({ companyCode, transactionCode, documentType, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/uncommit`, + * @param string include Specifies objects to include in this fetch call + * @return object + */ + uncommitTransaction({ companyCode, transactionCode, documentType, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/uncommit`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Unvoids a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Unvoids a transaction + * * Unvoids a voided transaction * * You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: @@ -9677,29 +9563,29 @@ 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 companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to commit * @param string documentType (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) - * @param string include Specifies objects to include in this fetch call - * @return object - */ - unvoidTransaction({ companyCode, transactionCode, documentType, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/unvoid`, + * @param string include Specifies objects to include in this fetch call + * @return object + */ + unvoidTransaction({ companyCode, transactionCode, documentType, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/unvoid`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: null }); - } - - /** - * Verify a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: null }); + } + + /** + * Verify a transaction + * * Verifies that the transaction uniquely identified by this URL matches certain expected values. * * If the transaction does not match these expected values, this API will return an error code indicating which value did not match. @@ -9728,30 +9614,30 @@ 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 string companyCode The company code of the company that recorded this transaction * @param string transactionCode The transaction code to settle * @param string documentType (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The data from an external system to reconcile against AvaTax - * @return object - */ - verifyTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/verify`, + * @param object model The data from an external system to reconcile against AvaTax + * @return object + */ + verifyTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/verify`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Void a transaction - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Void a transaction + * * Voids the current transaction uniquely identified by this URL. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -9782,101 +9668,101 @@ 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 * @param string transactionCode The transaction code to void * @param string documentType (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string include Specifies objects to include in this fetch call - * @param object model The void request you wish to execute. To void a transaction the code must be set to 'DocVoided' - * @return object - */ - voidTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/void`, + * @param object model The void request you wish to execute. To void a transaction the code must be set to 'DocVoided' + * @return object + */ + voidTransaction({ companyCode, transactionCode, documentType, include, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyCode}/transactions/${transactionCode}/void`, parameters: { documentType: documentType, $include: include } - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Create a new UPC - * + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Create a new UPC + * * Create one or more new UPC objects attached to this company. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaUpc. - * + * * This API depends on the following active services
*Required* (all): AvaUpc. + * * * @param int companyId The ID of the company that owns this UPC. - * @param object[] model The UPC you wish to create. - * @return object[] - */ - createUPCs({ companyId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/upcs`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single UPC - * + * @param object[] model The UPC you wish to create. + * @return object[] + */ + createUPCs({ companyId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/upcs`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single UPC + * * Marks the UPC object identified by this URL as deleted. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaUpc. - * + * * This API depends on the following active services
*Required* (all): AvaUpc. + * * * @param int companyId The ID of the company that owns this UPC. - * @param int id The ID of the UPC you wish to delete. - * @return object[] - */ - deleteUPC({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/upcs/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single UPC - * + * @param int id The ID of the UPC you wish to delete. + * @return object[] + */ + deleteUPC({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/upcs/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single UPC + * * Get the UPC object identified by this URL. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaUpc. - * + * * This API depends on the following active services
*Required* (all): AvaUpc. + * * * @param int companyId The ID of the company that owns this UPC - * @param int id The primary key of this UPC - * @return object - */ - getUPC({ companyId, id } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/upcs/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve UPCs for this company - * + * @param int id The primary key of this UPC + * @return object + */ + getUPC({ companyId, id } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/upcs/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve UPCs for this company + * * List all UPC objects attached to this company. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * @@ -9886,20 +9772,20 @@ 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 * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param string include A comma separated list of 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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listUPCsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/upcs`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listUPCsByCompany({ companyId, filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/upcs`, parameters: { $filter: filter, $include: include, @@ -9907,13 +9793,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all UPCs - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all UPCs + * * Get multiple UPC objects across all companies. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * @@ -9923,19 +9809,19 @@ 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/). * @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. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryUPCs({ filter, include, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/upcs`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryUPCs({ filter, include, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/upcs`, parameters: { $filter: filter, $include: include, @@ -9943,13 +9829,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single UPC - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single UPC + * * Replace the existing UPC object at this URL with an updated object. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * All data from the existing object will be replaced with data in the object you PUT. @@ -9958,25 +9844,25 @@ 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. * @param int id The ID of the UPC you wish to update - * @param object model The UPC you wish to update. - * @return object - */ - updateUPC({ companyId, id, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/companies/${companyId}/upcs/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Change Password - * + * @param object model The UPC you wish to update. + * @return object + */ + updateUPC({ companyId, id, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/companies/${companyId}/upcs/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Change Password + * * Allows a user to change their password via an API call. * * This API allows an authenticated user to change their password via an API call. This feature is only available @@ -9987,23 +9873,23 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * - * - * @param object model An object containing your current password and the new password. - * @return string - */ - changePassword({ model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/passwords`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Create new users - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * + * + * @param object model An object containing your current password and the new password. + * @return string + */ + changePassword({ model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/passwords`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Create new users + * * Create one or more new user objects attached to this account. * * A user represents one person with access privileges to make API calls and work with a specific account. @@ -10016,24 +9902,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int accountId The unique ID number of the account where these users will be created. - * @param object[] model The user or array of users you wish to create. - * @return object[] - */ - createUsers({ accountId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/users`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'post', payload: model }); - } - - /** - * Delete a single user - * + * @param object[] model The user or array of users you wish to create. + * @return object[] + */ + createUsers({ accountId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/users`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'post', payload: model }); + } + + /** + * Delete a single user + * * Mark the user object identified by this URL as deleted. * * This API is available for use by account and company administrators only. @@ -10043,24 +9929,24 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. - * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. + * * * @param int id The ID of the user you wish to delete. - * @param int accountId The accountID of the user you wish to delete. - * @return object[] - */ - deleteUser({ id, accountId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/users/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'delete', payload: null }); - } - - /** - * Retrieve a single user - * + * @param int accountId The accountID of the user you wish to delete. + * @return object[] + */ + deleteUser({ id, accountId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/users/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'delete', payload: null }); + } + + /** + * Retrieve a single user + * * Get the user object identified by this URL. * A user represents one person with access privileges to make API calls and work with a specific account. * @@ -10070,27 +9956,27 @@ 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the user to retrieve. * @param int accountId The accountID of the user you wish to get. - * @param string include Optional fetch commands. - * @return object - */ - getUser({ id, accountId, include } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/users/${id}`, + * @param string include Optional fetch commands. + * @return object + */ + getUser({ id, accountId, include } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/users/${id}`, parameters: { $include: include } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all entitlements for a single user - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all entitlements for a single user + * * Return a list of all entitlements to which this user has rights to access. * Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is * allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use. @@ -10109,24 +9995,24 @@ 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the user to retrieve. - * @param int accountId The accountID of the user you wish to get. - * @return object - */ - getUserEntitlements({ id, accountId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/users/${id}/entitlements`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve users for this account - * + * @param int accountId The accountID of the user you wish to get. + * @return object + */ + getUserEntitlements({ id, accountId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/users/${id}/entitlements`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve users for this account + * * List all user objects attached to this account. * A user represents one person with access privileges to make API calls and work with a specific account. * @@ -10142,20 +10028,20 @@ 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int accountId The accountID of the user you wish to list. * @param string include Optional fetch commands. * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - listUsersByAccount({ accountId, include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/users`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + listUsersByAccount({ accountId, include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/users`, parameters: { $include: include, $filter: filter, @@ -10163,13 +10049,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Retrieve all users - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Retrieve all users + * * Get multiple user objects across all accounts. * * A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated @@ -10187,19 +10073,19 @@ 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param string include Optional fetch commands. * @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return FetchResult - */ - queryUsers({ include, filter, top, skip, orderBy } = {}) { - var path = this.buildUrl({ - url: `/api/v2/users`, + * @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return FetchResult + */ + queryUsers({ include, filter, top, skip, orderBy } = {}) { + var path = this.buildUrl({ + url: `/api/v2/users`, parameters: { $include: include, $filter: filter, @@ -10207,13 +10093,13 @@ export default class AvaTaxClient { $skip: skip, $orderBy: orderBy } - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Update a single user - * + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Update a single user + * * Replace the existing user object at this URL with an updated object. * A user represents one person with access privileges to make API calls and work with a specific account. * All data from the existing object will be replaced with data in the object you PUT. @@ -10221,25 +10107,25 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * * @param int id The ID of the user you wish to update. * @param int accountId The accountID of the user you wish to update. - * @param object model The user object you wish to update. - * @return object - */ - updateUser({ id, accountId, model } = {}) { - var path = this.buildUrl({ - url: `/api/v2/accounts/${accountId}/users/${id}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'put', payload: model }); - } - - /** - * Checks if the current user is subscribed to a specific service - * + * @param object model The user object you wish to update. + * @return object + */ + updateUser({ id, accountId, model } = {}) { + var path = this.buildUrl({ + url: `/api/v2/accounts/${accountId}/users/${id}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'put', payload: model }); + } + + /** + * Checks if the current user is subscribed to a specific service + * * Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account. * * This API will return an error if it is called with invalid authentication credentials. @@ -10247,23 +10133,23 @@ export default class AvaTaxClient { * This API is intended to help you determine whether you have the necessary subscription to use certain API calls * within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product * or subscription to provide useful information to the current user as to whether they are entitled to use - * specific features of AvaTax. - * - * - * @param string serviceTypeId The service to check - * @return object - */ - getMySubscription({ serviceTypeId } = {}) { - var path = this.buildUrl({ - url: `/api/v2/utilities/subscriptions/${serviceTypeId}`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * List all services to which the current user is subscribed - * + * specific features of AvaTax. + * + * + * @param string serviceTypeId The service to check + * @return object + */ + getMySubscription({ serviceTypeId } = {}) { + var path = this.buildUrl({ + url: `/api/v2/utilities/subscriptions/${serviceTypeId}`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * List all services to which the current user is subscribed + * * Returns the list of all subscriptions enabled for the currently logged in user. * * This API will return an error if it is called with invalid authentication credentials. @@ -10271,22 +10157,22 @@ export default class AvaTaxClient { * This API is intended to help you determine whether you have the necessary subscription to use certain API calls * within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product * or subscription to provide useful information to the current user as to whether they are entitled to use - * specific features of AvaTax. - * - * - * @return FetchResult - */ - listMySubscriptions({ } = {}) { - var path = this.buildUrl({ - url: `/api/v2/utilities/subscriptions`, - parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } - - /** - * Tests connectivity and version of the service - * + * specific features of AvaTax. + * + * + * @return FetchResult + */ + listMySubscriptions({ } = {}) { + var path = this.buildUrl({ + url: `/api/v2/utilities/subscriptions`, + parameters: {} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } + + /** + * Tests connectivity and version of the service + * * Check connectivity to AvaTax and return information about the AvaTax API server. * * This API is intended to help you verify that your connection is working. This API will always succeed and will @@ -10306,16 +10192,16 @@ export default class AvaTaxClient { * * ### Security Policies * - * * This API may be called without providing authentication credentials. - * - * - * @return object - */ - ping({ } = {}) { - var path = this.buildUrl({ - url: `/api/v2/utilities/ping`, + * * This API may be called without providing authentication credentials. + * + * + * @return object + */ + ping({ } = {}) { + var path = this.buildUrl({ + url: `/api/v2/utilities/ping`, parameters: {} - }); - return this.restCall({ url: path, verb: 'get', payload: null }); - } -} + }); + return this.restCall({ url: path, verb: 'get', payload: null }); + } +} diff --git a/package-lock.json b/package-lock.json index dffec544..837fdcc1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "avatax", - "version": "19.4.1", + "version": "20.6.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -140,7 +140,8 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz", "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=", - "dev": true + "dev": true, + "optional": true }, "array-equal": { "version": "1.0.0", @@ -185,7 +186,8 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz", "integrity": "sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c=", - "dev": true + "dev": true, + "optional": true }, "async": { "version": "2.6.1", @@ -213,7 +215,8 @@ "version": "2.1.2", "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.2.tgz", "integrity": "sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg==", - "dev": true + "dev": true, + "optional": true }, "aws-sign2": { "version": "0.7.0", @@ -866,6 +869,7 @@ "resolved": "https://registry.npmjs.org/base/-/base-0.11.2.tgz", "integrity": "sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg==", "dev": true, + "optional": true, "requires": { "cache-base": "^1.0.1", "class-utils": "^0.3.5", @@ -881,6 +885,7 @@ "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", "dev": true, + "optional": true, "requires": { "is-descriptor": "^1.0.0" } @@ -890,6 +895,7 @@ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", "dev": true, + "optional": true, "requires": { "kind-of": "^6.0.0" } @@ -899,6 +905,7 @@ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", "dev": true, + "optional": true, "requires": { "kind-of": "^6.0.0" } @@ -908,6 +915,7 @@ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", "dev": true, + "optional": true, "requires": { "is-accessor-descriptor": "^1.0.0", "is-data-descriptor": "^1.0.0", @@ -918,13 +926,15 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true }, "kind-of": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==", - "dev": true + "dev": true, + "optional": true } } }, @@ -1008,6 +1018,7 @@ "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", "integrity": "sha512-AKcdTnFSWATd5/GCPRxr2ChwIJ85CeyrEyjRHlKxQ56d4XJMGym0uAiKn0xbLOGOl3+yRpOTi484dVCEc5AUzQ==", "dev": true, + "optional": true, "requires": { "collection-visit": "^1.0.0", "component-emitter": "^1.2.1", @@ -1024,7 +1035,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -1139,6 +1151,7 @@ "resolved": "https://registry.npmjs.org/class-utils/-/class-utils-0.3.6.tgz", "integrity": "sha512-qOhPa/Fj7s6TY8H8esGu5QNpMMQxz79h+urzrNYN6mn+9BnxlDGf5QZ+XeCDsxSjPqsSR56XOZOJmpeurnLMeg==", "dev": true, + "optional": true, "requires": { "arr-union": "^3.1.0", "define-property": "^0.2.5", @@ -1151,6 +1164,7 @@ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, + "optional": true, "requires": { "is-descriptor": "^0.1.0" } @@ -1159,7 +1173,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -1247,6 +1262,7 @@ "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz", "integrity": "sha1-S8A3PBZLwykbTTaMgpzxqApZ3KA=", "dev": true, + "optional": true, "requires": { "map-visit": "^1.0.0", "object-visit": "^1.0.0" @@ -1292,7 +1308,8 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", "integrity": "sha1-E3kY1teCg/ffemt8WmPhQOaUJeY=", - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", @@ -1331,7 +1348,8 @@ "version": "0.1.1", "resolved": "https://registry.npmjs.org/copy-descriptor/-/copy-descriptor-0.1.1.tgz", "integrity": "sha1-Z29us8OZl8LuGsOpJP1hJHSPV40=", - "dev": true + "dev": true, + "optional": true }, "core-js": { "version": "2.6.3", @@ -1399,7 +1417,8 @@ "version": "0.2.0", "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz", "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=", - "dev": true + "dev": true, + "optional": true }, "deep-eql": { "version": "3.0.1", @@ -1436,6 +1455,7 @@ "resolved": "https://registry.npmjs.org/define-property/-/define-property-2.0.2.tgz", "integrity": "sha512-jwK2UV4cnPpbcG7+VRARKTZPUWowwXA8bzH5NP6ud0oeAxyYPuGZUAC7hMugpCdz4BeSZl2Dl9k66CHJ/46ZYQ==", "dev": true, + "optional": true, "requires": { "is-descriptor": "^1.0.2", "isobject": "^3.0.1" @@ -1446,6 +1466,7 @@ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", "dev": true, + "optional": true, "requires": { "kind-of": "^6.0.0" } @@ -1455,6 +1476,7 @@ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", "dev": true, + "optional": true, "requires": { "kind-of": "^6.0.0" } @@ -1464,6 +1486,7 @@ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", "dev": true, + "optional": true, "requires": { "is-accessor-descriptor": "^1.0.0", "is-data-descriptor": "^1.0.0", @@ -1474,13 +1497,15 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true }, "kind-of": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==", - "dev": true + "dev": true, + "optional": true } } }, @@ -1797,6 +1822,7 @@ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-3.0.2.tgz", "integrity": "sha1-Jqcarwc7OfshJxcnRhMcJwQCjbg=", "dev": true, + "optional": true, "requires": { "assign-symbols": "^1.0.0", "is-extendable": "^1.0.1" @@ -1807,6 +1833,7 @@ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", "dev": true, + "optional": true, "requires": { "is-plain-object": "^2.0.4" } @@ -1973,6 +2000,7 @@ "resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz", "integrity": "sha1-QpD60n8T6Jvn8zeZxrxaCr//DRk=", "dev": true, + "optional": true, "requires": { "map-cache": "^0.2.2" } @@ -2009,7 +2037,8 @@ "ansi-regex": { "version": "2.1.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "aproba": { "version": "1.2.0", @@ -2030,12 +2059,14 @@ "balanced-match": { "version": "1.0.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -2050,17 +2081,20 @@ "code-point-at": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -2177,7 +2211,8 @@ "inherits": { "version": "2.0.3", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -2189,6 +2224,7 @@ "version": "1.0.0", "bundled": true, "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -2203,6 +2239,7 @@ "version": "3.0.4", "bundled": true, "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -2210,12 +2247,14 @@ "minimist": { "version": "0.0.8", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.3.5", "bundled": true, "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.2", "yallist": "^3.0.0" @@ -2234,6 +2273,7 @@ "version": "0.5.1", "bundled": true, "dev": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -2314,7 +2354,8 @@ "number-is-nan": { "version": "1.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -2326,6 +2367,7 @@ "version": "1.4.0", "bundled": true, "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -2411,7 +2453,8 @@ "safe-buffer": { "version": "5.1.2", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "safer-buffer": { "version": "2.1.2", @@ -2447,6 +2490,7 @@ "version": "1.0.2", "bundled": true, "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", @@ -2466,6 +2510,7 @@ "version": "3.0.1", "bundled": true, "dev": true, + "optional": true, "requires": { "ansi-regex": "^2.0.0" } @@ -2509,12 +2554,14 @@ "wrappy": { "version": "1.0.2", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "yallist": { "version": "3.0.3", "bundled": true, - "dev": true + "dev": true, + "optional": true } } }, @@ -2540,7 +2587,8 @@ "version": "2.0.6", "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=", - "dev": true + "dev": true, + "optional": true }, "getpass": { "version": "0.1.7", @@ -2684,6 +2732,7 @@ "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz", "integrity": "sha1-GLKB2lhbHFxR3vJMkw7SmgvmsXc=", "dev": true, + "optional": true, "requires": { "get-value": "^2.0.6", "has-values": "^1.0.0", @@ -2694,7 +2743,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -2703,6 +2753,7 @@ "resolved": "https://registry.npmjs.org/has-values/-/has-values-1.0.0.tgz", "integrity": "sha1-lbC2P+whRmGab+V/51Yo1aOe/k8=", "dev": true, + "optional": true, "requires": { "is-number": "^3.0.0", "kind-of": "^4.0.0" @@ -2713,6 +2764,7 @@ "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz", "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=", "dev": true, + "optional": true, "requires": { "kind-of": "^3.0.2" }, @@ -2722,6 +2774,7 @@ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", "dev": true, + "optional": true, "requires": { "is-buffer": "^1.1.5" } @@ -2733,6 +2786,7 @@ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-4.0.0.tgz", "integrity": "sha1-IIE989cSkosgc3hpGkUGb65y3Vc=", "dev": true, + "optional": true, "requires": { "is-buffer": "^1.1.5" } @@ -2899,6 +2953,7 @@ "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-0.1.6.tgz", "integrity": "sha1-qeEss66Nh2cn7u84Q/igiXtcmNY=", "dev": true, + "optional": true, "requires": { "kind-of": "^3.0.2" } @@ -2948,6 +3003,7 @@ "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz", "integrity": "sha1-C17mSDiOLIYCgueT8YVv7D8wG1Y=", "dev": true, + "optional": true, "requires": { "kind-of": "^3.0.2" } @@ -2957,6 +3013,7 @@ "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.6.tgz", "integrity": "sha512-avDYr0SB3DwO9zsMov0gKCESFYqCnE4hq/4z3TdUlukEy5t9C0YRq7HLrsN52NAcqXKaepeCD0n+B0arnVG3Hg==", "dev": true, + "optional": true, "requires": { "is-accessor-descriptor": "^0.1.6", "is-data-descriptor": "^0.1.4", @@ -2967,7 +3024,8 @@ "version": "5.1.0", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-5.1.0.tgz", "integrity": "sha512-NGEErnH6F2vUuXDh+OlbcKW7/wOcfdRHaZ7VWtqCztfHri/++YKmP51OdWeGPuqCOba6kk2OTe5d02VmTB80Pw==", - "dev": true + "dev": true, + "optional": true } } }, @@ -3036,6 +3094,7 @@ "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", "dev": true, + "optional": true, "requires": { "isobject": "^3.0.1" }, @@ -3044,7 +3103,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -3794,13 +3854,15 @@ "version": "0.2.2", "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", "integrity": "sha1-wyq9C9ZSXZsFFkW7TyasXcmKDb8=", - "dev": true + "dev": true, + "optional": true }, "map-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", "integrity": "sha1-7Nyo8TFE5mDxtb1B8S80edmN+48=", "dev": true, + "optional": true, "requires": { "object-visit": "^1.0.0" } @@ -3930,6 +3992,7 @@ "resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.1.tgz", "integrity": "sha512-8ZItLHeEgaqEvd5lYBXfm4EZSFCX29Jb9K+lAHhDKzReKBQKj3R+7NOF6tjqYi9t4oI8VUfaWITJQm86wnXGNQ==", "dev": true, + "optional": true, "requires": { "for-in": "^1.0.2", "is-extendable": "^1.0.1" @@ -3940,6 +4003,7 @@ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", "dev": true, + "optional": true, "requires": { "is-plain-object": "^2.0.4" } @@ -4166,6 +4230,7 @@ "resolved": "https://registry.npmjs.org/object-copy/-/object-copy-0.1.0.tgz", "integrity": "sha1-fn2Fi3gb18mRpBupde04EnVOmYw=", "dev": true, + "optional": true, "requires": { "copy-descriptor": "^0.1.0", "define-property": "^0.2.5", @@ -4177,6 +4242,7 @@ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, + "optional": true, "requires": { "is-descriptor": "^0.1.0" } @@ -4188,6 +4254,7 @@ "resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz", "integrity": "sha1-95xEk68MU3e1n+OdOV5BBC3QRbs=", "dev": true, + "optional": true, "requires": { "isobject": "^3.0.0" }, @@ -4196,7 +4263,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -4215,6 +4283,7 @@ "resolved": "https://registry.npmjs.org/object.pick/-/object.pick-1.3.0.tgz", "integrity": "sha1-h6EKxMFpS9Lhy/U1kaZhQftd10c=", "dev": true, + "optional": true, "requires": { "isobject": "^3.0.1" }, @@ -4223,7 +4292,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -4340,7 +4410,8 @@ "version": "0.1.1", "resolved": "https://registry.npmjs.org/pascalcase/-/pascalcase-0.1.1.tgz", "integrity": "sha1-s2PlXoAGym/iF4TS2yK9FdeRfxQ=", - "dev": true + "dev": true, + "optional": true }, "path-exists": { "version": "2.1.0", @@ -4591,7 +4662,8 @@ "version": "0.3.2", "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", "integrity": "sha1-qJS3XUvE9s1nnvMkSp/Y9Gri1Cg=", - "dev": true + "dev": true, + "optional": true }, "braces": { "version": "2.3.2", @@ -4854,7 +4926,8 @@ "version": "6.0.2", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==", - "dev": true + "dev": true, + "optional": true }, "micromatch": { "version": "3.1.10", @@ -4926,6 +4999,7 @@ "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz", "integrity": "sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==", "dev": true, + "optional": true, "requires": { "extend-shallow": "^3.0.2", "safe-regex": "^1.1.0" @@ -5091,7 +5165,8 @@ "version": "0.2.1", "resolved": "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz", "integrity": "sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo=", - "dev": true + "dev": true, + "optional": true }, "restore-cursor": { "version": "2.0.0", @@ -5107,7 +5182,8 @@ "version": "0.1.15", "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz", "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", - "dev": true + "dev": true, + "optional": true }, "rimraf": { "version": "2.6.3", @@ -5153,6 +5229,7 @@ "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz", "integrity": "sha1-QKNmnzsHfR6UPURinhV91IAjvy4=", "dev": true, + "optional": true, "requires": { "ret": "~0.1.10" } @@ -5207,6 +5284,7 @@ "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.0.tgz", "integrity": "sha512-hw0yxk9GT/Hr5yJEYnHNKYXkIA8mVJgd9ditYZCe16ZczcaELYYcfvaXesNACk2O8O0nTiPQcQhGUQj8JLzeeg==", "dev": true, + "optional": true, "requires": { "extend-shallow": "^2.0.1", "is-extendable": "^0.1.1", @@ -5219,6 +5297,7 @@ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, + "optional": true, "requires": { "is-extendable": "^0.1.0" } @@ -5272,6 +5351,7 @@ "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz", "integrity": "sha512-FtyOnWN/wCHTVXOMwvSv26d+ko5vWlIDD6zoUJ7LW8vh+ZBC8QdljveRP+crNrtBwioEUWy/4dMtbBjA4ioNlg==", "dev": true, + "optional": true, "requires": { "base": "^0.11.1", "debug": "^2.2.0", @@ -5288,6 +5368,7 @@ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, + "optional": true, "requires": { "is-descriptor": "^0.1.0" } @@ -5297,6 +5378,7 @@ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, + "optional": true, "requires": { "is-extendable": "^0.1.0" } @@ -5368,7 +5450,8 @@ "version": "6.0.2", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==", - "dev": true + "dev": true, + "optional": true } } }, @@ -5393,6 +5476,7 @@ "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.2.tgz", "integrity": "sha512-MjqsvNwyz1s0k81Goz/9vRBe9SZdB09Bdw+/zYyO+3CuPk6fouTaxscHkgtE8jKvf01kVfl8riHzERQ/kefaSA==", "dev": true, + "optional": true, "requires": { "atob": "^2.1.1", "decode-uri-component": "^0.2.0", @@ -5414,7 +5498,8 @@ "version": "0.4.0", "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.0.tgz", "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=", - "dev": true + "dev": true, + "optional": true }, "spdx-correct": { "version": "3.1.0", @@ -5453,6 +5538,7 @@ "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz", "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==", "dev": true, + "optional": true, "requires": { "extend-shallow": "^3.0.0" } @@ -5485,6 +5571,7 @@ "resolved": "https://registry.npmjs.org/static-extend/-/static-extend-0.1.2.tgz", "integrity": "sha1-YICcOcv/VTNyJv1eC1IPNB8ftcY=", "dev": true, + "optional": true, "requires": { "define-property": "^0.2.5", "object-copy": "^0.1.0" @@ -5495,6 +5582,7 @@ "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", "dev": true, + "optional": true, "requires": { "is-descriptor": "^0.1.0" } @@ -5710,6 +5798,7 @@ "resolved": "https://registry.npmjs.org/to-object-path/-/to-object-path-0.3.0.tgz", "integrity": "sha1-KXWIt7Dn4KwI4E5nL4XB9JmeF68=", "dev": true, + "optional": true, "requires": { "kind-of": "^3.0.2" } @@ -5719,6 +5808,7 @@ "resolved": "https://registry.npmjs.org/to-regex/-/to-regex-3.0.2.tgz", "integrity": "sha512-FWtleNAtZ/Ki2qtqej2CXTOayOH9bHDQF+Q48VpWyDXjbYxA4Yz8iDB31zXOBUlOHHKidDbqGVrTUvQMPmBGBw==", "dev": true, + "optional": true, "requires": { "define-property": "^2.0.2", "extend-shallow": "^3.0.2", @@ -5839,6 +5929,7 @@ "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.0.tgz", "integrity": "sha1-XHHDTLW61dzr4+oM0IIHulqhrqQ=", "dev": true, + "optional": true, "requires": { "arr-union": "^3.1.0", "get-value": "^2.0.6", @@ -5851,6 +5942,7 @@ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", "dev": true, + "optional": true, "requires": { "is-extendable": "^0.1.0" } @@ -5860,6 +5952,7 @@ "resolved": "https://registry.npmjs.org/set-value/-/set-value-0.4.3.tgz", "integrity": "sha1-fbCPnT0i3H945Trzw79GZuzfzPE=", "dev": true, + "optional": true, "requires": { "extend-shallow": "^2.0.1", "is-extendable": "^0.1.1", @@ -5874,6 +5967,7 @@ "resolved": "https://registry.npmjs.org/unset-value/-/unset-value-1.0.0.tgz", "integrity": "sha1-g3aHP30jNRef+x5vw6jtDfyKtVk=", "dev": true, + "optional": true, "requires": { "has-value": "^0.3.1", "isobject": "^3.0.0" @@ -5884,6 +5978,7 @@ "resolved": "https://registry.npmjs.org/has-value/-/has-value-0.3.1.tgz", "integrity": "sha1-ex9YutpiyoJ+wKIHgCVlSEWZXh8=", "dev": true, + "optional": true, "requires": { "get-value": "^2.0.3", "has-values": "^0.1.4", @@ -5895,6 +5990,7 @@ "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz", "integrity": "sha1-8GVWEJaj8dou9GJy+BXIQNh+DIk=", "dev": true, + "optional": true, "requires": { "isarray": "1.0.0" } @@ -5905,13 +6001,15 @@ "version": "0.1.4", "resolved": "https://registry.npmjs.org/has-values/-/has-values-0.1.4.tgz", "integrity": "sha1-bWHeldkd/Km5oCCJrThL/49it3E=", - "dev": true + "dev": true, + "optional": true }, "isobject": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true + "dev": true, + "optional": true } } }, @@ -5928,13 +6026,15 @@ "version": "0.1.0", "resolved": "https://registry.npmjs.org/urix/-/urix-0.1.0.tgz", "integrity": "sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI=", - "dev": true + "dev": true, + "optional": true }, "use": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz", "integrity": "sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==", - "dev": true + "dev": true, + "optional": true }, "user-home": { "version": "1.1.1", diff --git a/package.json b/package.json index 7ec04cee..dc8cc08b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "avatax", - "version": "20.5.0", + "version": "20.6.0", "description": "AvaTax v2 SDK for languages using JavaScript", "main": "index.js", "homepage": "https://github.com/avadev/AvaTax-REST-V2-JS-SDK",