From b1bce2424797ee0c73529695ad2a856043056040 Mon Sep 17 00:00:00 2001 From: SVC Developer Date: Tue, 23 Mar 2021 20:28:43 +0000 Subject: [PATCH] 21.3.0 update --- setup.py | 2 +- src/client_methods.py | 6084 ++++++++++++++++++++--------------------- 2 files changed, 3043 insertions(+), 3043 deletions(-) diff --git a/setup.py b/setup.py index 9aef8e8..94a4a56 100644 --- a/setup.py +++ b/setup.py @@ -9,7 +9,7 @@ setup( name='Avalara', - version='21.1.1', + version='21.3.0', url='https://github.com/avadev/AvaTax-REST-V2-Python-SDK', package_dir={'': 'src'}, packages=['avalara'], diff --git a/src/client_methods.py b/src/client_methods.py index 61b0589..1b376bf 100644 --- a/src/client_methods.py +++ b/src/client_methods.py @@ -1,13 +1,13 @@ -import requests -from _str_version import str_type - - -class Mixin: - """Mixin class contain methods attached to Client class.""" - - r""" - Reset this account's license key - +import requests +from _str_version import str_type + + +class Mixin: + """Mixin class contain methods attached to Client class.""" + + r""" + Reset this account's license key + Resets the existing license key for this account to a new key. To reset your account, you must specify the ID of the account you wish to reset and confirm the action. This API is only available to account administrators for the account in question, and may only be called after @@ -19,18 +19,18 @@ class Mixin: The email will specify which user reset the license key and it will contain the new key to use to update your connectors. Note: The reset license key functionality will only be available for existing active license key i.e. when you reset license key for the account, the Default license key will be reset.The reset license key functionality is not available for newly created license keys i.e. license keys other than Default ### Security Policies - * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param id_ [int] The ID of the account you wish to update. :param model [ResetLicenseKeyModel] A request confirming that you wish to reset the license key of this account. - :return LicenseKeyModel - """ - def account_reset_license_key(self, id_, model): return requests.post('{}/api/v2/accounts/{}/resetlicensekey'.format(self.base_url, id_), + :return LicenseKeyModel + """ + def account_reset_license_key(self, id_, model): return requests.post('{}/api/v2/accounts/{}/resetlicensekey'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Activate an account by accepting terms and conditions - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Activate an account by accepting terms and conditions + Activate the account specified by the unique accountId number. This activation request can only be called by account administrators. You must indicate that you have read and accepted Avalara's terms and conditions to call this API. @@ -39,18 +39,18 @@ def account_reset_license_key(self, id_, model): return requests.post('{} If you have not read or accepted the terms and conditions, this API call will return the unchanged account model. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param id_ [int] The ID of the account to activate :param model [ActivateAccountModel] The activation request - :return AccountModel - """ - def activate_account(self, id_, model): return requests.post('{}/api/v2/accounts/{}/activate'.format(self.base_url, id_), + :return AccountModel + """ + def activate_account(self, id_, model): return requests.post('{}/api/v2/accounts/{}/activate'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve audit history for an account. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve audit history for an account. + Retrieve audit trace history for an account. Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate problems and see exactly what information was sent back and forth between your code and AvaTax. @@ -62,21 +62,21 @@ def activate_account(self, id_, model): return requests.post('{}/api/v2/a * Old records may be migrated out of immediately available storage. To request older data, please contact your account manager. * New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the account you wish to audit. :param start [datetime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes. :param end [datetime] 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - :return FetchResult - """ - def audit_account(self, id_, include=None): return requests.get('{}/api/v2/accounts/{}/audit'.format(self.base_url, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create license key for this account - + :return FetchResult + """ + def audit_account(self, id_, include=None): return requests.get('{}/api/v2/accounts/{}/audit'.format(self.base_url, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create license key for this account + Creates a new license key for this account. To create a license key for your account, you must specify the ID of the account and license key name. This API is only available to account administrators for the account in question, and may only be called after @@ -85,51 +85,51 @@ def audit_account(self, id_, include=None): return requests.get('{}/api/v You will reference this key using license key name. The existing license key will be using 'Default' as license key name. Hence make sure that the license key name is unique per account considering the existing license key name 'Default' ### Security Policies - * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param id_ [int] The ID of the account you wish to update. :param model [AccountLicenseKeyModel] - :return LicenseKeyModel - """ - def create_license_key(self, id_, model): return requests.post('{}/api/v2/accounts/{}/licensekey'.format(self.base_url, id_), + :return LicenseKeyModel + """ + def create_license_key(self, id_, model): return requests.post('{}/api/v2/accounts/{}/licensekey'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete license key for this account by license key name - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete license key for this account by license key name + Deletes the license key for this account using license key name. To delete a license key for your account, you must specify the accountID of the account and license key name. This API is only available to account administrators for the account in question. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param id_ [int] The ID of the account you wish to update. :param licensekeyname [string] The license key name you wish to update. - :return ErrorDetail - """ - def delete_license_key(self, id_, licensekeyname): return requests.delete('{}/api/v2/accounts/{}/licensekey/{}'.format(self.base_url, id_, licensekeyname), + :return ErrorDetail + """ + def delete_license_key(self, id_, licensekeyname): return requests.delete('{}/api/v2/accounts/{}/licensekey/{}'.format(self.base_url, id_, licensekeyname), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single account + Get the account object identified by this URL. You may use the '$include' parameter to fetch additional nested data: * Subscriptions * Users ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the account to retrieve :param include [string] A comma separated list of special fetch options - :return AccountModel - """ - def get_account(self, id_, include=None): return requests.get('{}/api/v2/accounts/{}'.format(self.base_url, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get configuration settings for this account - + :return AccountModel + """ + def get_account(self, id_, include=None): return requests.get('{}/api/v2/accounts/{}'.format(self.base_url, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get configuration settings for this account + Retrieve a list of all configuration settings tied to this account. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for @@ -140,43 +140,43 @@ def get_account(self, id_, include=None): return requests.get('{}/api/v2/ Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's tax calculation and address resolution, and should only be changed with care. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param id_ [int] - :return AccountConfigurationModel - """ - def get_account_configuration(self, id_): return requests.get('{}/api/v2/accounts/{}/configuration'.format(self.base_url, id_), + :return AccountConfigurationModel + """ + def get_account_configuration(self, id_): return requests.get('{}/api/v2/accounts/{}/configuration'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve license key by license key name - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] The ID of the account to retrieve :param licensekeyname [string] The ID of the account to retrieve - :return AccountLicenseKeyModel - """ - def get_license_key(self, id_, licensekeyname): return requests.get('{}/api/v2/accounts/{}/licensekey/{}'.format(self.base_url, id_, licensekeyname), + :return AccountLicenseKeyModel + """ + def get_license_key(self, id_, licensekeyname): return requests.get('{}/api/v2/accounts/{}/licensekey/{}'.format(self.base_url, id_, licensekeyname), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all license keys for this account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] The ID of the account to retrieve - :return AccountLicenseKeyModel - """ - def get_license_keys(self, id_): return requests.get('{}/api/v2/accounts/{}/licensekeys'.format(self.base_url, id_), + :return AccountLicenseKeyModel + """ + def get_license_keys(self, id_): return requests.get('{}/api/v2/accounts/{}/licensekeys'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all accounts - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all accounts + List all account objects that can be seen by the current user. This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -186,21 +186,21 @@ def get_license_keys(self, id_): return requests.get('{}/api/v2/accounts/ * Users For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ . ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 include [string] 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_accounts(self, include=None): return requests.get('{}/api/v2/accounts'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Change configuration settings for this account - + :return FetchResult + """ + def query_accounts(self, include=None): return requests.get('{}/api/v2/accounts'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Change configuration settings for this account + Update configuration settings tied to this account. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for @@ -211,18 +211,18 @@ def query_accounts(self, include=None): return requests.get('{}/api/v2/ac Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's tax calculation and address resolution, and should only be changed with care. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param id_ [int] :param model [AccountConfigurationModel] - :return AccountConfigurationModel - """ - def set_account_configuration(self, id_, model): return requests.post('{}/api/v2/accounts/{}/configuration'.format(self.base_url, id_), + :return AccountConfigurationModel + """ + def set_account_configuration(self, id_, model): return requests.post('{}/api/v2/accounts/{}/configuration'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve geolocation information for a specified address - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 @@ -235,8 +235,8 @@ def set_account_configuration(self, id_, model): return requests.post('{} 3. line1 + postal code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AutoAddress. - + * This API depends on the following active services:*Required* (all): AutoAddress. + :param line1 [string] Line 1 :param line2 [string] Line 2 :param line3 [string] Line 3 @@ -245,14 +245,14 @@ def set_account_configuration(self, id_, model): return requests.post('{} :param postalCode [string] Postal Code / Zip Code :param country [string] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list) :param textCase [TextCase] selectable text case for address validation (See TextCase::* for a list of allowable values) - :return AddressResolutionModel - """ - def resolve_address(self, include=None): return requests.get('{}/api/v2/addresses/resolve'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve geolocation information for a specified address - + :return AddressResolutionModel + """ + def resolve_address(self, include=None): return requests.get('{}/api/v2/addresses/resolve'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 @@ -261,156 +261,156 @@ def resolve_address(self, include=None): return requests.get('{}/api/v2/a Both verbs are supported to provide for flexible implementation. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AutoAddress. - + * This API depends on the following active services:*Required* (all): AutoAddress. + :param model [AddressValidationInfo] The address to resolve - :return AddressResolutionModel - """ - def resolve_address_post(self, model): return requests.post('{}/api/v2/addresses/resolve'.format(self.base_url), + :return AddressResolutionModel + """ + def resolve_address_post(self, model): return requests.post('{}/api/v2/addresses/resolve'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a lookup file for a company - - - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a lookup file for a company + + + :param accountId [int] The ID of the account for the company :param companyId [int] The ID of the company for which the lookup file is to be created :param model [AdvancedRuleLookupFileModel] The lookup file you wish to create - :return AdvancedRuleLookupFileModel - """ - def create_company_lookup_file(self, accountId, companyId, model): return requests.post('{}/api/v2/advancedrules/accounts/{}/companies/{}/lookupFiles'.format(self.base_url, accountId, companyId), + :return AdvancedRuleLookupFileModel + """ + def create_company_lookup_file(self, accountId, companyId, model): return requests.post('{}/api/v2/advancedrules/accounts/{}/companies/{}/lookupFiles'.format(self.base_url, accountId, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a lookup file - - - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a lookup file + + + :param accountId [int] The ID of the account for the company the lookup file is for :param id_ [string] The unique ID/GUID for the company lookup file to be deleted - :return ErrorDetail - """ - def delete_lookup_file(self, accountId, id_): return requests.delete('{}/api/v2/advancedrules/accounts/{}/lookupFiles/{}'.format(self.base_url, accountId, id_), + :return ErrorDetail + """ + def delete_lookup_file(self, accountId, id_): return requests.delete('{}/api/v2/advancedrules/accounts/{}/lookupFiles/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get the lookup files for a company - - - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get the lookup files for a company + + + :param accountId [int] The account ID for the company :param companyId [int] The ID of the company for which to retrieve lookup files - :return FetchResult - """ - def get_company_lookup_files(self, accountId, companyId): return requests.get('{}/api/v2/advancedrules/accounts/{}/companies/{}/lookupFiles'.format(self.base_url, accountId, companyId), + :return FetchResult + """ + def get_company_lookup_files(self, accountId, companyId): return requests.get('{}/api/v2/advancedrules/accounts/{}/companies/{}/lookupFiles'.format(self.base_url, accountId, companyId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get a lookup file for an accountId and companyLookupFileId - - - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get a lookup file for an accountId and companyLookupFileId + + + :param accountId [int] The ID of the account for the lookup file :param id_ [string] The unique ID/GUID of the company lookup file to return - :return AdvancedRuleLookupFileModel - """ - def get_lookup_file(self, accountId, id_): return requests.get('{}/api/v2/advancedrules/accounts/{}/lookupFiles/{}'.format(self.base_url, accountId, id_), + :return AdvancedRuleLookupFileModel + """ + def get_lookup_file(self, accountId, id_): return requests.get('{}/api/v2/advancedrules/accounts/{}/lookupFiles/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a lookup file - - - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a lookup file + + + :param accountId [int] The ID of the account for the company the lookup file is for :param id_ [string] The unique ID/GUID of the company lookup file to be updated :param model [AdvancedRuleLookupFileModel] The new values to update the lookup file - :return AdvancedRuleLookupFileModel - """ - def update_lookup_file(self, accountId, id_, model): return requests.put('{}/api/v2/advancedrules/accounts/{}/lookupFiles/{}'.format(self.base_url, accountId, id_), + :return AdvancedRuleLookupFileModel + """ + def update_lookup_file(self, accountId, id_, model): return requests.put('{}/api/v2/advancedrules/accounts/{}/lookupFiles/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new AvaFileForm - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * 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 model [AvaFileFormModel] The AvaFileForm you wish to create. - :return AvaFileFormModel - """ - def create_ava_file_forms(self, model): return requests.post('{}/api/v2/avafileforms'.format(self.base_url), + :return AvaFileFormModel + """ + def create_ava_file_forms(self, model): return requests.post('{}/api/v2/avafileforms'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single AvaFileForm - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * 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 id_ [int] The ID of the AvaFileForm you wish to delete. - :return ErrorDetail - """ - def delete_ava_file_form(self, id_): return requests.delete('{}/api/v2/avafileforms/{}'.format(self.base_url, id_), + :return ErrorDetail + """ + def delete_ava_file_form(self, id_): return requests.delete('{}/api/v2/avafileforms/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single AvaFileForm - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * 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 id_ [int] The primary key of this AvaFileForm - :return AvaFileFormModel - """ - def get_ava_file_form(self, id_): return requests.get('{}/api/v2/avafileforms/{}'.format(self.base_url, id_), + :return AvaFileFormModel + """ + def get_ava_file_form(self, id_): return requests.get('{}/api/v2/avafileforms/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all AvaFileForms - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_ava_file_forms(self, include=None): return requests.get('{}/api/v2/avafileforms'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a AvaFileForm - + :return FetchResult + """ + def query_ava_file_forms(self, include=None): return requests.get('{}/api/v2/avafileforms'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] The ID of the AvaFileForm you wish to update :param model [AvaFileFormModel] The AvaFileForm model you wish to update. - :return AvaFileFormModel - """ - def update_ava_file_form(self, id_, model): return requests.put('{}/api/v2/avafileforms/{}'.format(self.base_url, id_), + :return AvaFileFormModel + """ + def update_ava_file_form(self, id_, model): return requests.put('{}/api/v2/avafileforms/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Cancel an in progress batch - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -421,18 +421,18 @@ def update_ava_file_form(self, id_, model): return requests.put('{}/api/v 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. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this batch. :param id_ [int] The ID of the batch to cancel. - :return BatchModel - """ - def cancel_batch(self, companyId, id_): return requests.post('{}/api/v2/companies/{}/batches/{}/cancel'.format(self.base_url, companyId, id_), + :return BatchModel + """ + def cancel_batch(self, companyId, id_): return requests.post('{}/api/v2/companies/{}/batches/{}/cancel'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new batch - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new batch + Create one or more new batch objects attached to this company. Each batch object may have one or more file objects (currently only one file is supported). When a batch is created, it is added to the AvaTax Batch Queue and will be @@ -449,18 +449,18 @@ def cancel_batch(self, companyId, id_): return requests.post('{}/api/v2/c 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. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this batch. :param model [BatchModel] The batch you wish to create. - :return BatchModel - """ - def create_batches(self, companyId, model): return requests.post('{}/api/v2/companies/{}/batches'.format(self.base_url, companyId), + :return BatchModel + """ + def create_batches(self, companyId, model): return requests.post('{}/api/v2/companies/{}/batches'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new transaction batch - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 @@ -476,18 +476,18 @@ def create_batches(self, companyId, model): return requests.post('{}/api/ 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. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this batch. :param model [CreateTransactionBatchRequestModel] The transaction batch you wish to create. - :return CreateTransactionBatchResponseModel - """ - def create_transaction_batch(self, companyId, model): return requests.post('{}/api/v2/companies/{}/batches/transactions'.format(self.base_url, companyId), + :return CreateTransactionBatchResponseModel + """ + def create_transaction_batch(self, companyId, model): return requests.post('{}/api/v2/companies/{}/batches/transactions'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single batch - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single batch + Marks the batch identified by this URL as deleted. If you attempt to delete a batch that is being processed, you will receive an error message. Deleting a batch does not delete any transactions that were created by importing the batch. @@ -497,33 +497,33 @@ def create_transaction_batch(self, companyId, model): return requests.pos required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies - * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - + * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this batch. :param id_ [int] The ID of the batch to delete. - :return ErrorDetail - """ - def delete_batch(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/batches/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_batch(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/batches/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Download a single batch file - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this batch :param batchId [int] The ID of the batch object :param id_ [int] The primary key of this batch file object - :return String - """ - def download_batch(self, companyId, batchId, id_): return requests.get('{}/api/v2/companies/{}/batches/{}/files/{}/attachment'.format(self.base_url, companyId, batchId, id_), + :return String + """ + def download_batch(self, companyId, batchId, id_): return requests.get('{}/api/v2/companies/{}/batches/{}/files/{}/attachment'.format(self.base_url, companyId, batchId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single batch - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single batch + Get the batch object identified by this URL. A batch object is a large collection of API calls stored in a compact file. Use this endpoint to retrieve the results or check the status of a batch. @@ -537,18 +537,18 @@ def download_batch(self, companyId, batchId, id_): return requests.get('{ required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns this batch :param id_ [int] The primary key of this batch - :return BatchModel - """ - def get_batch(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/batches/{}'.format(self.base_url, companyId, id_), + :return BatchModel + """ + def get_batch(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/batches/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all batches for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all batches for this company + List all batch objects attached to the specified company. A batch object is a large collection of API calls stored in a compact file. Search for specific objects using the criteria in the `$filter` parameter; @@ -566,22 +566,22 @@ def get_batch(self, companyId, id_): return requests.get('{}/api/v2/compa required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns these batches :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_batches_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/batches'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all batches - + :return FetchResult + """ + def list_batches_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/batches'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all batches + Get multiple batch objects across all companies. A batch object is a large collection of API calls stored in a compact file. Search for specific objects using the criteria in the `$filter` parameter; @@ -597,21 +597,21 @@ def list_batches_by_company(self, companyId, include=None): return reques required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/). ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. + :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_batches(self, include=None): return requests.get('{}/api/v2/batches'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a CertExpress invitation - + :return FetchResult + """ + def query_batches(self, include=None): return requests.get('{}/api/v2/batches'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a CertExpress invitation + Creates an invitation for a customer to self-report certificates using the CertExpress website. This invitation is delivered by your choice of method, or you can present a hyperlink to the user directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where @@ -626,19 +626,19 @@ def query_batches(self, include=None): return requests.get('{}/api/v2/bat certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that will record certificates :param customerCode [string] The number of the customer where the request is sent to :param model [CreateCertExpressInvitationModel] the requests to send out to customers - :return CertExpressInvitationStatusModel - """ - def create_cert_express_invitation(self, companyId, customerCode, model): return requests.post('{}/api/v2/companies/{}/customers/{}/certexpressinvites'.format(self.base_url, companyId, customerCode), + :return CertExpressInvitationStatusModel + """ + def create_cert_express_invitation(self, companyId, customerCode, model): return requests.post('{}/api/v2/companies/{}/customers/{}/certexpressinvites'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single CertExpress invitation - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single CertExpress invitation + Retrieve an existing CertExpress invitation sent to a customer. A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information about their certificates. This step by step guide allows the customer to complete and upload the full @@ -653,20 +653,20 @@ def create_cert_express_invitation(self, companyId, customerCode, model): certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that issued this invitation :param customerCode [string] The number of the customer where the request is sent to :param id_ [int] The unique ID number of this CertExpress invitation :param include [string] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. - :return CertExpressInvitationModel - """ - def get_cert_express_invitation(self, companyId, customerCode, id_, include=None): return requests.get('{}/api/v2/companies/{}/customers/{}/certexpressinvites/{}'.format(self.base_url, companyId, customerCode, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List CertExpress invitations - + :return CertExpressInvitationModel + """ + def get_cert_express_invitation(self, companyId, customerCode, id_, include=None): return requests.get('{}/api/v2/companies/{}/customers/{}/certexpressinvites/{}'.format(self.base_url, companyId, customerCode, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List CertExpress invitations + Retrieve CertExpress invitations sent by this company. A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information about their certificates. This step by step guide allows the customer to complete and upload the full @@ -681,22 +681,22 @@ def get_cert_express_invitation(self, companyId, customerCode, id_, include=None certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that issued this invitation :param include [string] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_cert_express_invitations(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/certexpressinvites'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create certificates for this company - + :return FetchResult + """ + def list_cert_express_invitations(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/certexpressinvites'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create certificates for this company + Record one or more certificates document for this company. A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on @@ -715,19 +715,19 @@ def list_cert_express_invitations(self, companyId, include=None): return If the users specified in the certificates do not exist, the API will create the user and link them to the certificate ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The ID number of the company recording this certificate :param preValidatedExemptionReason [boolean] If set to true, the certificate will bypass the human verification process. :param model [CertificateModel] Certificates to be created - :return CertificateModel - """ - def create_certificates(self, companyId, model, include=None): return requests.post('{}/api/v2/companies/{}/certificates'.format(self.base_url, companyId), + :return CertificateModel + """ + def create_certificates(self, companyId, model, include=None): return requests.post('{}/api/v2/companies/{}/certificates'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Revoke and delete a certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Revoke and delete a certificate + Revoke the certificate identified by this URL, then delete it. A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on @@ -740,18 +740,18 @@ def create_certificates(self, companyId, model, include=None): return req certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate - :return ErrorDetail - """ - def delete_certificate(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/certificates/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_certificate(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/certificates/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Download an image for this certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Download an image for this certificate + Download an image or PDF file for this certificate. This API can be used to download either a single-page preview of the certificate or a full PDF document. To retrieve a preview image, set the `$type` parameter to `Jpeg` and the `$page` parameter to `1`. @@ -765,20 +765,20 @@ def delete_certificate(self, companyId, id_): return requests.delete('{}/ certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param page [int] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve. :param type [CertificatePreviewType] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values) - :return String - """ - def download_certificate_image(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/certificates/{}/attachment'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single certificate - + :return String + """ + def download_certificate_image(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/certificates/{}/attachment'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single certificate + Get the current certificate identified by this URL. A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on @@ -794,19 +794,19 @@ def download_certificate_image(self, companyId, id_, include=None): retur certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param include [string] 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 CertificateModel - """ - def get_certificate(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/certificates/{}'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Check a company's exemption certificate status. - + :return CertificateModel + """ + def get_certificate(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/certificates/{}'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Check a company's exemption certificate status. + Checks whether this company is configured to use exemption certificates in AvaTax. Exemption certificates are tracked through a different auditable data store than the one that holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call @@ -815,17 +815,17 @@ def get_certificate(self, companyId, id_, include=None): return requests. be configured with data storage in the auditable certificate system. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The company ID to check - :return ProvisionStatusModel - """ - def get_certificate_setup(self, companyId): return requests.get('{}/api/v2/companies/{}/certificates/setup'.format(self.base_url, companyId), + :return ProvisionStatusModel + """ + def get_certificate_setup(self, companyId): return requests.get('{}/api/v2/companies/{}/certificates/setup'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Link attributes to a certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Link attributes to a certificate + Link one or many attributes to a certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`. @@ -839,19 +839,19 @@ def get_certificate_setup(self, companyId): return requests.get('{}/api/v certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param model [CertificateAttributeModel] The list of attributes to link to this certificate. - :return FetchResult - """ - def link_attributes_to_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/attributes/link'.format(self.base_url, companyId, id_), + :return FetchResult + """ + def link_attributes_to_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/attributes/link'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Link customers to a certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Link customers to a certificate + Link one or more customers to an existing certificate. Customers and certificates must be linked before a customer can make use of a certificate to obtain a tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate @@ -866,19 +866,19 @@ def link_attributes_to_certificate(self, companyId, id_, model): return r certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param model [LinkCustomersModel] The list of customers needed be added to the Certificate for exemption - :return FetchResult - """ - def link_customers_to_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/customers/link'.format(self.base_url, companyId, id_), + :return FetchResult + """ + def link_customers_to_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/customers/link'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all attributes applied to this certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all attributes applied to this certificate + Retrieve the list of attributes that are linked to this certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API. @@ -892,18 +892,18 @@ def link_customers_to_certificate(self, companyId, id_, model): return re certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate - :return FetchResult - """ - def list_attributes_for_certificate(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/certificates/{}/attributes'.format(self.base_url, companyId, id_), + :return FetchResult + """ + def list_attributes_for_certificate(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/certificates/{}/attributes'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List customers linked to this certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List customers linked to this certificate + List all customers linked to this certificate. Customers must be linked to a certificate in order to make use of its tax exemption features. You can link or unlink customers to a certificate at any time. @@ -917,19 +917,19 @@ def list_attributes_for_certificate(self, companyId, id_): return request certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param include [string] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. - :return FetchResult - """ - def list_customers_for_certificate(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/certificates/{}/customers'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all certificates for a company - + :return FetchResult + """ + def list_customers_for_certificate(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/certificates/{}/customers'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all certificates for a company + List all certificates recorded by a company A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on @@ -945,22 +945,22 @@ def list_customers_for_certificate(self, companyId, id_, include=None): r certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The ID number of the company to search :param include [string] 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_certificates(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/certificates'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Request setup of exemption certificates for this company. - + :return FetchResult + """ + def query_certificates(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/certificates'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Request setup of exemption certificates for this company. + Requests the setup of exemption certificates for this company. Exemption certificates are tracked through a different auditable data store than the one that holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call @@ -970,17 +970,17 @@ def query_certificates(self, companyId, include=None): return requests.ge This API will return the current status of exemption certificate setup for this company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] - :return ProvisionStatusModel - """ - def request_certificate_setup(self, companyId): return requests.post('{}/api/v2/companies/{}/certificates/setup'.format(self.base_url, companyId), + :return ProvisionStatusModel + """ + def request_certificate_setup(self, companyId): return requests.post('{}/api/v2/companies/{}/certificates/setup'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Unlink attributes from a certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Unlink attributes from a certificate + Unlink one or many attributes from a certificate. A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a certificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`. @@ -994,19 +994,19 @@ def request_certificate_setup(self, companyId): return requests.post('{}/ certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param model [CertificateAttributeModel] The list of attributes to unlink from this certificate. - :return FetchResult - """ - def unlink_attributes_from_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/attributes/unlink'.format(self.base_url, companyId, id_), + :return FetchResult + """ + def unlink_attributes_from_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/attributes/unlink'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Unlink customers from a certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Unlink customers from a certificate + Unlinks one or more customers from a certificate. Unlinking a certificate from a customer will prevent the certificate from being used to generate tax exemptions for the customer in the future. If any previous transactions for this customer had @@ -1022,19 +1022,19 @@ def unlink_attributes_from_certificate(self, companyId, id_, model): retu certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param model [LinkCustomersModel] The list of customers to unlink from this certificate - :return FetchResult - """ - def unlink_customers_from_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/customers/unlink'.format(self.base_url, companyId, id_), + :return FetchResult + """ + def unlink_customers_from_certificate(self, companyId, id_, model): return requests.post('{}/api/v2/companies/{}/certificates/{}/customers/unlink'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single certificate + Replace the certificate identified by this URL with a new one. A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document can contain information about a customer's eligibility for exemption from sales or use taxes based on @@ -1046,19 +1046,19 @@ def unlink_customers_from_certificate(self, companyId, id_, model): retur certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param model [CertificateModel] The new certificate object that will replace the existing one - :return CertificateModel - """ - def update_certificate(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/certificates/{}'.format(self.base_url, companyId, id_), + :return CertificateModel + """ + def update_certificate(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/certificates/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Upload an image or PDF attachment for this certificate - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Upload an image or PDF attachment for this certificate + Upload an image or PDF attachment for this certificate. Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please use the `PDF` data type. @@ -1072,19 +1072,19 @@ def update_certificate(self, companyId, id_, model): return requests.put( certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this certificate :param id_ [int] The unique ID number of this certificate :param file [String] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG. - :return string - """ - def upload_certificate_image(self, companyId, id_): return requests.post('{}/api/v2/companies/{}/certificates/{}/attachment'.format(self.base_url, companyId, id_), + :return string + """ + def upload_certificate_image(self, companyId, id_): return requests.post('{}/api/v2/companies/{}/certificates/{}/attachment'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -1108,17 +1108,17 @@ def upload_certificate_image(self, companyId, id_): return requests.post( 16. Any document has currencyCode not being USD for accounts with AvaGlobal subscription. 17. All documents have countryCode used for accounts with AvaGlobal subscription. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the company to check if its integration is certified. - :return string - """ - def certify_integration(self, id_): return requests.get('{}/api/v2/companies/{}/certify'.format(self.base_url, id_), + :return string + """ + def certify_integration(self, id_): return requests.get('{}/api/v2/companies/{}/certify'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Change the filing status of this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Change the filing status of this company + Changes the current filing status of this company. For customers using Avalara's Managed Returns Service, each company within their account can request for Avalara to file tax returns on their behalf. Avalara compliance team members will review all @@ -1129,18 +1129,18 @@ def certify_integration(self, id_): return requests.get('{}/api/v2/compan * Avalara compliance team members may change a company from `FirstFiling` to `Active`. All other status changes must be requested through the Avalara customer support team. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] :param model [FilingStatusChangeModel] - :return string - """ - def change_filing_status(self, id_, model): return requests.post('{}/api/v2/companies/{}/filingstatus'.format(self.base_url, id_), + :return string + """ + def change_filing_status(self, id_, model): return requests.post('{}/api/v2/companies/{}/filingstatus'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Quick setup for a company with a single physical address - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Quick setup for a company with a single physical address + Shortcut to quickly setup a single-physical-location company with critical information and activate it. This API provides quick and simple company setup functionality and does the following things: * Create a company object with its own tax profile @@ -1152,33 +1152,33 @@ def change_filing_status(self, id_, model): return requests.post('{}/api/ If you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead. Please allow 1 minute before making transactions using the company. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param model [CompanyInitializationModel] Information about the company you wish to create. - :return CompanyModel - """ - def company_initialize(self, model): return requests.post('{}/api/v2/companies/initialize'.format(self.base_url), + :return CompanyModel + """ + def company_initialize(self, model): return requests.post('{}/api/v2/companies/initialize'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create new companies - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create new companies + Create one or more new company objects. A 'company' represents a single corporation or individual that is registered to handle transactional taxes. You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company. NOTE: Please do not use these blacklisted characters in company name and code: ';', '\', '|'. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param model [CompanyModel] Either a single company object or an array of companies to create - :return CompanyModel - """ - def create_companies(self, model): return requests.post('{}/api/v2/companies'.format(self.base_url), + :return CompanyModel + """ + def create_companies(self, model): return requests.post('{}/api/v2/companies'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add parameters to a company. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Add parameters to a company. + Add parameters to a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. @@ -1186,18 +1186,18 @@ def create_companies(self, model): return requests.post('{}/api/v2/compan To see available parameters for this company, call `/api/v2/definitions/parameters?$filter=attributeType eq Company` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this company parameter. :param model [CompanyParameterDetailModel] The company parameters you wish to create. - :return CompanyParameterDetailModel - """ - def create_company_parameters(self, companyId, model): return requests.post('{}/api/v2/companies/{}/parameters'.format(self.base_url, companyId), + :return CompanyParameterDetailModel + """ + def create_company_parameters(self, companyId, model): return requests.post('{}/api/v2/companies/{}/parameters'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Request managed returns funding setup for a company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 @@ -1210,83 +1210,83 @@ def create_company_parameters(self, companyId, model): return requests.po This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The unique identifier of the company :param model [FundingInitiateModel] The funding initialization request - :return FundingStatusModel - """ - def create_funding_request(self, id_, model): return requests.post('{}/api/v2/companies/{}/funding/setup'.format(self.base_url, id_), + :return FundingStatusModel + """ + def create_funding_request(self, id_, model): return requests.post('{}/api/v2/companies/{}/funding/setup'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] The ID of the company you wish to delete. - :return ErrorDetail - """ - def delete_company(self, id_): return requests.delete('{}/api/v2/companies/{}'.format(self.base_url, id_), + :return ErrorDetail + """ + def delete_company(self, id_): return requests.delete('{}/api/v2/companies/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single company parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single company parameter + Delete a parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id :param id_ [int] The parameter id - :return ErrorDetail - """ - def delete_company_parameter(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/parameters/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_company_parameter(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/parameters/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Check the funding configuration of a company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Check the funding configuration of a company + This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns the funding configuration of the requested company. . ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 companyId [int] The unique identifier of the company - :return FundingConfigurationModel - """ - def funding_configuration_by_company(self, companyId): return requests.get('{}/api/v2/companies/{}/funding/configuration'.format(self.base_url, companyId), + :return FundingConfigurationModel + """ + def funding_configuration_by_company(self, companyId): return requests.get('{}/api/v2/companies/{}/funding/configuration'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Check the funding configuration of a company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Check the funding configuration of a company + This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns the funding configuration of the requested company. . ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 companyId [int] The unique identifier of the company :param currency [string] The currency of the funding. USD and CAD are the only valid currencies - :return FundingConfigurationModel - """ - def funding_configurations_by_company_and_currency(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/funding/configurations'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single company - + :return FundingConfigurationModel + """ + def funding_configurations_by_company_and_currency(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/funding/configurations'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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: @@ -1300,18 +1300,18 @@ def funding_configurations_by_company_and_currency(self, companyId, include=None * UPC * Parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the company to retrieve. :param include [string] 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 CompanyModel - """ - def get_company(self, id_, include=None): return requests.get('{}/api/v2/companies/{}'.format(self.base_url, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get configuration settings for this company - + :return CompanyModel + """ + def get_company(self, id_, include=None): return requests.get('{}/api/v2/companies/{}'.format(self.base_url, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get configuration settings for this company + Retrieve a list of all configuration settings tied to this company. Configuration settings provide you with the ability to control features of your account and of your tax software. The category name `AvaCertServiceConfig` is reserved for @@ -1322,34 +1322,34 @@ def get_company(self, id_, include=None): return requests.get('{}/api/v2/ Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate processing, and should be changed with care. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param id_ [int] - :return CompanyConfigurationModel - """ - def get_company_configuration(self, id_): return requests.get('{}/api/v2/companies/{}/configuration'.format(self.base_url, id_), + :return CompanyConfigurationModel + """ + def get_company_configuration(self, id_): return requests.get('{}/api/v2/companies/{}/configuration'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single company parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single company parameter + Retrieves a single parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 companyId [int] :param id_ [int] - :return CompanyParameterDetailModel - """ - def get_company_parameter_detail(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/parameters/{}'.format(self.base_url, companyId, id_), + :return CompanyParameterDetailModel + """ + def get_company_parameter_detail(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/parameters/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get this company's filing status - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get this company's filing status + Retrieve the current filing status of this company. For customers using Avalara's Managed Returns Service, each company within their account can request for Avalara to file tax returns on their behalf. Avalara compliance team members will review all @@ -1361,17 +1361,17 @@ def get_company_parameter_detail(self, companyId, id_): return requests.g * `FirstFiling` - The company has recently filing tax returns and is in a new status. * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] - :return string - """ - def get_filing_status(self, id_): return requests.get('{}/api/v2/companies/{}/filingstatus'.format(self.base_url, id_), + :return string + """ + def get_filing_status(self, id_): return requests.get('{}/api/v2/companies/{}/filingstatus'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve parameters for a company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve parameters for a company + Retrieve all parameters of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. @@ -1379,51 +1379,51 @@ def get_filing_status(self, id_): return requests.get('{}/api/v2/companie Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API 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 companyId [int] The company id :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_company_parameter_details(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/parameters'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Check managed returns funding status for a company - + :return FetchResult + """ + def list_company_parameter_details(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/parameters'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Check managed returns funding status for a company + This API is available by invitation only. Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. Returns a list of funding setup requests and their current status. Each object in the result is a request that was made to setup or adjust funding status for this company. ### Security Policies * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The unique identifier of the company - :return FundingStatusModel - """ - def list_funding_requests_by_company(self, id_): return requests.get('{}/api/v2/companies/{}/funding'.format(self.base_url, id_), + :return FundingStatusModel + """ + def list_funding_requests_by_company(self, id_): return requests.get('{}/api/v2/companies/{}/funding'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a list of MRS Companies with account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 - """ - def list_mrs_companies(self): return requests.get('{}/api/v2/companies/mrs'.format(self.base_url), + * 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 + """ + def list_mrs_companies(self): return requests.get('{}/api/v2/companies/mrs'.format(self.base_url), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all companies - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all companies + Get multiple company objects. A `company` represents a single corporation or individual that is registered to handle transactional taxes. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -1439,21 +1439,21 @@ def list_mrs_companies(self): return requests.get('{}/api/v2/companies/mr * UPC * Parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 include [string] 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 filter [string] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_companies(self, include=None): return requests.get('{}/api/v2/companies'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Change configuration settings for this company - + :return FetchResult + """ + def query_companies(self, include=None): return requests.get('{}/api/v2/companies'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Change configuration settings for this company + Update configuration settings tied to this company. Configuration settings provide you with the ability to control features of your account and of your tax software. The category names `AvaCertServiceConfig` is reserved for @@ -1464,18 +1464,18 @@ def query_companies(self, include=None): return requests.get('{}/api/v2/c Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate processing, and should be changed with care. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param id_ [int] :param model [CompanyConfigurationModel] - :return CompanyConfigurationModel - """ - def set_company_configuration(self, id_, model): return requests.post('{}/api/v2/companies/{}/configuration'.format(self.base_url, id_), + :return CompanyConfigurationModel + """ + def set_company_configuration(self, id_, model): return requests.post('{}/api/v2/companies/{}/configuration'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single company + Replace the existing company object at this URL with an updated object. A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes. All data from the existing object will be replaced with data in the object you PUT. @@ -1484,152 +1484,152 @@ def set_company_configuration(self, id_, model): return requests.post('{} To set a field's value to `null`, you may either set its value to `null` or omit that field from the object you PUT. NOTE: Please do not use these blacklisted characters in company name and code: ';', '\', '|'. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param id_ [int] The ID of the company you wish to update. :param model [CompanyModel] The company object you wish to update. - :return CompanyModel - """ - def update_company(self, id_, model): return requests.put('{}/api/v2/companies/{}'.format(self.base_url, id_), + :return CompanyModel + """ + def update_company(self, id_, model): return requests.put('{}/api/v2/companies/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a company parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a company parameter + Update a parameter of a company. Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company. A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param id_ [int] The company parameter id :param model [CompanyParameterDetailModel] The company parameter object you wish to update. - :return CompanyParameterDetailModel - """ - def update_company_parameter_detail(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/parameters/{}'.format(self.base_url, companyId, id_), + :return CompanyParameterDetailModel + """ + def update_company_parameter_detail(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/parameters/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - API to modify the reference fields at the document and the line level. - - - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + API to modify the reference fields at the document and the line level. + + + :param companyId [int] :param model [TransactionReferenceFieldModel] - :return FetchResult - """ - def tag_transaction(self, companyId, model): return requests.put('{}/api/v2/companies/{}/transactions/tag'.format(self.base_url, companyId), + :return FetchResult + """ + def tag_transaction(self, companyId, model): return requests.put('{}/api/v2/companies/{}/transactions/tag'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new contact - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this contact. :param model [ContactModel] The contacts you wish to create. - :return ContactModel - """ - def create_contacts(self, companyId, model): return requests.post('{}/api/v2/companies/{}/contacts'.format(self.base_url, companyId), + :return ContactModel + """ + def create_contacts(self, companyId, model): return requests.post('{}/api/v2/companies/{}/contacts'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single contact - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this contact. :param id_ [int] The ID of the contact you wish to delete. - :return ErrorDetail - """ - def delete_contact(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/contacts/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_contact(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/contacts/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single contact - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company for this contact :param id_ [int] The primary key of this contact - :return ContactModel - """ - def get_contact(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/contacts/{}'.format(self.base_url, companyId, id_), + :return ContactModel + """ + def get_contact(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/contacts/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve contacts for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve contacts for this company + List all contact objects assigned to this company. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The ID of the company that owns these contacts :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_contacts_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/contacts'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all contacts - + :return FetchResult + """ + def list_contacts_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/contacts'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all contacts + Get multiple contact objects across all companies. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_contacts(self, include=None): return requests.get('{}/api/v2/contacts'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single contact - + :return FetchResult + """ + def query_contacts(self, include=None): return requests.get('{}/api/v2/contacts'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single contact + Replace the existing contact object at this URL with an updated object. A 'contact' is a person associated with a company who is designated to handle certain responsibilities of a tax collecting and filing entity. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that this contact belongs to. :param id_ [int] The ID of the contact you wish to update :param model [ContactModel] The contact you wish to update. - :return ContactModel - """ - def update_contact(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/contacts/{}'.format(self.base_url, companyId, id_), + :return ContactModel + """ + def update_contact(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/contacts/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create customers for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create customers for this company + Create one or more customers for this company. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1644,18 +1644,18 @@ def update_contact(self, companyId, id_, model): return requests.put('{}/ certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param model [CustomerModel] The list of customer objects to be created - :return CustomerModel - """ - def create_customers(self, companyId, model): return requests.post('{}/api/v2/companies/{}/customers'.format(self.base_url, companyId), + :return CustomerModel + """ + def create_customers(self, companyId, model): return requests.post('{}/api/v2/companies/{}/customers'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a customer record - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a customer record + Deletes the customer object referenced by this URL. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1668,18 +1668,18 @@ def create_customers(self, companyId, model): return requests.post('{}/ap certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer - :return CustomerModel - """ - def delete_customer(self, companyId, customerCode): return requests.delete('{}/api/v2/companies/{}/customers/{}'.format(self.base_url, companyId, customerCode), + :return CustomerModel + """ + def delete_customer(self, companyId, customerCode): return requests.delete('{}/api/v2/companies/{}/customers/{}'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single customer - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single customer + Retrieve the customer identified by this URL. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1696,19 +1696,19 @@ def delete_customer(self, companyId, customerCode): return requests.delet certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer :param include [string] Specify optional additional objects to include in this fetch request - :return CustomerModel - """ - def get_customer(self, companyId, customerCode, include=None): return requests.get('{}/api/v2/companies/{}/customers/{}'.format(self.base_url, companyId, customerCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Link attributes to a customer - + :return CustomerModel + """ + def get_customer(self, companyId, customerCode, include=None): return requests.get('{}/api/v2/companies/{}/customers/{}'.format(self.base_url, companyId, customerCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Link attributes to a customer + Link one or many attributes to a customer. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. @@ -1723,19 +1723,19 @@ def get_customer(self, companyId, customerCode, include=None): return req certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded the provided customer :param customerCode [string] The unique code representing the current customer :param model [CustomerAttributeModel] The list of attributes to link to the customer. - :return FetchResult - """ - def link_attributes_to_customer(self, companyId, customerCode, model): return requests.put('{}/api/v2/companies/{}/customers/{}/attributes/link'.format(self.base_url, companyId, customerCode), + :return FetchResult + """ + def link_attributes_to_customer(self, companyId, customerCode, model): return requests.put('{}/api/v2/companies/{}/customers/{}/attributes/link'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Link certificates to a customer - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Link certificates to a customer + Link one or more certificates to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1748,19 +1748,19 @@ def link_attributes_to_customer(self, companyId, customerCode, model): re certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer :param model [LinkCertificatesModel] The list of certificates to link to this customer - :return FetchResult - """ - def link_certificates_to_customer(self, companyId, customerCode, model): return requests.post('{}/api/v2/companies/{}/customers/{}/certificates/link'.format(self.base_url, companyId, customerCode), + :return FetchResult + """ + def link_certificates_to_customer(self, companyId, customerCode, model): return requests.post('{}/api/v2/companies/{}/customers/{}/certificates/link'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Link two customer records together - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Link two customer records together + Links a Ship-To customer record with a Bill-To customer record. Customer records represent businesses or individuals who can provide exemption certificates. Some customers may have certificates that are linked to their shipping address or their billing address. To group these @@ -1773,19 +1773,19 @@ def link_certificates_to_customer(self, companyId, customerCode, model): of the same kind together. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company defining customers. :param code [string] The code of the bill-to customer to link. :param model [LinkCustomersModel] A list of information about ship-to customers to link to this bill-to customer. - :return CustomerModel - """ - def link_ship_to_customers_to_bill_customer(self, companyId, code, model): return requests.post('{}/api/v2/companies/{}/customers/billto/{}/shipto/link'.format(self.base_url, companyId, code), + :return CustomerModel + """ + def link_ship_to_customers_to_bill_customer(self, companyId, code, model): return requests.post('{}/api/v2/companies/{}/customers/billto/{}/shipto/link'.format(self.base_url, companyId, code), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a customer's attributes - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a customer's attributes + Retrieve the attributes linked to the customer identified by this URL. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. @@ -1800,18 +1800,18 @@ def link_ship_to_customers_to_bill_customer(self, companyId, code, model): certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded the provided customer :param customerCode [string] The unique code representing the current customer - :return FetchResult - """ - def list_attributes_for_customer(self, companyId, customerCode): return requests.get('{}/api/v2/companies/{}/customers/{}/attributes'.format(self.base_url, companyId, customerCode), + :return FetchResult + """ + def list_attributes_for_customer(self, companyId, customerCode): return requests.get('{}/api/v2/companies/{}/customers/{}/attributes'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List certificates linked to a customer - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List certificates linked to a customer + List all certificates linked to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1824,8 +1824,8 @@ def list_attributes_for_customer(self, companyId, customerCode): return r certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer :param include [string] 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. @@ -1833,14 +1833,14 @@ def list_attributes_for_customer(self, companyId, customerCode): return r :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_certificates_for_customer(self, companyId, customerCode, include=None): return requests.get('{}/api/v2/companies/{}/customers/{}/certificates'.format(self.base_url, companyId, customerCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List valid certificates for a location - + :return FetchResult + """ + def list_certificates_for_customer(self, companyId, customerCode, include=None): return requests.get('{}/api/v2/companies/{}/customers/{}/certificates'.format(self.base_url, companyId, customerCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List valid certificates for a location + List valid certificates linked to a customer in a particular country and region. This API is intended to help identify whether a customer has already provided a certificate that applies to a particular country and region. This API is intended to help you remind a customer @@ -1855,20 +1855,20 @@ def list_certificates_for_customer(self, companyId, customerCode, include=None): certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer :param country [string] Search for certificates matching this country. Uses the ISO 3166 two character country code. :param region [string] Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code. - :return ExemptionStatusModel - """ - def list_valid_certificates_for_customer(self, companyId, customerCode, country, region): return requests.get('{}/api/v2/companies/{}/customers/{}/certificates/{}/{}'.format(self.base_url, companyId, customerCode, country, region), + :return ExemptionStatusModel + """ + def list_valid_certificates_for_customer(self, companyId, customerCode, country, region): return requests.get('{}/api/v2/companies/{}/customers/{}/certificates/{}/{}'.format(self.base_url, companyId, customerCode, country, region), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all customers for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all customers for this company + List all customers recorded by this company matching the specified criteria. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1884,22 +1884,22 @@ def list_valid_certificates_for_customer(self, companyId, customerCode, country, certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param include [string] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_customers(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/customers'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Unlink attributes from a customer - + :return FetchResult + """ + def query_customers(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/customers'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Unlink attributes from a customer + Unlink one or many attributes from a customer. A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API. @@ -1914,19 +1914,19 @@ def query_customers(self, companyId, include=None): return requests.get(' certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded the customer :param customerCode [string] The unique code representing the current customer :param model [CustomerAttributeModel] The list of attributes to unlink from the customer. - :return FetchResult - """ - def unlink_attributes_from_customer(self, companyId, customerCode, model): return requests.put('{}/api/v2/companies/{}/customers/{}/attributes/unlink'.format(self.base_url, companyId, customerCode), + :return FetchResult + """ + def unlink_attributes_from_customer(self, companyId, customerCode, model): return requests.put('{}/api/v2/companies/{}/customers/{}/attributes/unlink'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Unlink certificates from a customer - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Unlink certificates from a customer + Remove one or more certificates to a customer. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1939,19 +1939,19 @@ def unlink_attributes_from_customer(self, companyId, customerCode, model): certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer :param model [LinkCertificatesModel] The list of certificates to link to this customer - :return FetchResult - """ - def unlink_certificates_from_customer(self, companyId, customerCode, model): return requests.post('{}/api/v2/companies/{}/customers/{}/certificates/unlink'.format(self.base_url, companyId, customerCode), + :return FetchResult + """ + def unlink_certificates_from_customer(self, companyId, customerCode, model): return requests.post('{}/api/v2/companies/{}/customers/{}/certificates/unlink'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single customer - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single customer + Replace the customer object at this URL with a new record. A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this @@ -1964,117 +1964,117 @@ def unlink_certificates_from_customer(self, companyId, customerCode, model): certificate storage for this company, call `RequestCertificateSetup`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The unique ID number of the company that recorded this customer :param customerCode [string] The unique code representing this customer :param model [CustomerModel] The new customer model that will replace the existing record at this URL - :return CustomerModel - """ - def update_customer(self, companyId, customerCode, model): return requests.put('{}/api/v2/companies/{}/customers/{}'.format(self.base_url, companyId, customerCode), + :return CustomerModel + """ + def update_customer(self, companyId, customerCode, model): return requests.put('{}/api/v2/companies/{}/customers/{}'.format(self.base_url, companyId, customerCode), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create and store new datasources for the respective companies. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create and store new datasources for the respective companies. + Create one or more datasource objects. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyId [int] The id of the company you which to create the datasources :param model [DataSourceModel] - :return DataSourceModel - """ - def create_data_sources(self, companyId, model): return requests.post('{}/api/v2/companies/{}/datasources'.format(self.base_url, companyId), + :return DataSourceModel + """ + def create_data_sources(self, companyId, model): return requests.post('{}/api/v2/companies/{}/datasources'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a datasource by datasource id for a company. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a datasource by datasource id for a company. + Marks the existing datasource for a company as deleted. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyId [int] The id of the company the datasource belongs to. :param id_ [int] The id of the datasource you wish to delete. - :return ErrorDetail - """ - def delete_data_source(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/datasources/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_data_source(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/datasources/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get data source by data source id - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get data source by data source id + Retrieve the data source by its unique ID number. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyId [int] :param id_ [int] data source id - :return DataSourceModel - """ - def get_data_source_by_id(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/datasources/{}'.format(self.base_url, companyId, id_), + :return DataSourceModel + """ + def get_data_source_by_id(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/datasources/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all datasources for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all datasources for this company + Gets multiple datasource objects for a given company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyId [int] The id of the company you wish to retrieve the datasources. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_data_sources(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/datasources'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all datasources - + :return FetchResult + """ + def list_data_sources(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/datasources'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all datasources + Get multiple datasource objects across all companies. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_data_sources(self, include=None): return requests.get('{}/api/v2/datasources'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a datasource identified by id for a company - + :return FetchResult + """ + def query_data_sources(self, include=None): return requests.get('{}/api/v2/datasources'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a datasource identified by id for a company + Updates a datasource for a company. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyId [int] The id of the company the datasource belongs to. :param id_ [int] The id of the datasource you wish to delete. :param model [DataSourceModel] - :return DataSourceModel - """ - def update_data_source(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/datasources/{}'.format(self.base_url, companyId, id_), + :return DataSourceModel + """ + def update_data_source(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/datasources/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Lists all parents of an HS Code. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Lists all parents of an HS Code. + Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings a list of HS Codes that are the parents and information branches of the HS Code for the given destination country, if lower detail is available. @@ -2083,186 +2083,186 @@ def update_data_source(self, companyId, id_, model): return requests.put( This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful when HS Codes can have multiple levels of generic descriptions. ### Security Policies - * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - + * This API depends on the following active services:*Required* (all): AvaTaxGlobal. + :param country [string] The name or code of the destination country. :param hsCode [string] The partial or full HS Code for which you would like to view all of the parents. - :return FetchResult - """ - def get_cross_border_code(self, country, hsCode): return requests.get('{}/api/v2/definitions/crossborder/{}/{}/hierarchy'.format(self.base_url, country, hsCode), + :return FetchResult + """ + def get_cross_border_code(self, country, hsCode): return requests.get('{}/api/v2/definitions/crossborder/{}/{}/hierarchy'.format(self.base_url, country, hsCode), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Test whether a form supports online login verification - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 form [string] The name of the form you would like to verify. This is the tax form code :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def get_login_verifier_by_form(self, form, include=None): return requests.get('{}/api/v2/definitions/filingcalendars/loginverifiers/{}'.format(self.base_url, form), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of the AvaFile Forms available - + :return FetchResult + """ + def get_login_verifier_by_form(self, form, include=None): return requests.get('{}/api/v2/definitions/filingcalendars/loginverifiers/{}'.format(self.base_url, form), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_ava_file_forms(self, include=None): return requests.get('{}/api/v2/definitions/avafileforms'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List certificate attributes used by a company - + :return FetchResult + """ + def list_ava_file_forms(self, include=None): return requests.get('{}/api/v2/definitions/avafileforms'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyid [int] 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_certificate_attributes(self, include=None): return requests.get('{}/api/v2/definitions/certificateattributes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List the certificate exempt reasons defined by a company - + :return FetchResult + """ + def list_certificate_attributes(self, include=None): return requests.get('{}/api/v2/definitions/certificateattributes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_certificate_exempt_reasons(self, include=None): return requests.get('{}/api/v2/definitions/certificateexemptreasons'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List certificate exposure zones used by a company - + :return FetchResult + """ + def list_certificate_exempt_reasons(self, include=None): return requests.get('{}/api/v2/definitions/certificateexemptreasons'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_certificate_exposure_zones(self, include=None): return requests.get('{}/api/v2/definitions/certificateexposurezones'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of communications service types - - Returns full list of service types for a given transaction type ID. - + :return FetchResult + """ + def list_certificate_exposure_zones(self, include=None): return requests.get('{}/api/v2/definitions/certificateexposurezones'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve the full list of communications service types + + Returns full list of service types for a given transaction type ID. + :param id_ [int] The transaction type ID to examine :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_communications_service_types(self, id_, include=None): return requests.get('{}/api/v2/definitions/communications/transactiontypes/{}/servicetypes'.format(self.base_url, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of communications transactiontypes - + :return FetchResult + """ + def list_communications_service_types(self, id_, include=None): return requests.get('{}/api/v2/definitions/communications/transactiontypes/{}/servicetypes'.format(self.base_url, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_communications_transaction_types(self, include=None): return requests.get('{}/api/v2/definitions/communications/transactiontypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of communications transaction/service type pairs - + :return FetchResult + """ + def list_communications_transaction_types(self, include=None): return requests.get('{}/api/v2/definitions/communications/transactiontypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_communications_t_s_pairs(self, include=None): return requests.get('{}/api/v2/definitions/communications/tspairs'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all ISO 3166 countries - + :return FetchResult + """ + def list_communications_t_s_pairs(self, include=None): return requests.get('{}/api/v2/definitions/communications/tspairs'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_countries(self, include=None): return requests.get('{}/api/v2/definitions/countries'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List certificate exposure zones used by a company - + :return FetchResult + """ + def list_countries(self, include=None): return requests.get('{}/api/v2/definitions/countries'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List certificate exposure zones used by a company + List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent. If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - check and provision account. - + check and provision account. + :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_cover_letters(self, include=None): return requests.get('{}/api/v2/definitions/coverletters'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Lists the next level of HS Codes given a destination country and HS Code prefix. - + :return FetchResult + """ + def list_cover_letters(self, include=None): return requests.get('{}/api/v2/definitions/coverletters'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Lists the next level of HS Codes given a destination country and HS Code prefix. + Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if additional children are available. HS Code is interchangeable with "tariff code" and definitions are generally unique to a destination country. @@ -2270,110 +2270,110 @@ def list_cover_letters(self, include=None): return requests.get('{}/api/v Section/Chapter/Heading/Subheading/Classification. This API is intended to be useful to identify the correct HS Code to use for your item. ### Security Policies - * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - + * This API depends on the following active services:*Required* (all): AvaTaxGlobal. + :param country [string] The name or code of the destination country. :param hsCode [string] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_cross_border_codes(self, country, hsCode, include=None): return requests.get('{}/api/v2/definitions/crossborder/{}/{}'.format(self.base_url, country, hsCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List top level HS Code Sections. - + :return FetchResult + """ + def list_cross_border_codes(self, country, hsCode, include=None): return requests.get('{}/api/v2/definitions/crossborder/{}/{}'.format(self.base_url, country, hsCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List top level HS Code Sections. + Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for classifying tariff codes and the items to which they apply. HS Codes are organized by Section/Chapter/Heading/Subheading/Classification. This API is intended to be useful to identify the top level Sections for further LandedCost HS Code lookups. ### Security Policies - * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - - :return FetchResult - """ - def list_cross_border_sections(self): return requests.get('{}/api/v2/definitions/crossborder/sections'.format(self.base_url), + * This API depends on the following active services:*Required* (all): AvaTaxGlobal. + + :return FetchResult + """ + def list_cross_border_sections(self): return requests.get('{}/api/v2/definitions/crossborder/sections'.format(self.base_url), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all ISO 4217 currencies supported by AvaTax. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_currencies(self, include=None): return requests.get('{}/api/v2/definitions/currencies'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported entity use codes - + :return FetchResult + """ + def list_currencies(self, include=None): return requests.get('{}/api/v2/definitions/currencies'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_entity_use_codes(self, include=None): return requests.get('{}/api/v2/definitions/entityusecodes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported filing frequencies. - + :return FetchResult + """ + def list_entity_use_codes(self, include=None): return requests.get('{}/api/v2/definitions/entityusecodes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_filing_frequencies(self, include=None): return requests.get('{}/api/v2/definitions/filingfrequencies'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List jurisdictions based on the filter provided - + :return FetchResult + """ + def list_filing_frequencies(self, include=None): return requests.get('{}/api/v2/definitions/filingfrequencies'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_jurisdictions(self, include=None): return requests.get('{}/api/v2/definitions/jurisdictions'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List jurisdictions near a specific address - + :return FetchResult + """ + def list_jurisdictions(self, include=None): return requests.get('{}/api/v2/definitions/jurisdictions'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 line1 [string] The first address line portion of this address. :param line2 [string] The second address line portion of this address. :param line3 [string] The third address line portion of this address. @@ -2385,21 +2385,21 @@ def list_jurisdictions(self, include=None): return requests.get('{}/api/v :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_jurisdictions_by_address(self, include=None): return requests.get('{}/api/v2/definitions/jurisdictionsnearaddress'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the list of questions that are required for a tax location - + :return FetchResult + """ + def list_jurisdictions_by_address(self, include=None): return requests.get('{}/api/v2/definitions/jurisdictionsnearaddress'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 line1 [string] The first line of this location's address. :param line2 [string] The second line of this location's address. :param line3 [string] The third line of this location's address. @@ -2413,65 +2413,65 @@ def list_jurisdictions_by_address(self, include=None): return requests.ge :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_location_questions_by_address(self, include=None): return requests.get('{}/api/v2/definitions/locationquestions'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all forms where logins can be verified automatically - + :return FetchResult + """ + def list_location_questions_by_address(self, include=None): return requests.get('{}/api/v2/definitions/locationquestions'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_login_verifiers(self, include=None): return requests.get('{}/api/v2/definitions/filingcalendars/loginverifiers'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the list of locations for a marketplace. - - Retrieves the list of suggested locations for a marketplace. - + :return FetchResult + """ + def list_login_verifiers(self, include=None): return requests.get('{}/api/v2/definitions/filingcalendars/loginverifiers'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve the list of locations for a marketplace. + + Retrieves the list of suggested locations for a marketplace. + :param marketplaceId [string] MarketplaceId of a marketplace :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_marketplace_locations(self, include=None): return requests.get('{}/api/v2/definitions/marketplacelocations'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported nexus for all countries and regions. - + :return FetchResult + """ + def list_marketplace_locations(self, include=None): return requests.get('{}/api/v2/definitions/marketplacelocations'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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, taxableNexus :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus(self, include=None): return requests.get('{}/api/v2/definitions/nexus'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all nexus that apply to a specific address. - + :return FetchResult + """ + def list_nexus(self, include=None): return requests.get('{}/api/v2/definitions/nexus'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 line1 [string] The first address line portion of this address. :param line2 [string] The first address line portion of this address. :param line3 [string] The first address line portion of this address. @@ -2483,47 +2483,47 @@ def list_nexus(self, include=None): return requests.get('{}/api/v2/defini :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus_by_address(self, include=None): return requests.get('{}/api/v2/definitions/nexus/byaddress'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported nexus for a country. - + :return FetchResult + """ + def list_nexus_by_address(self, include=None): return requests.get('{}/api/v2/definitions/nexus/byaddress'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 country [string] The country in which you want to fetch the system nexus :param filter [string] A filter statement to 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, taxableNexus :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus_by_country(self, country, include=None): return requests.get('{}/api/v2/definitions/nexus/{}'.format(self.base_url, country), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported nexus for a country and region. - + :return FetchResult + """ + def list_nexus_by_country(self, country, include=None): return requests.get('{}/api/v2/definitions/nexus/{}'.format(self.base_url, country), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 country [string] The two-character ISO-3166 code for the country. :param region [string] The two or three character region code for the region. :param filter [string] A filter statement to 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, taxableNexus :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus_by_country_and_region(self, country, region, include=None): return requests.get('{}/api/v2/definitions/nexus/{}/{}'.format(self.base_url, country, region), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List nexus related to a tax form - + :return FetchResult + """ + def list_nexus_by_country_and_region(self, country, region, include=None): return requests.get('{}/api/v2/definitions/nexus/{}/{}'.format(self.base_url, country, region), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List nexus related to a tax form + Retrieves a list of nexus related to a tax form. The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated to collect and remit transaction-based taxes. @@ -2533,609 +2533,609 @@ def list_nexus_by_country_and_region(self, country, region, include=None): a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax form in order to better understand how the form will be filled out. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 formCode [string] The form code that we are looking up the nexus for - :return NexusByTaxFormModel - """ - def list_nexus_by_form_code(self, formCode): return requests.get('{}/api/v2/definitions/nexus/byform/{}'.format(self.base_url, formCode), + :return NexusByTaxFormModel + """ + def list_nexus_by_form_code(self, formCode): return requests.get('{}/api/v2/definitions/nexus/byform/{}'.format(self.base_url, formCode), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of nexus tax type groups - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus_tax_type_groups(self, include=None): return requests.get('{}/api/v2/definitions/nexustaxtypegroups'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice customer funding options. - + :return FetchResult + """ + def list_nexus_tax_type_groups(self, include=None): return requests.get('{}/api/v2/definitions/nexustaxtypegroups'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_customer_funding_options(self, include=None): return requests.get('{}/api/v2/definitions/noticecustomerfundingoptions'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice customer types. - + :return FetchResult + """ + def list_notice_customer_funding_options(self, include=None): return requests.get('{}/api/v2/definitions/noticecustomerfundingoptions'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_customer_types(self, include=None): return requests.get('{}/api/v2/definitions/noticecustomertypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice filing types. - + :return FetchResult + """ + def list_notice_customer_types(self, include=None): return requests.get('{}/api/v2/definitions/noticecustomertypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_filingtypes(self, include=None): return requests.get('{}/api/v2/definitions/noticefilingtypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice priorities. - + :return FetchResult + """ + def list_notice_filingtypes(self, include=None): return requests.get('{}/api/v2/definitions/noticefilingtypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_priorities(self, include=None): return requests.get('{}/api/v2/definitions/noticepriorities'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice reasons. - + :return FetchResult + """ + def list_notice_priorities(self, include=None): return requests.get('{}/api/v2/definitions/noticepriorities'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_reasons(self, include=None): return requests.get('{}/api/v2/definitions/noticereasons'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice responsibility ids - + :return FetchResult + """ + def list_notice_reasons(self, include=None): return requests.get('{}/api/v2/definitions/noticereasons'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_responsibilities(self, include=None): return requests.get('{}/api/v2/definitions/noticeresponsibilities'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice root causes - + :return FetchResult + """ + def list_notice_responsibilities(self, include=None): return requests.get('{}/api/v2/definitions/noticeresponsibilities'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_root_causes(self, include=None): return requests.get('{}/api/v2/definitions/noticerootcauses'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice statuses. - + :return FetchResult + """ + def list_notice_root_causes(self, include=None): return requests.get('{}/api/v2/definitions/noticerootcauses'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_statuses(self, include=None): return requests.get('{}/api/v2/definitions/noticestatuses'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax notice types. - + :return FetchResult + """ + def list_notice_statuses(self, include=None): return requests.get('{}/api/v2/definitions/noticestatuses'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notice_types(self, include=None): return requests.get('{}/api/v2/definitions/noticetypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported extra parameters for creating transactions. - + :return FetchResult + """ + def list_notice_types(self, include=None): return requests.get('{}/api/v2/definitions/noticetypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_parameters(self, include=None): return requests.get('{}/api/v2/definitions/parameters'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the parameters by companyCode and itemCode. - + :return FetchResult + """ + def list_parameters(self, include=None): return requests.get('{}/api/v2/definitions/parameters'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyCode [string] Company code. :param itemCode [string] Item code. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_parameters_by_item(self, companyCode, itemCode, include=None): return requests.get('{}/api/v2/definitions/parameters/byitem/{}/{}'.format(self.base_url, companyCode, itemCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. - + :return FetchResult + """ + def list_parameters_by_item(self, companyCode, itemCode, include=None): return requests.get('{}/api/v2/definitions/parameters/byitem/{}/{}'.format(self.base_url, companyCode, itemCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_parameters_usage(self, include=None): return requests.get('{}/api/v2/definitions/parametersusage'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported permissions - + :return FetchResult + """ + def list_parameters_usage(self, include=None): return requests.get('{}/api/v2/definitions/parametersusage'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - :return FetchResult - """ - def list_permissions(self, include=None): return requests.get('{}/api/v2/definitions/permissions'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported postal codes. - - Retrieves the list of Avalara-supported postal codes. - + :return FetchResult + """ + def list_permissions(self, include=None): return requests.get('{}/api/v2/definitions/permissions'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve the full list of Avalara-supported postal codes. + + Retrieves the list of Avalara-supported postal codes. + :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_postal_codes(self, include=None): return requests.get('{}/api/v2/definitions/postalcodes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all customs duty programs recognized by AvaTax - + :return FetchResult + """ + def list_postal_codes(self, include=None): return requests.get('{}/api/v2/definitions/postalcodes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all customs duty programs recognized by AvaTax + List all preferred customs duty programs recognized by AvaTax. A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring countries. To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of - the program. - + the program. + :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_preferred_programs(self, include=None): return requests.get('{}/api/v2/definitions/preferredprograms'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all available product classification systems. - + :return FetchResult + """ + def list_preferred_programs(self, include=None): return requests.get('{}/api/v2/definitions/preferredprograms'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. :param countryCode [string] If not null, return all records with this code. - :return FetchResult - """ - def list_product_classification_systems(self, include=None): return requests.get('{}/api/v2/definitions/productclassificationsystems'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all product classification systems available to a company based on its nexus. - + :return FetchResult + """ + def list_product_classification_systems(self, include=None): return requests.get('{}/api/v2/definitions/productclassificationsystems'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyCode [string] The company code. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. :param countryCode [string] If not null, return all records with this code. - :return FetchResult - """ - def list_product_classification_systems_by_company(self, companyCode, include=None): return requests.get('{}/api/v2/definitions/productclassificationsystems/bycompany/{}'.format(self.base_url, companyCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of rate types for each country - + :return FetchResult + """ + def list_product_classification_systems_by_company(self, companyCode, include=None): return requests.get('{}/api/v2/definitions/productclassificationsystems/bycompany/{}'.format(self.base_url, companyCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 country [string] The country to examine for rate types :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_rate_types_by_country(self, country, include=None): return requests.get('{}/api/v2/definitions/countries/{}/ratetypes'.format(self.base_url, country), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all ISO 3166 regions - + :return FetchResult + """ + def list_rate_types_by_country(self, country, include=None): return requests.get('{}/api/v2/definitions/countries/{}/ratetypes'.format(self.base_url, country), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_regions(self, include=None): return requests.get('{}/api/v2/definitions/regions'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all ISO 3166 regions for a country - + :return FetchResult + """ + def list_regions(self, include=None): return requests.get('{}/api/v2/definitions/regions'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 country [string] The country of which you want to fetch ISO 3166 regions :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_regions_by_country(self, country, include=None): return requests.get('{}/api/v2/definitions/countries/{}/regions'.format(self.base_url, country), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported resource file types - + :return FetchResult + """ + def list_regions_by_country(self, country, include=None): return requests.get('{}/api/v2/definitions/countries/{}/regions'.format(self.base_url, country), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_resource_file_types(self, include=None): return requests.get('{}/api/v2/definitions/resourcefiletypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported permissions - + :return FetchResult + """ + def list_resource_file_types(self, include=None): return requests.get('{}/api/v2/definitions/resourcefiletypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_security_roles(self, include=None): return requests.get('{}/api/v2/definitions/securityroles'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported subscription types - + :return FetchResult + """ + def list_security_roles(self, include=None): return requests.get('{}/api/v2/definitions/securityroles'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_subscription_types(self, include=None): return requests.get('{}/api/v2/definitions/subscriptiontypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax authorities. - + :return FetchResult + """ + def list_subscription_types(self, include=None): return requests.get('{}/api/v2/definitions/subscriptiontypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_authorities(self, include=None): return requests.get('{}/api/v2/definitions/taxauthorities'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported forms for each tax authority. - + :return FetchResult + """ + def list_tax_authorities(self, include=None): return requests.get('{}/api/v2/definitions/taxauthorities'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_authority_forms(self, include=None): return requests.get('{}/api/v2/definitions/taxauthorityforms'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax authority types. - + :return FetchResult + """ + def list_tax_authority_forms(self, include=None): return requests.get('{}/api/v2/definitions/taxauthorityforms'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_authority_types(self, include=None): return requests.get('{}/api/v2/definitions/taxauthoritytypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax codes. - + :return FetchResult + """ + def list_tax_authority_types(self, include=None): return requests.get('{}/api/v2/definitions/taxauthoritytypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve the full list of Avalara-supported tax codes. + Retrieves the list of Avalara-supported system tax codes. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_codes(self, include=None): return requests.get('{}/api/v2/definitions/taxcodes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of Avalara-supported tax code types. - + :return FetchResult + """ + def list_tax_codes(self, include=None): return requests.get('{}/api/v2/definitions/taxcodes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - :return TaxCodeTypesModel - """ - def list_tax_code_types(self, include=None): return requests.get('{}/api/v2/definitions/taxcodetypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of the Tax Forms available - + :return TaxCodeTypesModel + """ + def list_tax_code_types(self, include=None): return requests.get('{}/api/v2/definitions/taxcodetypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_forms(self, include=None): return requests.get('{}/api/v2/definitions/taxforms'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of tax sub types - + :return FetchResult + """ + def list_tax_forms(self, include=None): return requests.get('{}/api/v2/definitions/taxforms'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_sub_types(self, include=None): return requests.get('{}/api/v2/definitions/taxsubtypes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve the full list of tax type groups - + :return FetchResult + """ + def list_tax_sub_types(self, include=None): return requests.get('{}/api/v2/definitions/taxsubtypes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_type_groups(self, include=None): return requests.get('{}/api/v2/definitions/taxtypegroups'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all defined units of measurement - + :return FetchResult + """ + def list_tax_type_groups(self, include=None): return requests.get('{}/api/v2/definitions/taxtypegroups'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_unit_of_measurement(self, include=None): return requests.get('{}/api/v2/definitions/unitofmeasurements'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create one or more DistanceThreshold objects - + :return FetchResult + """ + def list_unit_of_measurement(self, include=None): return requests.get('{}/api/v2/definitions/unitofmeasurements'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create one or more DistanceThreshold objects + Create one or more DistanceThreshold objects for this company. A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The unique ID number of the company that owns this DistanceThreshold :param model [CompanyDistanceThresholdModel] The DistanceThreshold object or objects you wish to create. - :return CompanyDistanceThresholdModel - """ - def create_distance_threshold(self, companyId, model): return requests.post('{}/api/v2/companies/{}/distancethresholds'.format(self.base_url, companyId), + :return CompanyDistanceThresholdModel + """ + def create_distance_threshold(self, companyId, model): return requests.post('{}/api/v2/companies/{}/distancethresholds'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single DistanceThreshold object - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single DistanceThreshold object + Marks the DistanceThreshold object identified by this URL as deleted. A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The unique ID number of the company that owns this DistanceThreshold :param id_ [int] The unique ID number of the DistanceThreshold object you wish to delete. - :return ErrorDetail - """ - def delete_distance_threshold(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/distancethresholds/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_distance_threshold(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/distancethresholds/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single DistanceThreshold - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single DistanceThreshold + Retrieves a single DistanceThreshold object defined by this URL. A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The ID of the company that owns this DistanceThreshold object :param id_ [int] The unique ID number referring to this DistanceThreshold object - :return CompanyDistanceThresholdModel - """ - def get_distance_threshold(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/distancethresholds/{}'.format(self.base_url, companyId, id_), + :return CompanyDistanceThresholdModel + """ + def get_distance_threshold(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/distancethresholds/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all DistanceThresholds for this company. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all DistanceThresholds for this company. + Lists all DistanceThreshold objects that belong to this company. A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The ID of the company whose DistanceThreshold objects you wish to list. :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_distance_thresholds(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/distancethresholds'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all DistanceThreshold objects - + :return FetchResult + """ + def list_distance_thresholds(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/distancethresholds'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all DistanceThreshold objects + Lists all DistanceThreshold objects that belong to this account. A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary @@ -3143,21 +3143,21 @@ def list_distance_thresholds(self, companyId, include=None): return reque Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_distance_thresholds(self, include=None): return requests.get('{}/api/v2/distancethresholds'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a DistanceThreshold object - + :return FetchResult + """ + def query_distance_thresholds(self, include=None): return requests.get('{}/api/v2/distancethresholds'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a DistanceThreshold object + Replace the existing DistanceThreshold object at this URL with an updated object. A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary @@ -3165,98 +3165,98 @@ def query_distance_thresholds(self, include=None): return requests.get('{ All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The unique ID number of the company that owns this DistanceThreshold object. :param id_ [int] The unique ID number of the DistanceThreshold object to replace. :param model [CompanyDistanceThresholdModel] The new DistanceThreshold object to store. - :return CompanyDistanceThresholdModel - """ - def update_distance_threshold(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/distancethresholds/{}'.format(self.base_url, companyId, id_), + :return CompanyDistanceThresholdModel + """ + def update_distance_threshold(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/distancethresholds/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new eCommerce token. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new eCommerce token. + Creates a new eCommerce token. This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 companyId [int] The company ID that will be issued this certificate. :param model [CreateECommerceTokenInputModel] - :return ECommerceTokenOutputModel - """ - def create_e_commerce_token(self, companyId, model): return requests.post('{}/api/v2/companies/{}/ecommercetokens'.format(self.base_url, companyId), + :return ECommerceTokenOutputModel + """ + def create_e_commerce_token(self, companyId, model): return requests.post('{}/api/v2/companies/{}/ecommercetokens'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Refresh an eCommerce token. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Refresh an eCommerce token. + Refresh an eCommerce token. CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 companyId [int] The company ID that the refreshed certificate belongs to. :param model [RefreshECommerceTokenInputModel] - :return FetchResult - """ - def refresh_e_commerce_token(self, companyId, model): return requests.put('{}/api/v2/companies/{}/ecommercetokens'.format(self.base_url, companyId), + :return FetchResult + """ + def refresh_e_commerce_token(self, companyId, model): return requests.put('{}/api/v2/companies/{}/ecommercetokens'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add or Edit options - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Add or Edit options + Returns a list of options for adding tax forms for the company and tax form code specified. Returns edit options when modifying a filing calendar. This API is available by invitation only. ### Security Policies - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 companyId [int] The unique ID of the company that owns the filing calendar object :param model [CycleSafeEditRequestModel] Cycle Safe Options Request - :return CycleSafeOptionResultModel - """ - def cycle_safe_options(self, companyId, model): return requests.post('{}/api/v2/companies/{}/filingcalendars/edit/cycleSafeOptions'.format(self.base_url, companyId), + :return CycleSafeOptionResultModel + """ + def cycle_safe_options(self, companyId, model): return requests.post('{}/api/v2/companies/{}/filingcalendars/edit/cycleSafeOptions'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a company return setting - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The unique ID of the company :param filingCalendarId [int] The unique ID of the filing calendar that will remove setting :param companyReturnSettingId [int] The unique ID of the company return setting that will be deleted from the filing calendar - :return CompanyReturnSettingModel - """ - def delete_company_return_settings(self, companyId, filingCalendarId, companyReturnSettingId): return requests.delete('{}/api/v2/companies/{}/filingcalendars/{}/setting/{}'.format(self.base_url, companyId, filingCalendarId, companyReturnSettingId), + :return CompanyReturnSettingModel + """ + def delete_company_return_settings(self, companyId, filingCalendarId, companyReturnSettingId): return requests.delete('{}/api/v2/companies/{}/filingcalendars/{}/setting/{}'.format(self.base_url, companyId, filingCalendarId, companyReturnSettingId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a filing containing the return and all its accrual returns. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a filing containing the return and all its accrual returns. + ### 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 companyId [int] The ID of the company that owns these returns :param filingReturnId [int] The ID of the filing return - :return FetchResult - """ - def get_accrual_filings(self, companyId, filingReturnId): return requests.get('{}/api/v2/companies/{}/filings/accrual/{}'.format(self.base_url, companyId, filingReturnId), + :return FetchResult + """ + def get_accrual_filings(self, companyId, filingReturnId): return requests.get('{}/api/v2/companies/{}/filings/accrual/{}'.format(self.base_url, companyId, filingReturnId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a list of filed returns for the specified company in the year and month of a given filing period. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns these batches :param endPeriodMonth [int] The month of the period you are trying to retrieve :param endPeriodYear [int] The year of the period you are trying to retrieve @@ -3266,27 +3266,27 @@ def get_accrual_filings(self, companyId, filingReturnId): return requests :param region [string] The region of the return(s) you are trying to retrieve :param filingCalendarId [int] The filing calendar id of the return you are trying to retrieve :param taxformCode [string] The unique tax form code of the form. - :return FetchResult - """ - def get_filed_returns(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/filings/returns/filed'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Approves linkage to a firm for a client account - + :return FetchResult + """ + def get_filed_returns(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/filings/returns/filed'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] - :return FirmClientLinkageOutputModel - """ - def approve_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/approve'.format(self.base_url, id_), + :return FirmClientLinkageOutputModel + """ + def approve_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/approve'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Request a new FirmClient account and create an approved linkage to it - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Request a new FirmClient account and create an approved linkage to it + This API is for use by Firms only. Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. Firms can create accounts of FirmClient for customers they are managing using this API. @@ -3295,108 +3295,108 @@ def approve_firm_client_linkage(self, id_): return requests.post('{}/api/ You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm. The created account will be created in `Active` status but there will be no user or license key associated with account. ### Security Policies - * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. - + * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. + :param model [NewFirmClientAccountRequestModel] Information about the account you wish to create. - :return FirmClientLinkageOutputModel - """ - def create_and_link_new_firm_client_account(self, model): return requests.post('{}/api/v2/firmclientlinkages/createandlinkclient'.format(self.base_url), + :return FirmClientLinkageOutputModel + """ + def create_and_link_new_firm_client_account(self, model): return requests.post('{}/api/v2/firmclientlinkages/createandlinkclient'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Links a firm account with the client account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param model [FirmClientLinkageInputModel] FirmClientLinkageInputModel - :return FirmClientLinkageOutputModel - """ - def create_firm_client_linkage(self, model): return requests.post('{}/api/v2/firmclientlinkages'.format(self.base_url), + :return FirmClientLinkageOutputModel + """ + def create_firm_client_linkage(self, model): return requests.post('{}/api/v2/firmclientlinkages'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a linkage - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] - :return ErrorDetail - """ - def delete_firm_client_linkage(self, id_): return requests.delete('{}/api/v2/firmclientlinkages/{}'.format(self.base_url, id_), + :return ErrorDetail + """ + def delete_firm_client_linkage(self, id_): return requests.delete('{}/api/v2/firmclientlinkages/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get linkage between a firm and client by id - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] - :return FirmClientLinkageOutputModel - """ - def get_firm_client_linkage(self, id_): return requests.get('{}/api/v2/firmclientlinkages/{}'.format(self.base_url, id_), + :return FirmClientLinkageOutputModel + """ + def get_firm_client_linkage(self, id_): return requests.get('{}/api/v2/firmclientlinkages/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List client linkages for a firm or client - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 filter [string] A filter statement to 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 - """ - def list_firm_client_linkage(self, include=None): return requests.get('{}/api/v2/firmclientlinkages'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Rejects linkage to a firm for a client account - + :return FetchResult + """ + def list_firm_client_linkage(self, include=None): return requests.get('{}/api/v2/firmclientlinkages'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] - :return FirmClientLinkageOutputModel - """ - def reject_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/reject'.format(self.base_url, id_), + :return FirmClientLinkageOutputModel + """ + def reject_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/reject'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Reset linkage status between a client and firm back to requested - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] - :return FirmClientLinkageOutputModel - """ - def reset_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/reset'.format(self.base_url, id_), + :return FirmClientLinkageOutputModel + """ + def reset_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/reset'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Revokes previously approved linkage to a firm for a client account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 id_ [int] - :return FirmClientLinkageOutputModel - """ - def revoke_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/revoke'.format(self.base_url, id_), + :return FirmClientLinkageOutputModel + """ + def revoke_firm_client_linkage(self, id_): return requests.post('{}/api/v2/firmclientlinkages/{}/revoke'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - FREE API - Request a free trial of AvaTax - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + FREE API - Request a free trial of AvaTax + Call this API to obtain a free AvaTax account. This API is free to use. No authentication credentials are required to call this API. You must read and accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be @@ -3405,17 +3405,17 @@ def revoke_firm_client_linkage(self, id_): return requests.post('{}/api/v available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/). After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/). ### Security Policies - * This API may be called without providing authentication credentials. - + * This API may be called without providing authentication credentials. + :param model [FreeTrialRequestModel] Required information to provision a free trial account. - :return NewAccountModel - """ - def request_free_trial(self, model): return requests.post('{}/api/v2/accounts/freetrials/request'.format(self.base_url), + :return NewAccountModel + """ + def request_free_trial(self, model): return requests.post('{}/api/v2/accounts/freetrials/request'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Request the javascript for a funding setup widget - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 @@ -3430,17 +3430,17 @@ def request_free_trial(self, model): return requests.post('{}/api/v2/acco This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 id_ [int] The unique ID number of this funding request - :return FundingStatusModel - """ - def activate_funding_request(self, id_): return requests.get('{}/api/v2/fundingrequests/{}/widget'.format(self.base_url, id_), + :return FundingStatusModel + """ + def activate_funding_request(self, id_): return requests.get('{}/api/v2/fundingrequests/{}/widget'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve status about a funding setup request - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 @@ -3453,68 +3453,68 @@ def activate_funding_request(self, id_): return requests.get('{}/api/v2/f This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 id_ [int] The unique ID number of this funding request - :return FundingStatusModel - """ - def funding_request_status(self, id_): return requests.get('{}/api/v2/fundingrequests/{}'.format(self.base_url, id_), + :return FundingStatusModel + """ + def funding_request_status(self, id_): return requests.get('{}/api/v2/fundingrequests/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete all classifications for an item - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete all classifications for an item + Delete all the classifications for a given item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this item. :param itemId [int] The ID of the item you wish to delete the classifications. - :return ErrorDetail - """ - def batch_delete_item_classifications(self, companyId, itemId): return requests.delete('{}/api/v2/companies/{}/items/{}/classifications'.format(self.base_url, companyId, itemId), + :return ErrorDetail + """ + def batch_delete_item_classifications(self, companyId, itemId): return requests.delete('{}/api/v2/companies/{}/items/{}/classifications'.format(self.base_url, companyId, itemId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete all parameters for an item - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete all parameters for an item + Delete all the parameters for a given item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this item. :param itemId [int] The ID of the item you wish to delete the parameters. - :return ErrorDetail - """ - def batch_delete_item_parameters(self, companyId, itemId): return requests.delete('{}/api/v2/companies/{}/items/{}/parameters'.format(self.base_url, companyId, itemId), + :return ErrorDetail + """ + def batch_delete_item_parameters(self, companyId, itemId): return requests.delete('{}/api/v2/companies/{}/items/{}/parameters'.format(self.base_url, companyId, itemId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add classifications to an item. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Add classifications to an item. + Add classifications to an item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. An item may only have one classification per tax system. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param itemId [int] The item id. :param model [ItemClassificationInputModel] The item classifications you wish to create. - :return ItemClassificationOutputModel - """ - def create_item_classifications(self, companyId, itemId, model): return requests.post('{}/api/v2/companies/{}/items/{}/classifications'.format(self.base_url, companyId, itemId), + :return ItemClassificationOutputModel + """ + def create_item_classifications(self, companyId, itemId, model): return requests.post('{}/api/v2/companies/{}/items/{}/classifications'.format(self.base_url, companyId, itemId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add parameters to an item. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Add parameters to an item. + Add parameters to an item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . @@ -3522,19 +3522,19 @@ def create_item_classifications(self, companyId, itemId, model): return r To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this item parameter. :param itemId [int] The item id. :param model [ItemParameterModel] The item parameters you wish to create. - :return ItemParameterModel - """ - def create_item_parameters(self, companyId, itemId, model): return requests.post('{}/api/v2/companies/{}/items/{}/parameters'.format(self.base_url, companyId, itemId), + :return ItemParameterModel + """ + def create_item_parameters(self, companyId, itemId, model): return requests.post('{}/api/v2/companies/{}/items/{}/parameters'.format(self.base_url, companyId, itemId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new item - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new item + Creates one or more new item objects attached to this company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, @@ -3543,18 +3543,18 @@ def create_item_parameters(self, companyId, itemId, model): return reques team can manage your item catalog and adjust the tax behavior of items without having to modify your software. The tax code takes precedence over the tax code id if both are provided. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this item. :param model [ItemModel] The item you wish to create. - :return ItemModel - """ - def create_items(self, companyId, model): return requests.post('{}/api/v2/companies/{}/items'.format(self.base_url, companyId), + :return ItemModel + """ + def create_items(self, companyId, model): return requests.post('{}/api/v2/companies/{}/items'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single item - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single item + Deletes the item object at this URL. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, @@ -3563,53 +3563,53 @@ def create_items(self, companyId, model): return requests.post('{}/api/v2 team can manage your item catalog and adjust the tax behavior of items without having to modify your software. Deleting an item will also delete the parameters and classifications associated with that item. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this item. :param id_ [int] The ID of the item you wish to delete. - :return ErrorDetail - """ - def delete_item(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/items/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_item(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/items/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single item classification. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single item classification. + Delete a single item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param itemId [int] The item id. :param id_ [int] The item classification id. - :return ErrorDetail - """ - def delete_item_classification(self, companyId, itemId, id_): return requests.delete('{}/api/v2/companies/{}/items/{}/classifications/{}'.format(self.base_url, companyId, itemId, id_), + :return ErrorDetail + """ + def delete_item_classification(self, companyId, itemId, id_): return requests.delete('{}/api/v2/companies/{}/items/{}/classifications/{}'.format(self.base_url, companyId, itemId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single item parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single item parameter + Delete a single item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id :param itemId [int] The item id :param id_ [int] The parameter id - :return ErrorDetail - """ - def delete_item_parameter(self, companyId, itemId, id_): return requests.delete('{}/api/v2/companies/{}/items/{}/parameters/{}'.format(self.base_url, companyId, itemId, id_), + :return ErrorDetail + """ + def delete_item_parameter(self, companyId, itemId, id_): return requests.delete('{}/api/v2/companies/{}/items/{}/parameters/{}'.format(self.base_url, companyId, itemId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single item - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single item + Get the `Item` object identified by this URL. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, @@ -3617,76 +3617,76 @@ def delete_item_parameter(self, companyId, itemId, id_): return requests. from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns this item object :param id_ [int] The primary key of this item :param include [string] A comma separated list of additional data to retrieve. - :return ItemModel - """ - def get_item(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/items/{}'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single item classification. - + :return ItemModel + """ + def get_item(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/items/{}'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single item classification. + Retrieve a single item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The company id. :param itemId [int] The item id. :param id_ [int] The item classification id. - :return ItemClassificationOutputModel - """ - def get_item_classification(self, companyId, itemId, id_): return requests.get('{}/api/v2/companies/{}/items/{}/classifications/{}'.format(self.base_url, companyId, itemId, id_), + :return ItemClassificationOutputModel + """ + def get_item_classification(self, companyId, itemId, id_): return requests.get('{}/api/v2/companies/{}/items/{}/classifications/{}'.format(self.base_url, companyId, itemId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single item parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single item parameter + Retrieve a single item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The company id :param itemId [int] The item id :param id_ [int] The parameter id - :return ItemParameterModel - """ - def get_item_parameter(self, companyId, itemId, id_): return requests.get('{}/api/v2/companies/{}/items/{}/parameters/{}'.format(self.base_url, companyId, itemId, id_), + :return ItemParameterModel + """ + def get_item_parameter(self, companyId, itemId, id_): return requests.get('{}/api/v2/companies/{}/items/{}/parameters/{}'.format(self.base_url, companyId, itemId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve classifications for an item. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve classifications for an item. + List classifications for an item. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. Search for specific objects using the criteria in the `$filter` classification; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` classifications. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The company id. :param itemId [int] The item id. :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_item_classifications(self, companyId, itemId, include=None): return requests.get('{}/api/v2/companies/{}/items/{}/classifications'.format(self.base_url, companyId, itemId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve parameters for an item - + :return FetchResult + """ + def list_item_classifications(self, companyId, itemId, include=None): return requests.get('{}/api/v2/companies/{}/items/{}/classifications'.format(self.base_url, companyId, itemId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve parameters for an item + List parameters for an item. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . @@ -3694,22 +3694,22 @@ def list_item_classifications(self, companyId, itemId, include=None): ret Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The company id :param itemId [int] The item id :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_item_parameters(self, companyId, itemId, include=None): return requests.get('{}/api/v2/companies/{}/items/{}/parameters'.format(self.base_url, companyId, itemId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve items for this company - + :return FetchResult + """ + def list_item_parameters(self, companyId, itemId, include=None): return requests.get('{}/api/v2/companies/{}/items/{}/parameters'.format(self.base_url, companyId, itemId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve items for this company + List all items defined for the current company. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, @@ -3722,22 +3722,22 @@ def list_item_parameters(self, companyId, itemId, include=None): return r * Parameters * Classifications ### 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 companyId [int] The ID of the company that defined these items :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_items_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/items'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all items - + :return FetchResult + """ + def list_items_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/items'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all items + Get multiple item objects across all companies. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, @@ -3747,21 +3747,21 @@ def list_items_by_company(self, companyId, include=None): return requests Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_items(self, include=None): return requests.get('{}/api/v2/items'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Sync items from a product catalog - + :return FetchResult + """ + def query_items(self, include=None): return requests.get('{}/api/v2/items'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Sync items from a product catalog + Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs with AvaTax. Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information. @@ -3772,18 +3772,18 @@ def query_items(self, include=None): return requests.get('{}/api/v2/items from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance team can manage your item catalog and adjust the tax behavior of items without having to modify your software. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this item. :param model [SyncItemsRequestModel] The request object. - :return SyncItemsResponseModel - """ - def sync_items(self, companyId, model): return requests.post('{}/api/v2/companies/{}/items/sync'.format(self.base_url, companyId), + :return SyncItemsResponseModel + """ + def sync_items(self, companyId, model): return requests.post('{}/api/v2/companies/{}/items/sync'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single item - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single item + Replace the existing `Item` object at this URL with an updated object. Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions, @@ -3794,107 +3794,107 @@ def sync_items(self, companyId, model): return requests.post('{}/api/v2/c you may either set its value to null or omit that field from the object you post. The tax code takes precedence over the tax code id if both are provided. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that this item belongs to. :param id_ [int] The ID of the item you wish to update :param model [ItemModel] The item object you wish to update. - :return ItemModel - """ - def update_item(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/items/{}'.format(self.base_url, companyId, id_), + :return ItemModel + """ + def update_item(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/items/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update an item classification. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update an item classification. + Update an item classification. A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate. An item may only have one classification per tax system. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param itemId [int] The item id. :param id_ [int] The item classification id. :param model [ItemClassificationInputModel] The item object you wish to update. - :return ItemClassificationOutputModel - """ - def update_item_classification(self, companyId, itemId, id_, model): return requests.put('{}/api/v2/companies/{}/items/{}/classifications/{}'.format(self.base_url, companyId, itemId, id_), + :return ItemClassificationOutputModel + """ + def update_item_classification(self, companyId, itemId, id_, model): return requests.put('{}/api/v2/companies/{}/items/{}/classifications/{}'.format(self.base_url, companyId, itemId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update an item parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update an item parameter + Update an item parameter. Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item . A parameter specified on a transaction line will override an item parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param itemId [int] The item id :param id_ [int] The item parameter id :param model [ItemParameterModel] The item object you wish to update. - :return ItemParameterModel - """ - def update_item_parameter(self, companyId, itemId, id_, model): return requests.put('{}/api/v2/companies/{}/items/{}/parameters/{}'.format(self.base_url, companyId, itemId, id_), + :return ItemParameterModel + """ + def update_item_parameter(self, companyId, itemId, id_, model): return requests.put('{}/api/v2/companies/{}/items/{}/parameters/{}'.format(self.base_url, companyId, itemId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create one or more overrides - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create one or more overrides + Creates one or more jurisdiction override objects for this account. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param accountId [int] The ID of the account that owns this override :param model [JurisdictionOverrideModel] The jurisdiction override objects to create - :return JurisdictionOverrideModel - """ - def create_jurisdiction_overrides(self, accountId, model): return requests.post('{}/api/v2/accounts/{}/jurisdictionoverrides'.format(self.base_url, accountId), + :return JurisdictionOverrideModel + """ + def create_jurisdiction_overrides(self, accountId, model): return requests.post('{}/api/v2/accounts/{}/jurisdictionoverrides'.format(self.base_url, accountId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single override - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 accountId [int] The ID of the account that owns this override :param id_ [int] The ID of the override you wish to delete - :return ErrorDetail - """ - def delete_jurisdiction_override(self, accountId, id_): return requests.delete('{}/api/v2/accounts/{}/jurisdictionoverrides/{}'.format(self.base_url, accountId, id_), + :return ErrorDetail + """ + def delete_jurisdiction_override(self, accountId, id_): return requests.delete('{}/api/v2/accounts/{}/jurisdictionoverrides/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single override - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single override + Get the item object identified by this URL. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param accountId [int] The ID of the account that owns this override :param id_ [int] The primary key of this override - :return JurisdictionOverrideModel - """ - def get_jurisdiction_override(self, accountId, id_): return requests.get('{}/api/v2/accounts/{}/jurisdictionoverrides/{}'.format(self.base_url, accountId, id_), + :return JurisdictionOverrideModel + """ + def get_jurisdiction_override(self, accountId, id_): return requests.get('{}/api/v2/accounts/{}/jurisdictionoverrides/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve overrides for this account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve overrides for this account + List all jurisdiction override objects defined for this account. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary @@ -3903,22 +3903,22 @@ def get_jurisdiction_override(self, accountId, id_): return requests.get( Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param accountId [int] The ID of the account that owns this override :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_jurisdiction_overrides_by_account(self, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/jurisdictionoverrides'.format(self.base_url, accountId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all overrides - + :return FetchResult + """ + def list_jurisdiction_overrides_by_account(self, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/jurisdictionoverrides'.format(self.base_url, accountId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all overrides + Get multiple jurisdiction override objects across all companies. A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary @@ -3927,36 +3927,36 @@ def list_jurisdiction_overrides_by_account(self, accountId, include=None): Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_jurisdiction_overrides(self, include=None): return requests.get('{}/api/v2/jurisdictionoverrides'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single jurisdictionoverride - + :return FetchResult + """ + def query_jurisdiction_overrides(self, include=None): return requests.get('{}/api/v2/jurisdictionoverrides'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 accountId [int] The ID of the account that this jurisdictionoverride belongs to. :param id_ [int] The ID of the jurisdictionoverride you wish to update :param model [JurisdictionOverrideModel] The jurisdictionoverride object you wish to update. - :return JurisdictionOverrideModel - """ - def update_jurisdiction_override(self, accountId, id_, model): return requests.put('{}/api/v2/accounts/{}/jurisdictionoverrides/{}'.format(self.base_url, accountId, id_), + :return JurisdictionOverrideModel + """ + def update_jurisdiction_override(self, accountId, id_, model): return requests.put('{}/api/v2/accounts/{}/jurisdictionoverrides/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add parameters to a location. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Add parameters to a location. + Add parameters to a location. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. @@ -3964,65 +3964,65 @@ def update_jurisdiction_override(self, accountId, id_, model): return req To see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company` Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this location parameter. :param locationId [int] The location id. :param model [LocationParameterModel] The location parameters you wish to create. - :return LocationParameterModel - """ - def create_location_parameters(self, companyId, locationId, model): return requests.post('{}/api/v2/companies/{}/locations/{}/parameters'.format(self.base_url, companyId, locationId), + :return LocationParameterModel + """ + def create_location_parameters(self, companyId, locationId, model): return requests.post('{}/api/v2/companies/{}/locations/{}/parameters'.format(self.base_url, companyId, locationId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new location - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this location. :param model [LocationModel] The location you wish to create. - :return LocationModel - """ - def create_locations(self, companyId, model): return requests.post('{}/api/v2/companies/{}/locations'.format(self.base_url, companyId), + :return LocationModel + """ + def create_locations(self, companyId, model): return requests.post('{}/api/v2/companies/{}/locations'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single location - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this location. :param id_ [int] The ID of the location you wish to delete. - :return ErrorDetail - """ - def delete_location(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/locations/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_location(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/locations/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single location parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single location parameter + Delete a single location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id :param locationId [int] The location id :param id_ [int] The parameter id - :return ErrorDetail - """ - def delete_location_parameter(self, companyId, locationId, id_): return requests.delete('{}/api/v2/companies/{}/locations/{}/parameters/{}'.format(self.base_url, companyId, locationId, id_), + :return ErrorDetail + """ + def delete_location_parameter(self, companyId, locationId, id_): return requests.delete('{}/api/v2/companies/{}/locations/{}/parameters/{}'.format(self.base_url, companyId, locationId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single location - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -4032,37 +4032,37 @@ def delete_location_parameter(self, companyId, locationId, id_): return r * LocationSettings * parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The ID of the company that owns this location :param id_ [int] The primary key of this location :param include [string] A comma separated list of additional data to retrieve. - :return LocationModel - """ - def get_location(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/locations/{}'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single company location parameter - + :return LocationModel + """ + def get_location(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/locations/{}'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single company location parameter + Retrieve a single location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The company id :param locationId [int] The location id :param id_ [int] The parameter id - :return LocationParameterModel - """ - def get_location_parameter(self, companyId, locationId, id_): return requests.get('{}/api/v2/companies/{}/locations/{}/parameters/{}'.format(self.base_url, companyId, locationId, id_), + :return LocationParameterModel + """ + def get_location_parameter(self, companyId, locationId, id_): return requests.get('{}/api/v2/companies/{}/locations/{}/parameters/{}'.format(self.base_url, companyId, locationId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve parameters for a location - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve parameters for a location + List parameters for a location. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. @@ -4070,22 +4070,22 @@ def get_location_parameter(self, companyId, locationId, id_): return requ Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The company id :param locationId [int] The ID of the location :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_location_parameters(self, companyId, locationId, include=None): return requests.get('{}/api/v2/companies/{}/locations/{}/parameters'.format(self.base_url, companyId, locationId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve locations for this company - + :return FetchResult + """ + def list_location_parameters(self, companyId, locationId, include=None): return requests.get('{}/api/v2/companies/{}/locations/{}/parameters'.format(self.base_url, companyId, locationId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -4097,22 +4097,22 @@ def list_location_parameters(self, companyId, locationId, include=None): * LocationSettings * parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The ID of the company that owns these locations :param filter [string] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters :param include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_locations_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/locations'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all locations - + :return FetchResult + """ + def list_locations_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/locations'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -4124,73 +4124,73 @@ def list_locations_by_company(self, companyId, include=None): return requ * LocationSettings * parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param filter [string] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters :param include [string] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_locations(self, include=None): return requests.get('{}/api/v2/locations'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single location - + :return FetchResult + """ + def query_locations(self, include=None): return requests.get('{}/api/v2/locations'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that this location belongs to. :param id_ [int] The ID of the location you wish to update :param model [LocationModel] The location you wish to update. - :return LocationModel - """ - def update_location(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/locations/{}'.format(self.base_url, companyId, id_), + :return LocationModel + """ + def update_location(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/locations/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a location parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a location parameter + Update a location parameter. Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location. A parameter specified on a transaction line will override a location parameter if they share the same parameter name. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param locationId [int] The location id :param id_ [int] The location parameter id :param model [LocationParameterModel] The location parameter object you wish to update. - :return LocationParameterModel - """ - def update_location_parameter(self, companyId, locationId, id_, model): return requests.put('{}/api/v2/companies/{}/locations/{}/parameters/{}'.format(self.base_url, companyId, locationId, id_), + :return LocationParameterModel + """ + def update_location_parameter(self, companyId, locationId, id_, model): return requests.put('{}/api/v2/companies/{}/locations/{}/parameters/{}'.format(self.base_url, companyId, locationId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Validate the location against local requirements - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Validate the location against local requirements + Returns validation information for this location. This API call is intended to compare this location against the currently known taxing authority rules and regulations, and provide information about what additional work is required to completely setup this location. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + :param companyId [int] The ID of the company that owns this location :param id_ [int] The primary key of this location - :return LocationValidationModel - """ - def validate_location(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/locations/{}/validate'.format(self.base_url, companyId, id_), + :return LocationValidationModel + """ + def validate_location(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/locations/{}/validate'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Adjust a MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Adjust a MultiDocument transaction + Adjusts the current MultiDocument transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). @@ -4206,20 +4206,20 @@ def validate_location(self, companyId, id_): return requests.get('{}/api/ * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param code [string] The transaction code for this MultiDocument transaction :param type [DocumentType] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) :param include [string] Specifies objects to include in this fetch call :param model [AdjustMultiDocumentModel] The adjust request you wish to execute - :return MultiDocumentModel - """ - def adjust_multi_document_transaction(self, code, type, model, include=None): return requests.post('{}/api/v2/transactions/multidocument/{}/type/{}/adjust'.format(self.base_url, code, type), + :return MultiDocumentModel + """ + def adjust_multi_document_transaction(self, code, type, model, include=None): return requests.post('{}/api/v2/transactions/multidocument/{}/type/{}/adjust'.format(self.base_url, code, type), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get audit information about a MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get audit information about a MultiDocument transaction + Retrieve audit information about a MultiDocument transaction stored in AvaTax. The audit API retrieves audit information related to a specific MultiDocument transaction. This audit information includes the following: @@ -4240,18 +4240,18 @@ def adjust_multi_document_transaction(self, code, type, model, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param code [string] The transaction code for this MultiDocument transaction :param type [DocumentType] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) - :return AuditMultiDocumentModel - """ - def audit_multi_document_transaction(self, code, type): return requests.get('{}/api/v2/transactions/multidocument/{}/type/{}/audit'.format(self.base_url, code, type), + :return AuditMultiDocumentModel + """ + def audit_multi_document_transaction(self, code, type): return requests.get('{}/api/v2/transactions/multidocument/{}/type/{}/audit'.format(self.base_url, code, type), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Commit a MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Commit a MultiDocument transaction + Marks a list of transactions by changing its status to `Committed`. Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -4266,17 +4266,17 @@ def audit_multi_document_transaction(self, code, type): return requests.g * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param model [CommitMultiDocumentModel] The commit request you wish to execute - :return MultiDocumentModel - """ - def commit_multi_document_transaction(self, model): return requests.post('{}/api/v2/transactions/multidocument/commit'.format(self.base_url), + :return MultiDocumentModel + """ + def commit_multi_document_transaction(self, model): return requests.post('{}/api/v2/transactions/multidocument/commit'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new MultiDocument transaction + Records a new MultiDocument transaction in AvaTax. A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within @@ -4310,18 +4310,18 @@ def commit_multi_document_transaction(self, model): return requests.post( * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param include [string] Specifies objects to include in the response after transaction is created :param model [CreateMultiDocumentModel] the multi document transaction model - :return MultiDocumentModel - """ - def create_multi_document_transaction(self, model, include=None): return requests.post('{}/api/v2/transactions/multidocument'.format(self.base_url), + :return MultiDocumentModel + """ + def create_multi_document_transaction(self, model, include=None): return requests.post('{}/api/v2/transactions/multidocument'.format(self.base_url), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a MultiDocument transaction + Get the current MultiDocument transaction identified by this URL. If this transaction was adjusted, the return value of this API will be the current transaction with this code. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: @@ -4340,19 +4340,19 @@ def create_multi_document_transaction(self, model, include=None): return * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param code [string] The multidocument code to retrieve :param type [DocumentType] The transaction type to retrieve (See DocumentType::* for a list of allowable values) :param include [string] Specifies objects to include in the response after transaction is created - :return MultiDocumentModel - """ - def get_multi_document_transaction_by_code_and_type(self, code, type, include=None): return requests.get('{}/api/v2/transactions/multidocument/{}/type/{}'.format(self.base_url, code, type), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a MultiDocument transaction by ID - + :return MultiDocumentModel + """ + def get_multi_document_transaction_by_code_and_type(self, code, type, include=None): return requests.get('{}/api/v2/transactions/multidocument/{}/type/{}'.format(self.base_url, code, type), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a MultiDocument transaction by ID + Get the unique MultiDocument transaction identified by this URL. A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within @@ -4378,18 +4378,18 @@ def get_multi_document_transaction_by_code_and_type(self, code, type, include=No * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param id_ [int] The unique ID number of the MultiDocument transaction to retrieve :param include [string] Specifies objects to include in the response after transaction is created - :return MultiDocumentModel - """ - def get_multi_document_transaction_by_id(self, id_, include=None): return requests.get('{}/api/v2/transactions/multidocument/{}'.format(self.base_url, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all MultiDocument transactions - + :return MultiDocumentModel + """ + def get_multi_document_transaction_by_id(self, id_, include=None): return requests.get('{}/api/v2/transactions/multidocument/{}'.format(self.base_url, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all MultiDocument transactions + List all MultiDocument transactions within this account. This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument transactions, please use the pagination features of the API. @@ -4413,21 +4413,21 @@ def get_multi_document_transaction_by_id(self, id_, include=None): return * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param filter [string] A filter statement to 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 include [string] Specifies objects to include in the response after transaction is created :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_multi_document_transactions(self, include=None): return requests.get('{}/api/v2/transactions/multidocument'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a refund for a MultiDocument transaction - + :return FetchResult + """ + def list_multi_document_transactions(self, include=None): return requests.get('{}/api/v2/transactions/multidocument'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a refund for a MultiDocument transaction + Create a refund for a MultiDocument transaction. A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within @@ -4464,20 +4464,20 @@ def list_multi_document_transactions(self, include=None): return requests * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param code [string] The code of this MultiDocument transaction :param type [DocumentType] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values) :param include [string] Specifies objects to include in the response after transaction is created :param model [RefundTransactionModel] Information about the refund to create - :return MultiDocumentModel - """ - def refund_multi_document_transaction(self, code, type, model, include=None): return requests.post('{}/api/v2/transactions/multidocument/{}/type/{}/refund'.format(self.base_url, code, type), + :return MultiDocumentModel + """ + def refund_multi_document_transaction(self, code, type, model, include=None): return requests.post('{}/api/v2/transactions/multidocument/{}/type/{}/refund'.format(self.base_url, code, type), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Verify a MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Verify a MultiDocument transaction + Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values. If the transaction does not match these expected values, this API will return an error code indicating which value did not match. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -4491,17 +4491,17 @@ def refund_multi_document_transaction(self, code, type, model, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param model [VerifyMultiDocumentModel] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax - :return MultiDocumentModel - """ - def verify_multi_document_transaction(self, model): return requests.post('{}/api/v2/transactions/multidocument/verify'.format(self.base_url), + :return MultiDocumentModel + """ + def verify_multi_document_transaction(self, model): return requests.post('{}/api/v2/transactions/multidocument/verify'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Void a MultiDocument transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Void a MultiDocument transaction + Voids the current transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). @@ -4517,19 +4517,19 @@ def verify_multi_document_transaction(self, model): return requests.post( * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param code [string] The transaction code for this MultiDocument transaction :param type [DocumentType] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) :param model [VoidTransactionModel] The void request you wish to execute - :return MultiDocumentModel - """ - def void_multi_document_transaction(self, code, type, model): return requests.post('{}/api/v2/transactions/multidocument/{}/type/{}/void'.format(self.base_url, code, type), + :return MultiDocumentModel + """ + def void_multi_document_transaction(self, code, type, model): return requests.post('{}/api/v2/transactions/multidocument/{}/type/{}/void'.format(self.base_url, code, type), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new nexus - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new nexus + Creates one or more new nexus declarations attached to this company. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4545,18 +4545,18 @@ def void_multi_document_transaction(self, code, type, model): return requ Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this nexus. :param model [NexusModel] The nexus you wish to create. - :return NexusModel - """ - def create_nexus(self, companyId, model): return requests.post('{}/api/v2/companies/{}/nexus'.format(self.base_url, companyId), + :return NexusModel + """ + def create_nexus(self, companyId, model): return requests.post('{}/api/v2/companies/{}/nexus'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add parameters to a nexus. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -4564,19 +4564,19 @@ def create_nexus(self, companyId, model): return requests.post('{}/api/v2 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. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this nexus parameter. :param nexusId [int] The nexus id. :param model [NexusParameterDetailModel] The nexus parameters you wish to create. - :return NexusParameterDetailModel - """ - def create_nexus_parameters(self, companyId, nexusId, model): return requests.post('{}/api/v2/companies/{}/nexus/{}/parameters'.format(self.base_url, companyId, nexusId), + :return NexusParameterDetailModel + """ + def create_nexus_parameters(self, companyId, nexusId, model): return requests.post('{}/api/v2/companies/{}/nexus/{}/parameters'.format(self.base_url, companyId, nexusId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Creates nexus for a list of addresses. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -4589,18 +4589,18 @@ def create_nexus_parameters(self, companyId, nexusId, model): return requ Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that will own this nexus. :param model [DeclareNexusByAddressModel] The nexus you wish to create. - :return NexusByAddressModel - """ - def declare_nexus_by_address(self, companyId, model): return requests.post('{}/api/v2/companies/{}/nexus/byaddress'.format(self.base_url, companyId), + :return NexusByAddressModel + """ + def declare_nexus_by_address(self, companyId, model): return requests.post('{}/api/v2/companies/{}/nexus/byaddress'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single nexus - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single nexus + Marks the existing nexus object at this URL as deleted. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4608,54 +4608,54 @@ def declare_nexus_by_address(self, companyId, model): return requests.pos Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this nexus. :param id_ [int] The ID of the nexus you wish to delete. :param cascadeDelete [boolean] If true, deletes all the child nexus if they exist along with parent nexus - :return ErrorDetail - """ - def delete_nexus(self, companyId, id_, include=None): return requests.delete('{}/api/v2/companies/{}/nexus/{}'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single nexus parameter - + :return ErrorDetail + """ + def delete_nexus(self, companyId, id_, include=None): return requests.delete('{}/api/v2/companies/{}/nexus/{}'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id :param nexusId [int] The nexus id :param id_ [int] The parameter id - :return ErrorDetail - """ - def delete_nexus_parameter(self, companyId, nexusId, id_): return requests.delete('{}/api/v2/companies/{}/nexus/{}/parameters/{}'.format(self.base_url, companyId, nexusId, id_), + :return ErrorDetail + """ + def delete_nexus_parameter(self, companyId, nexusId, id_): return requests.delete('{}/api/v2/companies/{}/nexus/{}/parameters/{}'.format(self.base_url, companyId, nexusId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete all parameters for an nexus - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this nexus. :param nexusId [int] The ID of the nexus you wish to delete the parameters. - :return ErrorDetail - """ - def delete_nexus_parameters(self, companyId, nexusId): return requests.delete('{}/api/v2/companies/{}/nexus/{}/parameters'.format(self.base_url, companyId, nexusId), + :return ErrorDetail + """ + def delete_nexus_parameters(self, companyId, nexusId): return requests.delete('{}/api/v2/companies/{}/nexus/{}/parameters'.format(self.base_url, companyId, nexusId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single nexus - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single nexus + Get the nexus object identified by this URL. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4663,19 +4663,19 @@ def delete_nexus_parameters(self, companyId, nexusId): return requests.de You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 companyId [int] The ID of the company that owns this nexus object :param id_ [int] The primary key of this nexus :param include [string] - :return NexusModel - """ - def get_nexus(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/nexus/{}'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List company nexus related to a tax form - + :return NexusModel + """ + def get_nexus(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/nexus/{}'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List company nexus related to a tax form + Retrieves a list of nexus related to a tax form. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4686,37 +4686,37 @@ def get_nexus(self, companyId, id_, include=None): return requests.get('{ You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 companyId [int] The ID of the company that owns this nexus object :param formCode [string] The form code that we are looking up the nexus for :param include [string] - :return NexusByTaxFormModel - """ - def get_nexus_by_form_code(self, companyId, formCode, include=None): return requests.get('{}/api/v2/companies/{}/nexus/byform/{}'.format(self.base_url, companyId, formCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single nexus parameter - + :return NexusByTaxFormModel + """ + def get_nexus_by_form_code(self, companyId, formCode, include=None): return requests.get('{}/api/v2/companies/{}/nexus/byform/{}'.format(self.base_url, companyId, formCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * 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 companyId [int] The company id :param nexusId [int] The nexus id :param id_ [int] The parameter id - :return NexusParameterDetailModel - """ - def get_nexus_parameter(self, companyId, nexusId, id_): return requests.get('{}/api/v2/companies/{}/nexus/{}/parameters/{}'.format(self.base_url, companyId, nexusId, id_), + :return NexusParameterDetailModel + """ + def get_nexus_parameter(self, companyId, nexusId, id_): return requests.get('{}/api/v2/companies/{}/nexus/{}/parameters/{}'.format(self.base_url, companyId, nexusId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve nexus for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve nexus for this company + List all nexus objects defined for this company. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4726,22 +4726,22 @@ def get_nexus_parameter(self, companyId, nexusId, id_): return requests.g You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 companyId [int] The ID of the company that owns these nexus objects :param filter [string] A filter statement to 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, taxableNexus :param include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/nexus'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve parameters for a nexus - + :return FetchResult + """ + def list_nexus_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/nexus'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -4749,22 +4749,22 @@ def list_nexus_by_company(self, companyId, include=None): return requests 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. - + * 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 companyId [int] The company id :param nexusId [int] The nexus id :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_nexus_parameters(self, companyId, nexusId, include=None): return requests.get('{}/api/v2/companies/{}/nexus/{}/parameters'.format(self.base_url, companyId, nexusId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all nexus - + :return FetchResult + """ + def list_nexus_parameters(self, companyId, nexusId, include=None): return requests.get('{}/api/v2/companies/{}/nexus/{}/parameters'.format(self.base_url, companyId, nexusId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all nexus + Get multiple nexus objects across all companies. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4774,21 +4774,21 @@ def list_nexus_parameters(self, companyId, nexusId, include=None): return You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: * Parameters ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 filter [string] A filter statement to 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, taxableNexus :param include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_nexus(self, include=None): return requests.get('{}/api/v2/nexus'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single nexus - + :return FetchResult + """ + def query_nexus(self, include=None): return requests.get('{}/api/v2/nexus'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single nexus + Replace the existing nexus declaration object at this URL with an updated object. The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your @@ -4804,38 +4804,38 @@ def query_nexus(self, include=None): return requests.get('{}/api/v2/nexus Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance of calculating tax for a location. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that this nexus belongs to. :param id_ [int] The ID of the nexus you wish to update :param model [NexusModel] The nexus object you wish to update. - :return NexusModel - """ - def update_nexus(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/nexus/{}'.format(self.base_url, companyId, id_), + :return NexusModel + """ + def update_nexus(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/nexus/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update an nexus parameter - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The company id. :param nexusId [int] The nexus id :param id_ [int] The nexus parameter id :param model [NexusParameterDetailModel] The nexus object you wish to update. - :return NexusParameterDetailModel - """ - def update_nexus_parameter(self, companyId, nexusId, id_, model): return requests.put('{}/api/v2/companies/{}/nexus/{}/parameters/{}'.format(self.base_url, companyId, nexusId, id_), + :return NexusParameterDetailModel + """ + def update_nexus_parameter(self, companyId, nexusId, id_, model): return requests.put('{}/api/v2/companies/{}/nexus/{}/parameters/{}'.format(self.base_url, companyId, nexusId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Mark a single notification as dismissed. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Mark a single notification as dismissed. + Marks the notification identified by this URL as dismissed. A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed @@ -4847,17 +4847,17 @@ def update_nexus_parameter(self, companyId, nexusId, id_, model): return determine if they were resolved appropriately. A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The id of the notification you wish to mark as dismissed. - :return NotificationModel - """ - def dismiss_notification(self, id_): return requests.put('{}/api/v2/notifications/{}/dismiss'.format(self.base_url, id_), + :return NotificationModel + """ + def dismiss_notification(self, id_): return requests.put('{}/api/v2/notifications/{}/dismiss'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single notification. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single notification. + Retrieve a single notification by its unique ID number. A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed @@ -4865,17 +4865,17 @@ def dismiss_notification(self, id_): return requests.put('{}/api/v2/notif An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The id of the notification to retrieve. - :return NotificationModel - """ - def get_notification(self, id_): return requests.get('{}/api/v2/notifications/{}'.format(self.base_url, id_), + :return NotificationModel + """ + def get_notification(self, id_): return requests.get('{}/api/v2/notifications/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all notifications. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all notifications. + List all notifications. A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed @@ -4885,20 +4885,20 @@ def get_notification(self, id_): return requests.get('{}/api/v2/notificat You may search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_notifications(self, include=None): return requests.get('{}/api/v2/notifications'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Request a new Avalara account - + :return FetchResult + """ + def list_notifications(self, include=None): return requests.get('{}/api/v2/notifications'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Request a new Avalara account + This API is for use by partner provisioning services customers only. Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features of AvaTax. These partners can create accounts for new customers using this API. @@ -4913,50 +4913,50 @@ def list_notifications(self, include=None): return requests.get('{}/api/v ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. - * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. - + * 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 model [NewAccountRequestModel] Information about the account you wish to create and the selected product offerings. - :return NewAccountModel - """ - def request_new_account(self, model): return requests.post('{}/api/v2/accounts/request'.format(self.base_url), + :return NewAccountModel + """ + def request_new_account(self, model): return requests.post('{}/api/v2/accounts/request'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Request a new entitilement to an existing customer - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Request a new entitilement to an existing customer + This API is for use by partner provisioning services customers only. This will allow the partners to allow the add new entitlement to an existing customer ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * This API is available by invitation only. - * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. - + * 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 id_ [int] The avatax account id of the customer :param offer [string] The offer to be added to an already existing customer - :return OfferModel - """ - def request_new_entitlement(self, id_, offer): return requests.post('{}/api/v2/accounts/{}/entitlements/{}'.format(self.base_url, id_, offer), + :return OfferModel + """ + def request_new_entitlement(self, id_, offer): return requests.post('{}/api/v2/accounts/{}/entitlements/{}'.format(self.base_url, id_, offer), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new account + # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Create a single new account object. When creating an account object you may attach subscriptions and users as part of the 'Create' call. ### Security Policies - * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param model [AccountModel] The account you wish to create. - :return AccountModel - """ - def create_account(self, model): return requests.post('{}/api/v2/accounts'.format(self.base_url), + :return AccountModel + """ + def create_account(self, model): return requests.post('{}/api/v2/accounts'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create new notifications. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create new notifications. + This API is available by invitation only. Create a single notification. A notification is a message from Avalara that may have relevance to your business. You may want @@ -4968,50 +4968,50 @@ def create_account(self, model): return requests.post('{}/api/v2/accounts affect you, or a potential issue with your company's tax profile. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - + * 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 model [NotificationModel] The notifications you wish to create. - :return NotificationModel - """ - def create_notifications(self, model): return requests.post('{}/api/v2/notifications'.format(self.base_url), + :return NotificationModel + """ + def create_notifications(self, model): return requests.post('{}/api/v2/notifications'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new subscription - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new subscription + This API is for use by Avalara Registrar administrative users only. Create one or more new subscription objects attached to this account. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. ### Security Policies - * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param accountId [int] The ID of the account that owns this subscription. :param model [SubscriptionModel] The subscription you wish to create. - :return SubscriptionModel - """ - def create_subscriptions(self, accountId, model): return requests.post('{}/api/v2/accounts/{}/subscriptions'.format(self.base_url, accountId), + :return SubscriptionModel + """ + def create_subscriptions(self, accountId, model): return requests.post('{}/api/v2/accounts/{}/subscriptions'.format(self.base_url, accountId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single account + # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Delete an account. Deleting an account will delete all companies, all account level users and license keys attached to this account. ### Security Policies - * This API requires the user role SystemAdmin. - + * This API requires the user role SystemAdmin. + :param id_ [int] The ID of the account you wish to delete. - :return ErrorDetail - """ - def delete_account(self, id_): return requests.delete('{}/api/v2/accounts/{}'.format(self.base_url, id_), + :return ErrorDetail + """ + def delete_account(self, id_): return requests.delete('{}/api/v2/accounts/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single notification. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single notification. + This API is available by invitation only. Delete the existing notification identified by this URL. A notification is a message from Avalara that may have relevance to your business. You may want @@ -5021,33 +5021,33 @@ def delete_account(self, id_): return requests.delete('{}/api/v2/accounts affect you, or a potential issue with your company's tax profile. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - + * 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 id_ [int] The id of the notification you wish to delete. - :return ErrorDetail - """ - def delete_notification(self, id_): return requests.delete('{}/api/v2/notifications/{}'.format(self.base_url, id_), + :return ErrorDetail + """ + def delete_notification(self, id_): return requests.delete('{}/api/v2/notifications/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single subscription - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single subscription + # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Mark the existing account identified by this URL as deleted. ### Security Policies - * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param accountId [int] The ID of the account that owns this subscription. :param id_ [int] The ID of the subscription you wish to delete. - :return ErrorDetail - """ - def delete_subscription(self, accountId, id_): return requests.delete('{}/api/v2/accounts/{}/subscriptions/{}'.format(self.base_url, accountId, id_), + :return ErrorDetail + """ + def delete_subscription(self, accountId, id_): return requests.delete('{}/api/v2/accounts/{}/subscriptions/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Reset a user's password programmatically - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Reset a user's password programmatically + # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Allows a system admin to reset the password for a specific user via the API. @@ -5055,35 +5055,35 @@ def delete_subscription(self, accountId, id_): return requests.delete('{} user based on internal Avalara business processes. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API is available to Avalara system-level (registrar-level) users only. - + * This API is available to Avalara system-level (registrar-level) users only. + :param userId [int] The unique ID of the user whose password will be changed :param unmigrateFromAi [boolean] If user's password was migrated to AI, undo this. :param model [SetPasswordModel] The new password for this user - :return string - """ - def reset_password(self, userId, model, include=None): return requests.post('{}/api/v2/passwords/{}/reset'.format(self.base_url, userId), + :return string + """ + def reset_password(self, userId, model, include=None): return requests.post('{}/api/v2/passwords/{}/reset'.format(self.base_url, userId), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single account + # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Replace an existing account object with an updated account object. ### Security Policies - * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param id_ [int] The ID of the account you wish to update. :param model [AccountModel] The account object you wish to update. - :return AccountModel - """ - def update_account(self, id_, model): return requests.put('{}/api/v2/accounts/{}'.format(self.base_url, id_), + :return AccountModel + """ + def update_account(self, id_, model): return requests.put('{}/api/v2/accounts/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single notification. - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single notification. + This API is available by invitation only. Replaces the notification identified by this URL with a new notification. A notification is a message from Avalara that may have relevance to your business. You may want @@ -5093,18 +5093,18 @@ def update_account(self, id_, model): return requests.put('{}/api/v2/acco affect you, or a potential issue with your company's tax profile. ### Security Policies * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - + * 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 id_ [int] The id of the notification you wish to update. :param model [NotificationModel] The notification object you wish to update. - :return NotificationModel - """ - def update_notification(self, id_, model): return requests.put('{}/api/v2/notifications/{}'.format(self.base_url, id_), + :return NotificationModel + """ + def update_notification(self, id_, model): return requests.put('{}/api/v2/notifications/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single subscription - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single subscription + # For Registrar Use Only This API is for use by Avalara Registrar administrative users only. Replace the existing subscription object at this URL with an updated object. @@ -5113,19 +5113,19 @@ def update_notification(self, id_, model): return requests.put('{}/api/v2 All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies - * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param accountId [int] The ID of the account that this subscription belongs to. :param id_ [int] The ID of the subscription you wish to update :param model [SubscriptionModel] The subscription you wish to update. - :return SubscriptionModel - """ - def update_subscription(self, accountId, id_, model): return requests.put('{}/api/v2/accounts/{}/subscriptions/{}'.format(self.base_url, accountId, id_), + :return SubscriptionModel + """ + def update_subscription(self, accountId, id_, model): return requests.put('{}/api/v2/accounts/{}/subscriptions/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Download a report - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Download a report + This API downloads the file associated with a report. If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete, use the `GetReport` API. @@ -5137,17 +5137,17 @@ def update_subscription(self, accountId, id_, model): return requests.put * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. This API works for all report types. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param id_ [int] The unique ID number of this report - :return String - """ - def download_report(self, id_): return requests.get('{}/api/v2/reports/{}/attachment'.format(self.base_url, id_), + :return String + """ + def download_report(self, id_): return requests.get('{}/api/v2/reports/{}/attachment'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single report - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single report + Retrieve a single report by its unique ID number. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: @@ -5155,17 +5155,17 @@ def download_report(self, id_): return requests.get('{}/api/v2/reports/{} * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. - This API call returns information about any report type. - + This API call returns information about any report type. + :param id_ [int] The unique ID number of the report to retrieve - :return ReportModel - """ - def get_report(self, id_): return requests.get('{}/api/v2/reports/{}'.format(self.base_url, id_), + :return ReportModel + """ + def get_report(self, id_): return requests.get('{}/api/v2/reports/{}'.format(self.base_url, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Initiate an ExportDocumentLine report task - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Initiate an ExportDocumentLine report task + Begins running an `ExportDocumentLine` report task and returns the identity of the report. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: @@ -5181,18 +5181,18 @@ def get_report(self, id_): return requests.get('{}/api/v2/reports/{}'.for * Follow the steps above with numberOfPartitions = 3 and partition = 2 * Once all three reports are downloaded merge the files on the client side. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The unique ID number of the company to report on. :param model [ExportDocumentLineModel] Options that may be configured to customize the report. - :return ReportModel - """ - def initiate_export_document_line_report(self, companyId, model): return requests.post('{}/api/v2/companies/{}/reports/exportdocumentline/initiate'.format(self.base_url, companyId), + :return ReportModel + """ + def initiate_export_document_line_report(self, companyId, model): return requests.post('{}/api/v2/companies/{}/reports/exportdocumentline/initiate'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all report tasks for account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all report tasks for account + List all report tasks for your account. Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps: @@ -5202,20 +5202,20 @@ def initiate_export_document_line_report(self, companyId, model): return * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. This API call returns information about all report types across your entire account. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The id of the company for which to get reports. :param pageKey [string] Provide a page key to retrieve the next page of results. :param skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 - """ - def list_reports(self, include=None): return requests.get('{}/api/v2/reports'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new setting - + :return FetchResult + """ + def list_reports(self, include=None): return requests.get('{}/api/v2/reports'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new setting + Create one or more new setting objects attached to this company. The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of @@ -5225,18 +5225,18 @@ def list_reports(self, include=None): return requests.get('{}/api/v2/repo When creating this object, you may define your own `set`, `name`, and `value` parameters. To define your own values, please choose a `set` name that begins with `X-` to indicate an extension. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this setting. :param model [SettingModel] The setting you wish to create. - :return SettingModel - """ - def create_settings(self, companyId, model): return requests.post('{}/api/v2/companies/{}/settings'.format(self.base_url, companyId), + :return SettingModel + """ + def create_settings(self, companyId, model): return requests.post('{}/api/v2/companies/{}/settings'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single setting - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single setting + Mark the setting object at this URL as deleted. The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of @@ -5246,18 +5246,18 @@ def create_settings(self, companyId, model): return requests.post('{}/api When creating this object, you may define your own `set`, `name`, and `value` parameters. To define your own values, please choose a `set` name that begins with `X-` to indicate an extension. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this setting. :param id_ [int] The ID of the setting you wish to delete. - :return ErrorDetail - """ - def delete_setting(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/settings/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_setting(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/settings/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single setting - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single setting + Get a single setting object by its unique ID. The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of @@ -5267,18 +5267,18 @@ def delete_setting(self, companyId, id_): return requests.delete('{}/api/ When creating this object, you may define your own `set`, `name`, and `value` parameters. To define your own values, please choose a `set` name that begins with `X-` to indicate an extension. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 companyId [int] The ID of the company that owns this setting :param id_ [int] The primary key of this setting - :return SettingModel - """ - def get_setting(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/settings/{}'.format(self.base_url, companyId, id_), + :return SettingModel + """ + def get_setting(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/settings/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all settings for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all settings for this company + List all setting objects attached to this company. The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of @@ -5290,22 +5290,22 @@ def get_setting(self, companyId, id_): return requests.get('{}/api/v2/com Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 companyId [int] The ID of the company that owns these settings :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_settings_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/settings'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all settings - + :return FetchResult + """ + def list_settings_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/settings'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all settings + Get multiple setting objects across all companies. The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of @@ -5317,21 +5317,21 @@ def list_settings_by_company(self, companyId, include=None): return reque Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * 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 filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_settings(self, include=None): return requests.get('{}/api/v2/settings'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single setting - + :return FetchResult + """ + def query_settings(self, include=None): return requests.get('{}/api/v2/settings'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single setting + Replace the existing setting object at this URL with an updated object. The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of @@ -5343,126 +5343,126 @@ def query_settings(self, include=None): return requests.get('{}/api/v2/se All data from the existing object will be replaced with data in the object you `PUT`. To set a field's value to `null`, you may either set its value to `null` or omit that field from the object when calling update. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that this setting belongs to. :param id_ [int] The ID of the setting you wish to update :param model [SettingModel] The setting you wish to update. - :return SettingModel - """ - def update_setting(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/settings/{}'.format(self.base_url, companyId, id_), + :return SettingModel + """ + def update_setting(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/settings/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single subscription - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 accountId [int] The ID of the account that owns this subscription :param id_ [int] The primary key of this subscription - :return SubscriptionModel - """ - def get_subscription(self, accountId, id_): return requests.get('{}/api/v2/accounts/{}/subscriptions/{}'.format(self.base_url, accountId, id_), + :return SubscriptionModel + """ + def get_subscription(self, accountId, id_): return requests.get('{}/api/v2/accounts/{}/subscriptions/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve subscriptions for this account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve subscriptions for this account + List all subscription objects attached to this account. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 accountId [int] The ID of the account that owns these subscriptions :param filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_subscriptions_by_account(self, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/subscriptions'.format(self.base_url, accountId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all subscriptions - + :return FetchResult + """ + def list_subscriptions_by_account(self, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/subscriptions'.format(self.base_url, accountId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all subscriptions + Get multiple subscription objects across all accounts. A 'subscription' indicates a licensed subscription to a named Avalara service. To request or remove subscriptions, please contact Avalara sales or your customer account manager. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 filter [string] A filter statement to 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_subscriptions(self, include=None): return requests.get('{}/api/v2/subscriptions'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new tax code - + :return FetchResult + """ + def query_subscriptions(self, include=None): return requests.get('{}/api/v2/subscriptions'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new tax code + Create one or more new taxcode objects attached to this company. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this tax code. :param model [TaxCodeModel] The tax code you wish to create. - :return TaxCodeModel - """ - def create_tax_codes(self, companyId, model): return requests.post('{}/api/v2/companies/{}/taxcodes'.format(self.base_url, companyId), + :return TaxCodeModel + """ + def create_tax_codes(self, companyId, model): return requests.post('{}/api/v2/companies/{}/taxcodes'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single tax code - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this tax code. :param id_ [int] The ID of the tax code you wish to delete. - :return ErrorDetail - """ - def delete_tax_code(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/taxcodes/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_tax_code(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/taxcodes/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single tax code - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single tax code + Get the taxcode object identified by this URL. A 'TaxCode' represents a uniquely identified type of product, good, or service. Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and taxability rules for this product in all supported jurisdictions. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns this tax code :param id_ [int] The primary key of this tax code - :return TaxCodeModel - """ - def get_tax_code(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/taxcodes/{}'.format(self.base_url, companyId, id_), + :return TaxCodeModel + """ + def get_tax_code(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/taxcodes/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve tax codes for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -5471,22 +5471,22 @@ def get_tax_code(self, companyId, id_): return requests.get('{}/api/v2/co Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns these tax codes :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_codes_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/taxcodes'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all tax codes - + :return FetchResult + """ + def list_tax_codes_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/taxcodes'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -5495,21 +5495,21 @@ def list_tax_codes_by_company(self, companyId, include=None): return requ Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_tax_codes(self, include=None): return requests.get('{}/api/v2/taxcodes'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single tax code - + :return FetchResult + """ + def query_tax_codes(self, include=None): return requests.get('{}/api/v2/taxcodes'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -5518,19 +5518,19 @@ def query_tax_codes(self, include=None): return requests.get('{}/api/v2/t All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that this tax code belongs to. :param id_ [int] The ID of the tax code you wish to update :param model [TaxCodeModel] The tax code you wish to update. - :return TaxCodeModel - """ - def update_tax_code(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/taxcodes/{}'.format(self.base_url, companyId, id_), + :return TaxCodeModel + """ + def update_tax_code(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/taxcodes/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Build a multi-location tax content file - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Build a multi-location tax content file + Builds a tax content file containing information useful for a retail point-of-sale solution. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize @@ -5550,17 +5550,17 @@ def update_tax_code(self, companyId, id_, model): return requests.put('{} NOTE: This API does not work for Tennessee tax holiday scenarios. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param model [PointOfSaleDataRequestModel] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include. - :return String - """ - def build_tax_content_file(self, model): return requests.post('{}/api/v2/pointofsaledata/build'.format(self.base_url), + :return String + """ + def build_tax_content_file(self, model): return requests.post('{}/api/v2/pointofsaledata/build'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Build a tax content file for a single location - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Build a tax content file for a single location + Builds a tax content file containing information useful for a retail point-of-sale solution. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend that users of this tax content API download new data every day. Many tax authorities may finalize @@ -5580,22 +5580,22 @@ def build_tax_content_file(self, model): return requests.post('{}/api/v2/ NOTE: This API does not work for Tennessee tax holiday scenarios. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro. - + * This API depends on the following active services:*Required* (all): AvaTaxPro. + :param companyId [int] The ID number of the company that owns this location. :param id_ [int] The ID number of the location to retrieve point-of-sale data. :param date [datetime] The date for which point-of-sale data would be calculated (today by default) :param format [PointOfSaleFileType] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values) :param partnerId [PointOfSalePartnerId] If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values) :param includeJurisCodes [boolean] When true, the file will include jurisdiction codes in the result. - :return String - """ - def build_tax_content_file_for_location(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/locations/{}/pointofsaledata'.format(self.base_url, companyId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Download a file listing tax rates by postal code - + :return String + """ + def build_tax_content_file_for_location(self, companyId, id_, include=None): return requests.get('{}/api/v2/companies/{}/locations/{}/pointofsaledata'.format(self.base_url, companyId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Download a file listing tax rates by postal code + Download a CSV file containing all five digit postal codes in the United States and their sales and use tax rates for tangible personal property. Since tax rates may change based on decisions made by a variety of tax authorities, we recommend @@ -5630,18 +5630,18 @@ def build_tax_content_file_for_location(self, companyId, id_, include=None): * TAX_SHIPPING_AND_HANDLING_TOGETHER - This column contains 'Y' if shipping and handling are taxable when sent together. For more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 date [datetime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31 :param region [string] A two character region code which limits results to a specific region. - :return String - """ - def download_tax_rates_by_zip_code(self, date, include=None): return requests.get('{}/api/v2/taxratesbyzipcode/download/{}'.format(self.base_url, date), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Sales tax rates for a specified address - + :return String + """ + def download_tax_rates_by_zip_code(self, date, include=None): return requests.get('{}/api/v2/taxratesbyzipcode/download/{}'.format(self.base_url, date), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Sales tax rates for a specified address + Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP response code 429 - `Too Many Requests`. This API assumes that you are selling general tangible personal property at a retail point-of-sale @@ -5657,8 +5657,8 @@ def download_tax_rates_by_zip_code(self, date, include=None): return requ * Detailed jurisdiction names and state assigned codes * And more! Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) - 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 line1 [string] The street address of the location. :param line2 [string] The street address of the location. :param line3 [string] The street address of the location. @@ -5666,14 +5666,14 @@ def download_tax_rates_by_zip_code(self, date, include=None): return requ :param region [string] Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`. :param postalCode [string] The postal code of the location. :param country [string] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`. - :return TaxRateModel - """ - def tax_rates_by_address(self, include=None): return requests.get('{}/api/v2/taxrates/byaddress'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Sales tax rates for a specified country and postal code. This API is only available for US postal codes. - + :return TaxRateModel + """ + def tax_rates_by_address(self, include=None): return requests.get('{}/api/v2/taxrates/byaddress'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Sales tax rates for a specified country and postal code. This API is only available for US postal codes. + This API is only available for a US postal codes. Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP response code 429 - `Too Many Requests`. @@ -5690,18 +5690,18 @@ def tax_rates_by_address(self, include=None): return requests.get('{}/api * Detailed jurisdiction names and state assigned codes * And more! Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) - 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 country [string] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`. :param postalCode [string] The postal code of the location. - :return TaxRateModel - """ - def tax_rates_by_postal_code(self, include=None): return requests.get('{}/api/v2/taxrates/bypostalcode'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new tax rule - + :return TaxRateModel + """ + def tax_rates_by_postal_code(self, include=None): return requests.get('{}/api/v2/taxrates/bypostalcode'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new tax rule + Create one or more custom tax rules attached to this company. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate @@ -5713,18 +5713,18 @@ def tax_rates_by_postal_code(self, include=None): return requests.get('{} Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this tax rule. :param model [TaxRuleModel] The tax rule you wish to create. - :return TaxRuleModel - """ - def create_tax_rules(self, companyId, model): return requests.post('{}/api/v2/companies/{}/taxrules'.format(self.base_url, companyId), + :return TaxRuleModel + """ + def create_tax_rules(self, companyId, model): return requests.post('{}/api/v2/companies/{}/taxrules'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single tax rule - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single tax rule + Mark the custom tax rule identified by this URL as deleted. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate @@ -5736,18 +5736,18 @@ def create_tax_rules(self, companyId, model): return requests.post('{}/ap Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that owns this tax rule. :param id_ [int] The ID of the tax rule you wish to delete. - :return ErrorDetail - """ - def delete_tax_rule(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/taxrules/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_tax_rule(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/taxrules/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single tax rule - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single tax rule + Get the taxrule object identified by this URL. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate @@ -5759,18 +5759,18 @@ def delete_tax_rule(self, companyId, id_): return requests.delete('{}/api Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns this tax rule :param id_ [int] The primary key of this tax rule - :return TaxRuleModel - """ - def get_tax_rule(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/taxrules/{}'.format(self.base_url, companyId, id_), + :return TaxRuleModel + """ + def get_tax_rule(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/taxrules/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve tax rules for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve tax rules for this company + List all taxrule objects attached to this company. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate @@ -5784,22 +5784,22 @@ def get_tax_rule(self, companyId, id_): return requests.get('{}/api/v2/co Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param companyId [int] The ID of the company that owns these tax rules :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_tax_rules(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/taxrules'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all tax rules - + :return FetchResult + """ + def list_tax_rules(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/taxrules'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all tax rules + Get multiple taxrule objects across all companies. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate @@ -5813,21 +5813,21 @@ def list_tax_rules(self, companyId, include=None): return requests.get('{ Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - + * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + :param filter [string] A filter statement to 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_tax_rules(self, include=None): return requests.get('{}/api/v2/taxrules'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single tax rule - + :return FetchResult + """ + def query_tax_rules(self, include=None): return requests.get('{}/api/v2/taxrules'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single tax rule + Replace the existing custom tax rule object at this URL with an updated object. A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate @@ -5839,19 +5839,19 @@ def query_tax_rules(self, include=None): return requests.get('{}/api/v2/t Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your auditor, legal representative, and accounting team. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + :param companyId [int] The ID of the company that this tax rule belongs to. :param id_ [int] The ID of the tax rule you wish to update :param model [TaxRuleModel] The tax rule you wish to update. - :return TaxRuleModel - """ - def update_tax_rule(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/taxrules/{}'.format(self.base_url, companyId, id_), + :return TaxRuleModel + """ + def update_tax_rule(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/taxrules/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Add lines to an existing unlocked transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Add lines to an existing unlocked transaction + Add lines to an existing unlocked transaction. The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number @@ -5870,18 +5870,18 @@ def update_tax_rule(self, companyId, id_, model): return requests.put('{} If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param include [string] Specifies objects to include in the response after transaction is created :param model [AddTransactionLineModel] information about the transaction and lines to be added - :return TransactionModel - """ - def add_lines(self, model, include=None): return requests.post('{}/api/v2/companies/transactions/lines/add'.format(self.base_url), + :return TransactionModel + """ + def add_lines(self, model, include=None): return requests.post('{}/api/v2/companies/transactions/lines/add'.format(self.base_url), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Correct a previously created transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Correct a previously created transaction + Replaces the current transaction uniquely identified by this URL with a new transaction. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). @@ -5907,21 +5907,21 @@ def add_lines(self, model, include=None): return requests.post('{}/api/v2 * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to adjust :param documentType [DocumentType] (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values) :param include [string] Specifies objects to include in this fetch call :param model [AdjustTransactionModel] The adjustment you wish to make - :return TransactionModel - """ - def adjust_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/adjust'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def adjust_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/adjust'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get audit information about a transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get audit information about a transaction + Retrieve audit information about a transaction stored in AvaTax. The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit information includes the following: @@ -5942,18 +5942,18 @@ def adjust_transaction(self, companyCode, transactionCode, model, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The code identifying the company that owns this transaction :param transactionCode [string] The code identifying the transaction - :return AuditTransactionModel - """ - def audit_transaction(self, companyCode, transactionCode): return requests.get('{}/api/v2/companies/{}/transactions/{}/audit'.format(self.base_url, companyCode, transactionCode), + :return AuditTransactionModel + """ + def audit_transaction(self, companyCode, transactionCode): return requests.get('{}/api/v2/companies/{}/transactions/{}/audit'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Get audit information about a transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Get audit information about a transaction + Retrieve audit information about a transaction stored in AvaTax. The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit information includes the following: @@ -5974,19 +5974,19 @@ def audit_transaction(self, companyCode, transactionCode): return request * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The code identifying the company that owns this transaction :param transactionCode [string] The code identifying the transaction :param documentType [DocumentType] The document type of the original transaction (See DocumentType::* for a list of allowable values) - :return AuditTransactionModel - """ - def audit_transaction_with_type(self, companyCode, transactionCode, documentType): return requests.get('{}/api/v2/companies/{}/transactions/{}/types/{}/audit'.format(self.base_url, companyCode, transactionCode, documentType), + :return AuditTransactionModel + """ + def audit_transaction_with_type(self, companyCode, transactionCode, documentType): return requests.get('{}/api/v2/companies/{}/transactions/{}/types/{}/audit'.format(self.base_url, companyCode, transactionCode, documentType), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Lock a set of documents - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Lock a set of documents + This API is available by invitation only. Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once. After this API call succeeds, documents will be locked and can't be voided. @@ -5994,17 +5994,17 @@ def audit_transaction_with_type(self, companyCode, transactionCode, documentType sales, purchases, inventory transfer, and returns (also called refunds). ### Security Policies * This API requires the user role Compliance Root User. - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 model [BulkLockTransactionModel] bulk lock request - :return BulkLockTransactionResult - """ - def bulk_lock_transaction(self, model): return requests.post('{}/api/v2/transactions/lock'.format(self.base_url), + :return BulkLockTransactionResult + """ + def bulk_lock_transaction(self, model): return requests.post('{}/api/v2/transactions/lock'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Change a transaction's code - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Change a transaction's code + Renames a transaction uniquely identified by this URL by changing its `code` value. This API is available as long as the transaction is in `saved` or `posted` status. When a transaction is `committed`, it can be modified by using the [AdjustTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/AdjustTransaction/) method. @@ -6029,21 +6029,21 @@ def bulk_lock_transaction(self, model): return requests.post('{}/api/v2/t * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to change :param documentType [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 include [string] Specifies objects to include in this fetch call :param model [ChangeTransactionCodeModel] The code change request you wish to execute - :return TransactionModel - """ - def change_transaction_code(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/changecode'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def change_transaction_code(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/changecode'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Commit a transaction for reporting - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Commit a transaction for reporting + Marks a transaction by changing its status to `Committed`. Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -6066,21 +6066,21 @@ def change_transaction_code(self, companyCode, transactionCode, model, include=N * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to commit :param documentType [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 include [string] Specifies objects to include in this fetch call :param model [CommitTransactionModel] The commit request you wish to execute - :return TransactionModel - """ - def commit_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/commit'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def commit_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/commit'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create or adjust a transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create or adjust a transaction + Records a new transaction or adjust an existing transaction in AvaTax. The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API can help you create an idempotent service that creates transactions @@ -6108,18 +6108,18 @@ def commit_transaction(self, companyCode, transactionCode, model, include=None): * \_-ava3f-\_ ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param include [string] Specifies objects to include in the response after transaction is created :param model [CreateOrAdjustTransactionModel] The transaction you wish to create or adjust - :return TransactionModel - """ - def create_or_adjust_transaction(self, model, include=None): return requests.post('{}/api/v2/transactions/createoradjust'.format(self.base_url), + :return TransactionModel + """ + def create_or_adjust_transaction(self, model, include=None): return requests.post('{}/api/v2/transactions/createoradjust'.format(self.base_url), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a new transaction + Records a new transaction in AvaTax. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). @@ -6152,18 +6152,18 @@ def create_or_adjust_transaction(self, model, include=None): return reque * \_-ava3f-\_ ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param include [string] Specifies objects to include in the response after transaction is created :param model [CreateTransactionModel] The transaction you wish to create - :return TransactionModel - """ - def create_transaction(self, model, include=None): return requests.post('{}/api/v2/transactions/create'.format(self.base_url), + :return TransactionModel + """ + def create_transaction(self, model, include=None): return requests.post('{}/api/v2/transactions/create'.format(self.base_url), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Remove lines from an existing unlocked transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Remove lines from an existing unlocked transaction + Remove lines to an existing unlocked transaction. The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will be able to delete transaction lines and adjust original transaction the way they like @@ -6179,18 +6179,18 @@ def create_transaction(self, model, include=None): return requests.post(' If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param include [string] Specifies objects to include in the response after transaction is created :param model [RemoveTransactionLineModel] information about the transaction and lines to be removed - :return TransactionModel - """ - def delete_lines(self, model, include=None): return requests.post('{}/api/v2/companies/transactions/lines/delete'.format(self.base_url), + :return TransactionModel + """ + def delete_lines(self, model, include=None): return requests.post('{}/api/v2/companies/transactions/lines/delete'.format(self.base_url), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single transaction by code - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single transaction by code + Get the current transaction identified by this company code, transaction code, and document type. A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`. For compatibility purposes, when this API finds multiple transactions with the same transaction code, and if you have not specified @@ -6213,20 +6213,20 @@ def delete_lines(self, model, include=None): return requests.post('{}/api * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to retrieve :param documentType [DocumentType] (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values) :param include [string] Specifies objects to include in this fetch call - :return TransactionModel - """ - def get_transaction_by_code(self, companyCode, transactionCode, include=None): return requests.get('{}/api/v2/companies/{}/transactions/{}'.format(self.base_url, companyCode, transactionCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single transaction by code - + :return TransactionModel + """ + def get_transaction_by_code(self, companyCode, transactionCode, include=None): return requests.get('{}/api/v2/companies/{}/transactions/{}'.format(self.base_url, companyCode, transactionCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single transaction by code + DEPRECATED: Please use the `GetTransactionByCode` API instead. NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code @@ -6237,20 +6237,20 @@ def get_transaction_by_code(self, companyCode, transactionCode, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to retrieve :param documentType [DocumentType] The transaction type to retrieve (See DocumentType::* for a list of allowable values) :param include [string] Specifies objects to include in this fetch call - :return TransactionModel - """ - def get_transaction_by_code_and_type(self, companyCode, transactionCode, documentType, include=None): return requests.get('{}/api/v2/companies/{}/transactions/{}/types/{}'.format(self.base_url, companyCode, transactionCode, documentType), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single transaction by ID - + :return TransactionModel + """ + def get_transaction_by_code_and_type(self, companyCode, transactionCode, documentType, include=None): return requests.get('{}/api/v2/companies/{}/transactions/{}/types/{}'.format(self.base_url, companyCode, transactionCode, documentType), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single transaction by ID + Get the unique transaction identified by this URL. This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted by using the `AdjustTransaction` endpoint. @@ -6266,18 +6266,18 @@ def get_transaction_by_code_and_type(self, companyCode, transactionCode, documen * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param id_ [int] The unique ID number of the transaction to retrieve :param include [string] Specifies objects to include in this fetch call - :return TransactionModel - """ - def get_transaction_by_id(self, id_, include=None): return requests.get('{}/api/v2/transactions/{}'.format(self.base_url, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all transactions - + :return TransactionModel + """ + def get_transaction_by_id(self, id_, include=None): return requests.get('{}/api/v2/transactions/{}'.format(self.base_url, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all transactions + List all transactions attached to this company. This endpoint is limited to returning 1,000 transactions at a time maximum. When listing transactions, you must specify a `date` range filter. If you do not specify a `$filter` that includes a `date` field @@ -6302,8 +6302,8 @@ def get_transaction_by_id(self, id_, include=None): return requests.get(' * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param dataSourceId [int] Optionally filter transactions to those from a specific data source. :param include [string] Specifies objects to include in this fetch call @@ -6311,14 +6311,14 @@ def get_transaction_by_id(self, id_, include=None): return requests.get(' :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_transactions_by_company(self, companyCode, include=None): return requests.get('{}/api/v2/companies/{}/transactions'.format(self.base_url, companyCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Lock a single transaction - + :return FetchResult + """ + def list_transactions_by_company(self, companyCode, include=None): return requests.get('{}/api/v2/companies/{}/transactions'.format(self.base_url, companyCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Lock a single transaction + Lock a transaction uniquely identified by this URL. This API is mainly used for connector developers to simulate what happens when the Returns product locks a document. After this API call succeeds, the document will be locked and can't be voided or adjusted. @@ -6343,21 +6343,21 @@ def list_transactions_by_company(self, companyCode, include=None): return * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - + * 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 companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to lock :param documentType [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 include [string] Specifies objects to include in this fetch call :param model [LockTransactionModel] The lock request you wish to execute - :return TransactionModel - """ - def lock_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/lock'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def lock_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/lock'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a refund for a transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create a refund for a transaction + Create a refund for a transaction. The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund for a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and @@ -6391,22 +6391,22 @@ def lock_transaction(self, companyCode, transactionCode, model, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The code of the company that made the original sale :param transactionCode [string] The transaction code of the original sale :param include [string] Specifies objects to include in the response after transaction is created :param documentType [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 useTaxDateOverride [boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states). :param model [RefundTransactionModel] Information about the refund to create - :return TransactionModel - """ - def refund_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/refund'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def refund_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/refund'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Perform multiple actions on a transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Perform multiple actions on a transaction + Performs one or more actions against the current transaction uniquely identified by this URL. The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -6429,21 +6429,21 @@ def refund_transaction(self, companyCode, transactionCode, model, include=None): * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - + * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to settle :param documentType [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 include [string] Specifies objects to include in this fetch call :param model [SettleTransactionModel] The data from an external system to reconcile against AvaTax - :return TransactionModel - """ - def settle_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/settle'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def settle_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/settle'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Uncommit a transaction for reporting - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Uncommit a transaction for reporting + Adjusts a transaction by changing it to an uncommitted status. Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are no longer available to be uncommitted. @@ -6464,20 +6464,20 @@ def settle_transaction(self, companyCode, transactionCode, model, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to Uncommit :param documentType [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 include [string] Specifies objects to include in this fetch call - :return TransactionModel - """ - def uncommit_transaction(self, companyCode, transactionCode, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/uncommit'.format(self.base_url, companyCode, transactionCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Unvoids a transaction - + :return TransactionModel + """ + def uncommit_transaction(self, companyCode, transactionCode, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/uncommit'.format(self.base_url, companyCode, transactionCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Unvoids a transaction + Unvoids a voided transaction You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * Lines @@ -6496,20 +6496,20 @@ def uncommit_transaction(self, companyCode, transactionCode, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to commit :param documentType [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 include [string] Specifies objects to include in this fetch call - :return TransactionModel - """ - def unvoid_transaction(self, companyCode, transactionCode, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/unvoid'.format(self.base_url, companyCode, transactionCode), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Verify a transaction - + :return TransactionModel + """ + def unvoid_transaction(self, companyCode, transactionCode, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/unvoid'.format(self.base_url, companyCode, transactionCode), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Verify a transaction + Verifies that the transaction uniquely identified by this URL matches certain expected values. If the transaction does not match these expected values, this API will return an error code indicating which value did not match. If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them. @@ -6532,21 +6532,21 @@ def unvoid_transaction(self, companyCode, transactionCode, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to settle :param documentType [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 include [string] Specifies objects to include in this fetch call :param model [VerifyTransactionModel] The data from an external system to reconcile against AvaTax - :return TransactionModel - """ - def verify_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/verify'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def verify_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/verify'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Void a transaction - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Void a transaction + Voids the current transaction uniquely identified by this URL. A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like sales, purchases, inventory transfer, and returns (also called refunds). @@ -6570,147 +6570,147 @@ def verify_transaction(self, companyCode, transactionCode, model, include=None): * Replace ' ' with '%20' For example: document Code becomes document%20Code ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - + * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + :param companyCode [string] The company code of the company that recorded this transaction :param transactionCode [string] The transaction code to void :param documentType [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 include [string] Specifies objects to include in this fetch call :param model [VoidTransactionModel] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided' - :return TransactionModel - """ - def void_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/void'.format(self.base_url, companyCode, transactionCode), + :return TransactionModel + """ + def void_transaction(self, companyCode, transactionCode, model, include=None): return requests.post('{}/api/v2/companies/{}/transactions/{}/void'.format(self.base_url, companyCode, transactionCode), auth=self.auth, headers=self.client_header, params=include, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create a new UPC - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this UPC. :param model [UPCModel] The UPC you wish to create. - :return UPCModel - """ - def create_u_p_cs(self, companyId, model): return requests.post('{}/api/v2/companies/{}/upcs'.format(self.base_url, companyId), + :return UPCModel + """ + def create_u_p_cs(self, companyId, model): return requests.post('{}/api/v2/companies/{}/upcs'.format(self.base_url, companyId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single UPC - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this UPC. :param id_ [int] The ID of the UPC you wish to delete. - :return ErrorDetail - """ - def delete_u_p_c(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/upcs/{}'.format(self.base_url, companyId, id_), + :return ErrorDetail + """ + def delete_u_p_c(self, companyId, id_): return requests.delete('{}/api/v2/companies/{}/upcs/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single UPC - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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 companyId [int] The ID of the company that owns this UPC :param id_ [int] The primary key of this UPC - :return UPCModel - """ - def get_u_p_c(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/upcs/{}'.format(self.base_url, companyId, id_), + :return UPCModel + """ + def get_u_p_c(self, companyId, id_): return requests.get('{}/api/v2/companies/{}/upcs/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve UPCs for this company - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve UPCs for this company + List all UPC objects attached to this company. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaUpc. - + * This API depends on the following active services:*Required* (all): AvaUpc. + :param companyId [int] The ID of the company that owns these UPCs :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_u_p_cs_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/upcs'.format(self.base_url, companyId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all UPCs - + :return FetchResult + """ + def list_u_p_cs_by_company(self, companyId, include=None): return requests.get('{}/api/v2/companies/{}/upcs'.format(self.base_url, companyId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all UPCs + Get multiple UPC objects across all companies. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. ### Security Policies * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * This API depends on the following active services:*Required* (all): AvaUpc. - + * This API depends on the following active services:*Required* (all): AvaUpc. + :param filter [string] A filter 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 include [string] A comma separated list of additional data to retrieve. :param top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_u_p_cs(self, include=None): return requests.get('{}/api/v2/upcs'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single UPC - + :return FetchResult + """ + def query_u_p_cs(self, include=None): return requests.get('{}/api/v2/upcs'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single UPC + Replace the existing UPC object at this URL with an updated object. A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * This API depends on the following active services:*Required* (all): AvaUpc. - + * This API depends on the following active services:*Required* (all): AvaUpc. + :param companyId [int] The ID of the company that this UPC belongs to. :param id_ [int] The ID of the UPC you wish to update :param model [UPCModel] The UPC you wish to update. - :return UPCModel - """ - def update_u_p_c(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/upcs/{}'.format(self.base_url, companyId, id_), + :return UPCModel + """ + def update_u_p_c(self, companyId, id_, model): return requests.put('{}/api/v2/companies/{}/upcs/{}'.format(self.base_url, companyId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Change Password - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Change Password + Allows a user to change their password via an API call. This API allows an authenticated user to change their password via an API call. This feature is only available for accounts that do not use SAML integrated password validation. This API only allows the currently authenticated user to change their password; it cannot be used to apply to a different user than the one authenticating the current API call. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 model [PasswordChangeModel] An object containing your current password and the new password. - :return string - """ - def change_password(self, model): return requests.put('{}/api/v2/passwords'.format(self.base_url), + :return string + """ + def change_password(self, model): return requests.put('{}/api/v2/passwords'.format(self.base_url), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Create new users - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Create new users + Create one or more new user objects attached to this account. A user represents one person with access privileges to make API calls and work with a specific account. Users who are account administrators or company users are permitted to create user records to invite @@ -6718,53 +6718,53 @@ def change_password(self, model): return requests.put('{}/api/v2/password A newly created user will receive an email inviting them to create their password. This means that you must provide a valid email address for all user accounts created. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 accountId [int] The unique ID number of the account where these users will be created. :param model [UserModel] The user or array of users you wish to create. - :return UserModel - """ - def create_users(self, accountId, model): return requests.post('{}/api/v2/accounts/{}/users'.format(self.base_url, accountId), + :return UserModel + """ + def create_users(self, accountId, model): return requests.post('{}/api/v2/accounts/{}/users'.format(self.base_url, accountId), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Delete a single user - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Delete a single user + Mark the user object identified by this URL as deleted. This API is available for use by account and company administrators only. Account and company administrators may only delete users within the appropriate organizations they control. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. - + * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. + :param id_ [int] The ID of the user you wish to delete. :param accountId [int] The accountID of the user you wish to delete. - :return ErrorDetail - """ - def delete_user(self, id_, accountId): return requests.delete('{}/api/v2/accounts/{}/users/{}'.format(self.base_url, accountId, id_), + :return ErrorDetail + """ + def delete_user(self, id_, accountId): return requests.delete('{}/api/v2/accounts/{}/users/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve a single user - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve a single user + Get the user object identified by this URL. A user represents one person with access privileges to make API calls and work with a specific account. You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the user to retrieve. :param accountId [int] The accountID of the user you wish to get. :param include [string] Optional fetch commands. - :return UserModel - """ - def get_user(self, id_, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/users/{}'.format(self.base_url, accountId, id_), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all entitlements for a single user - + :return UserModel + """ + def get_user(self, id_, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/users/{}'.format(self.base_url, accountId, id_), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + 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. @@ -6779,18 +6779,18 @@ def get_user(self, id_, accountId, include=None): return requests.get('{} * If the 'permissions' array within entitlements does not contain 'AccountSvc.CompanySave', the call will fail. For a full list of defined permissions, please use '/api/v2/definitions/permissions' . ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the user to retrieve. :param accountId [int] The accountID of the user you wish to get. - :return UserEntitlementModel - """ - def get_user_entitlements(self, id_, accountId): return requests.get('{}/api/v2/accounts/{}/users/{}/entitlements'.format(self.base_url, accountId, id_), + :return UserEntitlementModel + """ + def get_user_entitlements(self, id_, accountId): return requests.get('{}/api/v2/accounts/{}/users/{}/entitlements'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve users for this account - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve users for this account + List all user objects attached to this account. A user represents one person with access privileges to make API calls and work with a specific account. When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. @@ -6800,22 +6800,22 @@ def get_user_entitlements(self, id_, accountId): return requests.get('{}/ You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 accountId [int] The accountID of the user you wish to list. :param include [string] Optional fetch commands. :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def list_users_by_account(self, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/users'.format(self.base_url, accountId), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Retrieve all users - + :return FetchResult + """ + def list_users_by_account(self, accountId, include=None): return requests.get('{}/api/v2/accounts/{}/users'.format(self.base_url, accountId), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Retrieve all users + Get multiple user objects across all accounts. A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key. @@ -6826,70 +6826,70 @@ def list_users_by_account(self, accountId, include=None): return requests You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: * FetchDeleted ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 include [string] Optional fetch commands. :param filter [string] A filter 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 top [int] If nonzero, return no more than this number of results. Used with `$skip` to provide 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 skip [int] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. :param orderBy [string] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - :return FetchResult - """ - def query_users(self, include=None): return requests.get('{}/api/v2/users'.format(self.base_url), - auth=self.auth, headers=self.client_header, params=include, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Update a single user - + :return FetchResult + """ + def query_users(self, include=None): return requests.get('{}/api/v2/users'.format(self.base_url), + auth=self.auth, headers=self.client_header, params=include, + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Update a single user + Replace the existing user object at this URL with an updated object. A user represents one person with access privileges to make API calls and work with a specific account. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post. ### Security Policies - * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - + * 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 id_ [int] The ID of the user you wish to update. :param accountId [int] The accountID of the user you wish to update. :param model [UserModel] The user object you wish to update. - :return UserModel - """ - def update_user(self, id_, accountId, model): return requests.put('{}/api/v2/accounts/{}/users/{}'.format(self.base_url, accountId, id_), + :return UserModel + """ + def update_user(self, id_, accountId, model): return requests.put('{}/api/v2/accounts/{}/users/{}'.format(self.base_url, accountId, id_), auth=self.auth, headers=self.client_header, json=model, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Checks if the current user is subscribed to a specific service - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Checks if the current user is subscribed to a specific service + Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account. This API will return an error if it is called with invalid authentication credentials. This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use - specific features of AvaTax. - + specific features of AvaTax. + :param serviceTypeId [string] The service to check - :return SubscriptionModel - """ - def get_my_subscription(self, serviceTypeId): return requests.get('{}/api/v2/utilities/subscriptions/{}'.format(self.base_url, serviceTypeId), + :return SubscriptionModel + """ + def get_my_subscription(self, serviceTypeId): return requests.get('{}/api/v2/utilities/subscriptions/{}'.format(self.base_url, serviceTypeId), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - List all services to which the current user is subscribed - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + List all services to which the current user is subscribed + Returns the list of all subscriptions enabled for the currently logged in user. This API will return an error if it is called with invalid authentication credentials. This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use - specific features of AvaTax. - - :return FetchResult - """ - def list_my_subscriptions(self): return requests.get('{}/api/v2/utilities/subscriptions'.format(self.base_url), + specific features of AvaTax. + + :return FetchResult + """ + def list_my_subscriptions(self): return requests.get('{}/api/v2/utilities/subscriptions'.format(self.base_url), auth=self.auth, headers=self.client_header, params=None, - timeout=self.timeout_limit if self.timeout_limit else 1200) - r""" - Tests connectivity and version of the service - + timeout=self.timeout_limit if self.timeout_limit else 1200) + r""" + Tests connectivity and version of the service + Check connectivity to AvaTax and return information about the AvaTax API server. This API is intended to help you verify that your connection is working. This API will always succeed and will never return a error. It provides basic information about the server you connect to: @@ -6904,10 +6904,10 @@ def list_my_subscriptions(self): return requests.get('{}/api/v2/utilities the internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available. For more information on the uptime of AvaTax, please see [Avalara's AvaTax Status Page](https://status.avalara.com/). ### Security Policies - * This API may be called without providing authentication credentials. - - :return PingResultModel - """ - def ping(self): return requests.get('{}/api/v2/utilities/ping'.format(self.base_url), + * This API may be called without providing authentication credentials. + + :return PingResultModel + """ + def ping(self): return requests.get('{}/api/v2/utilities/ping'.format(self.base_url), auth=self.auth, headers=self.client_header, params=None, timeout=self.timeout_limit if self.timeout_limit else 1200) \ No newline at end of file