Sha256: 7a45ab0a53a7a2b67f2e8fc417d74afa1623f5d471ec260c9d541870aa2d9981

Contents?: true

Size: 1.68 KB

Versions: 18

Compression:

Stored size: 1.68 KB

Contents

module AvaTax
  class Client
    module TaxProfiles 


      # Export the tax profile of this company to a backup file
      #
      # Exports the tax profile of a company to a file, containing all information that affects tax calculation for this company.
      #
      # A tax profile is a series of decisions and configuration choices that affect your company's tax calculation. These decisions
      # include your nexus declarations, your item catalog, your custom tax rules, and so on.
      #
      # This API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this
      # profile to a different company or compare it over time to see if your profile has been changed.
      # @param companyId [Integer] The unique ID number of the company whose profile you wish to retrieve.
      # @return [Object]
      def export_tax_profile(companyId)
        path = "/api/v2/companies/#{companyId}/taxprofile"
        get(path)
      end


      # Import a tax profile.
      #
      # Imports a tax profile to a new company, along with the option to import account settings.
      # @param accountId [Integer] The account id of the account to which the tax profile will be imported.
      # @param newCompanyCode [String] The companyCode to use for the imported company.
      # @param replaceAccountSettings [Boolean] Replace the current account settings with the ones in the tax profile.
      # @param bypassNexusValidation [Boolean] Enable invalid nexus to be imported.
      # @param taxProfile [Object] The taxProfile
      # @return [Object]
      def import_tax_profile()
        path = "/api/v2/taxprofile"
        post(path)
      end

    end
  end
end

Version data entries

18 entries across 18 versions & 1 rubygems

Version Path
avatax-20.9.0 lib/avatax/client/taxprofiles.rb
avatax-20.7.1 lib/avatax/client/taxprofiles.rb
avatax-20.7.0 lib/avatax/client/taxprofiles.rb
avatax-20.6.0 lib/avatax/client/taxprofiles.rb
avatax-20.5.0 lib/avatax/client/taxprofiles.rb
avatax-20.1.0 lib/avatax/client/taxprofiles.rb
avatax-19.12.1 lib/avatax/client/taxprofiles.rb
avatax-19.12.0 lib/avatax/client/taxprofiles.rb
avatax-19.11.1 lib/avatax/client/taxprofiles.rb
avatax-19.10.0 lib/avatax/client/taxprofiles.rb
avatax-19.9.1 lib/avatax/client/taxprofiles.rb
avatax-19.9.0 lib/avatax/client/taxprofiles.rb
avatax-19.8.0 lib/avatax/client/taxprofiles.rb
avatax-19.7.0 lib/avatax/client/taxprofiles.rb
avatax-19.6.0 lib/avatax/client/taxprofiles.rb
avatax-19.5.0 lib/avatax/client/taxprofiles.rb
avatax-19.4.0 lib/avatax/client/taxprofiles.rb
avatax-19.3.0 lib/avatax/client/taxprofiles.rb