avatax 20.1.0 → 20.5.0

data/lib/avatax/client/taxcodes.rb

@@ -5,114 +5,114 @@ module AvaTax
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this tax code.
-      # @param model [TaxCodeModel[]] The tax code you wish to create.
+      # @param companyId [Integer] 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(companyId, model)        path = "/api/v2/companies/#{companyId}/taxcodes"
         post(path, model)      end
 
       # Delete a single tax code
       #
-      # Marks the existing TaxCode object at this URL as deleted.
-      #
-      # ### Security Policies
-      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this tax code.
-      # @param id [Integer] The ID of the tax code you wish to delete.
+      # @param companyId [Integer] The ID of the company that owns this tax code.
+      # @param id [Integer] The ID of the tax code you wish to delete.
       # @return [ErrorDetail[]]
       def delete_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
         delete(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this tax code
-      # @param id [Integer] The primary key of this tax code
+      # @param companyId [Integer] The ID of the company that owns this tax code
+      # @param id [Integer] The primary key of this tax code
       # @return [Object]
       def get_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
         get(path)      end
 
       # 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.
-      # 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.
-      #
-      # 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
-      #
+      # 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.
+      # 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.
+      #
+      # 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.
-      # @param companyId [Integer] 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 [Integer] 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 [Integer] 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 companyId [Integer] 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 [Integer] 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 [Integer] 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(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxcodes"
         get(path, options)      end
 
       # 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.
-      # 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.
-      #
-      # 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
-      #
+      # 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.
+      # 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.
+      #
+      # 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.
-      # @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 [Integer] 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 [Integer] 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 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 [Integer] 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 [Integer] 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(options={})        path = "/api/v2/taxcodes"
         get(path, options)      end
 
       # 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.
-      # 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.
-      # 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
-      #
+      # 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.
+      # 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.
+      # 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.
-      # @param companyId [Integer] The ID of the company that this tax code belongs to.
-      # @param id [Integer] The ID of the tax code you wish to update
-      # @param model [Object] The tax code you wish to update.
+      # @param companyId [Integer] The ID of the company that this tax code belongs to.
+      # @param id [Integer] The ID of the tax code you wish to update
+      # @param model [Object] The tax code you wish to update.
       # @return [Object]
       def update_tax_code(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
         put(path, model)      end

data/lib/avatax/client/taxcontent.rb

@@ -5,127 +5,127 @@ module AvaTax
 
       # 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
-      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
-      # governmental priorities. Any tax content downloaded for future time periods is subject to change
-      # if tax rates or tax laws change.
-      #
-      # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
-      # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
-      # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
-      # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
-      # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
-      # then use `CreateItems()` to create an item that uses the custom tax code.
-      #
-      # This data file can be customized for specific partner devices and usage conditions.
-      #
-      # The result of this API is the file you requested in the format you requested using the `responseType` field.
-      #
-      # This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
-      # file for a single location at a time, please use `BuildTaxContentFileForLocation`.
-      #
-      # 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.
+      # 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
+      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
+      # governmental priorities. Any tax content downloaded for future time periods is subject to change
+      # if tax rates or tax laws change.
+      #
+      # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
+      # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
+      # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
+      # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
+      # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
+      # then use `CreateItems()` to create an item that uses the custom tax code.
+      #
+      # This data file can be customized for specific partner devices and usage conditions.
+      #
+      # The result of this API is the file you requested in the format you requested using the `responseType` field.
+      #
+      # This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
+      # file for a single location at a time, please use `BuildTaxContentFileForLocation`.
+      #
+      # 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<br />*Required* (all): AvaTaxPro.
-      # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
+      # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
       # @return [Object]
       def build_tax_content_file(model)        path = "/api/v2/pointofsaledata/build"
         post(path, model)      end
 
       # 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
-      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
-      # governmental priorities. Any tax content downloaded for future time periods is subject to change
-      # if tax rates or tax laws change.
-      #
-      # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
-      # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
-      # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
-      # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
-      # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
-      # then use `CreateItems()` to create an item that uses the custom tax code.
-      #
-      # This data file can be customized for specific partner devices and usage conditions.
-      #
-      # The result of this API is the file you requested in the format you requested using the `responseType` field.
-      #
-      # This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
-      # file for a multiple locations in a single file, please use `BuildTaxContentFile`.
-      #
-      # 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.
+      # 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
+      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
+      # governmental priorities. Any tax content downloaded for future time periods is subject to change
+      # if tax rates or tax laws change.
+      #
+      # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
+      # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
+      # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
+      # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
+      # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
+      # then use `CreateItems()` to create an item that uses the custom tax code.
+      #
+      # This data file can be customized for specific partner devices and usage conditions.
+      #
+      # The result of this API is the file you requested in the format you requested using the `responseType` field.
+      #
+      # This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content
+      # file for a multiple locations in a single file, please use `BuildTaxContentFile`.
+      #
+      # 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<br />*Required* (all): AvaTaxPro.
-      # @param companyId [Integer] The ID number of the company that owns this location.
-      # @param id [Integer] 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 [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
-      # @param partnerId [String] 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.
+      # @param companyId [Integer] The ID number of the company that owns this location.
+      # @param id [Integer] 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 [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
+      # @param partnerId [String] 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 [Object]
       def build_tax_content_file_for_location(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
         get(path, options)      end
 
       # 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
-      # that users of this tax content API download new data every day. Many tax authorities may finalize
-      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
-      # governmental priorities. Any tax content downloaded for future time periods is subject to change
-      # if tax rates or tax laws change.
-      #
-      # This rates file is intended to be used as a default for tax calculation when your software cannot
-      # call the `CreateTransaction` API call. When using this file, your software will be unable to
-      # handle complex tax rules such as:
-      #
-      # * Zip+4 - This tax file contains five digit zip codes only.
-      # * Different product types - This tax file contains tangible personal property tax rates only.
-      # * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes.
-      # * Threshold-based taxes - This tax file does not contain information about thresholds.
-      #
-      # If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction`
-      # to reconcile the actual transaction and determine the difference between the estimated general tax
-      # rate and the final transaction tax.
-      #
-      # The file provided by this API is in CSV format with the following columns:
-      #
-      # * ZIP_CODE - The five digit zip code for this record.
-      # * STATE_ABBREV - A valid two character US state abbreviation for this record. Zip codes may span multiple states.
-      # * COUNTY_NAME - A valid county name for this record. Zip codes may span multiple counties.
-      # * CITY_NAME - A valid city name for this record. Zip codes may span multiple cities.
-      # * STATE_SALES_TAX - The state component of the sales tax rate.
-      # * STATE_USE_TAX - The state component of the use tax rate.
-      # * COUNTY_SALES_TAX - The county component of the sales tax rate.
-      # * COUNTY_USE_TAX - The county component of the use tax rate.
-      # * CITY_SALES_TAX - The city component of the sales tax rate.
-      # * CITY_USE_TAX - The city component of the use tax rate.
-      # * TOTAL_SALES_TAX - The total tax rate for sales tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.
-      # * TOTAL_USE_TAX - The total tax rate for use tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.
-      # * TAX_SHIPPING_ALONE - This column contains 'Y' if shipping is taxable.
-      # * 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
-      #
+      # 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
+      # that users of this tax content API download new data every day. Many tax authorities may finalize
+      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
+      # governmental priorities. Any tax content downloaded for future time periods is subject to change
+      # if tax rates or tax laws change.
+      #
+      # This rates file is intended to be used as a default for tax calculation when your software cannot
+      # call the `CreateTransaction` API call. When using this file, your software will be unable to
+      # handle complex tax rules such as:
+      #
+      # * Zip+4 - This tax file contains five digit zip codes only.
+      # * Different product types - This tax file contains tangible personal property tax rates only.
+      # * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes.
+      # * Threshold-based taxes - This tax file does not contain information about thresholds.
+      #
+      # If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction`
+      # to reconcile the actual transaction and determine the difference between the estimated general tax
+      # rate and the final transaction tax.
+      #
+      # The file provided by this API is in CSV format with the following columns:
+      #
+      # * ZIP_CODE - The five digit zip code for this record.
+      # * STATE_ABBREV - A valid two character US state abbreviation for this record. Zip codes may span multiple states.
+      # * COUNTY_NAME - A valid county name for this record. Zip codes may span multiple counties.
+      # * CITY_NAME - A valid city name for this record. Zip codes may span multiple cities.
+      # * STATE_SALES_TAX - The state component of the sales tax rate.
+      # * STATE_USE_TAX - The state component of the use tax rate.
+      # * COUNTY_SALES_TAX - The county component of the sales tax rate.
+      # * COUNTY_USE_TAX - The county component of the use tax rate.
+      # * CITY_SALES_TAX - The city component of the sales tax rate.
+      # * CITY_USE_TAX - The city component of the use tax rate.
+      # * TOTAL_SALES_TAX - The total tax rate for sales tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.
+      # * TOTAL_USE_TAX - The total tax rate for use tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.
+      # * TAX_SHIPPING_ALONE - This column contains 'Y' if shipping is taxable.
+      # * 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.
-      # @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.
+      # @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 [Object]
       def download_tax_rates_by_zip_code(date, options={})        path = "/api/v2/taxratesbyzipcode/download/#{date}"
         get(path, options)      end

data/lib/avatax/client/taxrules.rb

@@ -5,164 +5,164 @@ module AvaTax
 
       # 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
-      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
-      # with the transaction.
-      #
-      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
-      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
-      # custom tax rules to redefine the behavior for your company or item.
-      #
-      # 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
-      #
+      # 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
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this tax rule.
-      # @param model [TaxRuleModel[]] The tax rule you wish to create.
+      # @param companyId [Integer] 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(companyId, model)        path = "/api/v2/companies/#{companyId}/taxrules"
         post(path, model)      end
 
       # 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
-      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
-      # with the transaction.
-      #
-      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
-      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
-      # custom tax rules to redefine the behavior for your company or item.
-      #
-      # 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
-      #
+      # 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
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this tax rule.
-      # @param id [Integer] The ID of the tax rule you wish to delete.
+      # @param companyId [Integer] The ID of the company that owns this tax rule.
+      # @param id [Integer] The ID of the tax rule you wish to delete.
       # @return [ErrorDetail[]]
       def delete_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
         delete(path)      end
 
       # 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
-      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
-      # with the transaction.
-      #
-      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
-      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
-      # custom tax rules to redefine the behavior for your company or item.
-      #
-      # 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
-      #
+      # 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
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this tax rule
-      # @param id [Integer] The primary key of this tax rule
+      # @param companyId [Integer] The ID of the company that owns this tax rule
+      # @param id [Integer] The primary key of this tax rule
       # @return [Object]
       def get_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
         get(path)      end
 
       # 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
-      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
-      # with the transaction.
-      #
-      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
-      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
-      # custom tax rules to redefine the behavior for your company or item.
-      #
-      # 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.
-      #
-      # 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
-      #
+      # 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
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # 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.
+      #
+      # 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.
-      # @param companyId [Integer] 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/).<br />*Not filterable:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
-      # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] 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 [Integer] 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 companyId [Integer] 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/).<br />*Not filterable:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
+      # @param include [String] A comma separated list of additional data to retrieve.
+      # @param top [Integer] 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 [Integer] 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(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxrules"
         get(path, options)      end
 
       # 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
-      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
-      # with the transaction.
-      #
-      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
-      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
-      # custom tax rules to redefine the behavior for your company or item.
-      #
-      # 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.
-      #
-      # 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
-      #
+      # 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
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # 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.
+      #
+      # 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.
-      # @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/).<br />*Not filterable:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
-      # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] 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 [Integer] 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 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/).<br />*Not filterable:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
+      # @param include [String] A comma separated list of additional data to retrieve.
+      # @param top [Integer] 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 [Integer] 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(options={})        path = "/api/v2/taxrules"
         get(path, options)      end
 
       # 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
-      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
-      # with the transaction.
-      #
-      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
-      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
-      # custom tax rules to redefine the behavior for your company or item.
-      #
-      # 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
-      #
+      # 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
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that this tax rule belongs to.
-      # @param id [Integer] The ID of the tax rule you wish to update
-      # @param model [Object] The tax rule you wish to update.
+      # @param companyId [Integer] The ID of the company that this tax rule belongs to.
+      # @param id [Integer] The ID of the tax rule you wish to update
+      # @param model [Object] The tax rule you wish to update.
       # @return [Object]
       def update_tax_rule(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
         put(path, model)      end