Module: AvaTax::Client::TaxProfiles

Defined in:
lib/avatax/client/taxprofiles.rb

Instance Method Summary collapse

Instance Method Details

#export_tax_profile(companyId) ⇒ Object

Export the tax profile of this company to a backup file

Exports the tax profile of a company to a file, containing all information that affects tax calculation for this company.

A tax profile is a series of decisions and configuration choices that affect your company's tax calculation. These decisions include your nexus declarations, your item catalog, your custom tax rules, and so on.

This API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this profile to a different company or compare it over time to see if your profile has been changed.

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.

Parameters:

  • companyId (Integer) —

    The unique ID number of the company whose profile you wish to retrieve.

Returns:

  • (Object) 


22
23
 
# File 'lib/avatax/client/taxprofiles.rb', line 22

def export_tax_profile(companyId)        path = "/api/v2/companies/#{companyId}/taxprofile"
get(path)      end

#import_tax_profile ⇒ Object

Import a tax profile.

Imports a tax profile to a new company, along with the option to import account settings.

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.

Parameters:

  • accountId (Integer) —

    The account id of the account to which the tax profile will be imported.

  • newCompanyCode (String) —

    The companyCode to use for the imported company.

  • replaceAccountSettings (Boolean) —

    Replace the current account settings with the ones in the tax profile.

  • bypassNexusValidation (Boolean) —

    Enable invalid nexus to be imported.

  • taxProfile (Object) —

    The taxProfile

Returns:

  • (Object) 


39
40
 
# File 'lib/avatax/client/taxprofiles.rb', line 39

def import_tax_profile()        path = "/api/v2/taxprofile"
post(path)      end