avatax 20.1.0 → 20.5.0

data/lib/avatax/client/items.rb

@@ -5,417 +5,417 @@ module AvaTax
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item.
-      # @param itemId [Integer] The ID of the item you wish to delete the classifications.
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param itemId [Integer] The ID of the item you wish to delete the classifications.
       # @return [ErrorDetail[]]
       def batch_delete_item_classifications(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
         delete(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item.
-      # @param itemId [Integer] The ID of the item you wish to delete the parameters.
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param itemId [Integer] The ID of the item you wish to delete the parameters.
       # @return [ErrorDetail[]]
       def batch_delete_item_parameters(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
         delete(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id.
-      # @param itemId [Integer] The item id.
-      # @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
+      # @param companyId [Integer] The company id.
+      # @param itemId [Integer] The item id.
+      # @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
       # @return [ItemClassificationOutputModel[]]
       def create_item_classifications(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
         post(path, model)      end
 
       # 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 .
-      #
-      # A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
-      #
-      # 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
-      #
+      # 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 .
+      #
+      # A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item parameter.
-      # @param itemId [Integer] The item id.
-      # @param model [ItemParameterModel[]] The item parameters you wish to create.
+      # @param companyId [Integer] The ID of the company that owns this item parameter.
+      # @param itemId [Integer] The item id.
+      # @param model [ItemParameterModel[]] The item parameters you wish to create.
       # @return [ItemParameterModel[]]
       def create_item_parameters(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
         post(path, model)      end
 
       # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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.
-      #
-      # The tax code takes precedence over the tax code id if both are provided.
-      #
-      # ### Security Policies
-      #
+      # 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item.
-      # @param model [ItemModel[]] The item you wish to create.
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param model [ItemModel[]] The item you wish to create.
       # @return [ItemModel[]]
       def create_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items"
         post(path, model)      end
 
       # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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.
-      #
-      # Deleting an item will also delete the parameters and classifications associated with that item.
-      #
-      # ### Security Policies
-      #
+      # 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item.
-      # @param id [Integer] The ID of the item you wish to delete.
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param id [Integer] The ID of the item you wish to delete.
       # @return [ErrorDetail[]]
       def delete_item(companyId, id)        path = "/api/v2/companies/#{companyId}/items/#{id}"
         delete(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id.
-      # @param itemId [Integer] The item id.
-      # @param id [Integer] The item classification id.
+      # @param companyId [Integer] The company id.
+      # @param itemId [Integer] The item id.
+      # @param id [Integer] The item classification id.
       # @return [ErrorDetail[]]
       def delete_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
         delete(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id
-      # @param itemId [Integer] The item id
-      # @param id [Integer] The parameter id
+      # @param companyId [Integer] The company id
+      # @param itemId [Integer] The item id
+      # @param id [Integer] The parameter id
       # @return [ErrorDetail[]]
       def delete_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         delete(path)      end
 
       # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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
-      #
+      # 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item object
-      # @param id [Integer] The primary key of this item
-      # @param include [String] A comma separated list of additional data to retrieve.
+      # @param companyId [Integer] The ID of the company that owns this item object
+      # @param id [Integer] The primary key of this item
+      # @param include [String] A comma separated list of additional data to retrieve.
       # @return [Object]
       def get_item(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/items/#{id}"
         get(path, options)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id.
-      # @param itemId [Integer] The item id.
-      # @param id [Integer] The item classification id.
+      # @param companyId [Integer] The company id.
+      # @param itemId [Integer] The item id.
+      # @param id [Integer] The item classification id.
       # @return [Object]
       def get_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
         get(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id
-      # @param itemId [Integer] The item id
-      # @param id [Integer] The parameter id
+      # @param companyId [Integer] The company id
+      # @param itemId [Integer] The item id
+      # @param id [Integer] The parameter id
       # @return [Object]
       def get_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         get(path)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id.
-      # @param itemId [Integer] 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/).<br />*Not filterable:* productCode, systemCode
-      # @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 company id.
+      # @param itemId [Integer] 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/).<br />*Not filterable:* productCode, systemCode
+      # @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_item_classifications(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
         get(path, options)      end
 
       # 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 .
-      #
-      # A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
-      #
-      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      #
-      # ### Security Policies
-      #
+      # 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 .
+      #
+      # A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param companyId [Integer] The company id
-      # @param itemId [Integer] 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/).<br />*Not filterable:* name, unit
-      # @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 company id
+      # @param itemId [Integer] 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/).<br />*Not filterable:* name, unit
+      # @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_item_parameters(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
         get(path, options)      end
 
       # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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.
-      #
-      # 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.
-      #
-      # 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
-      # * Classifications
-      #
-      # ### Security Policies
-      #
+      # 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
+      #
+      # 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.
+      #
+      # 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
+      # * Classifications
+      #
+      # ### 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 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/).<br />*Not filterable:* taxCode, classifications, parameters
-      # @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 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/).<br />*Not filterable:* taxCode, classifications, parameters
+      # @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_items_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/items"
         get(path, options)      end
 
       # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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.
-      #
-      # 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 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
+      #
+      # 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, classifications, parameters
-      # @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, classifications, parameters
+      # @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_items(options={})        path = "/api/v2/items"
         get(path, options)      end
 
       # 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.
-      #
-      # This API is currently limited to 1000 items per call (the limit is subject to change).
-      #
-      # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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
-      #
+      # 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.
+      #
+      # This API is currently limited to 1000 items per call (the limit is subject to change).
+      #
+      # 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
-      # @param companyId [Integer] The ID of the company that owns this item.
-      # @param model [Object] The request object.
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param model [Object] The request object.
       # @return [Object]
       def sync_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/sync"
         post(path, model)      end
 
       # 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,
-      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
-      # 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.
-      #
-      # 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.
-      #
-      # The tax code takes precedence over the tax code id if both are provided.
-      #
-      # ### Security Policies
-      #
+      # 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,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # 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.
+      #
+      # 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.
+      #
+      # 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.
-      # @param companyId [Integer] The ID of the company that this item belongs to.
-      # @param id [Integer] The ID of the item you wish to update
-      # @param model [Object] The item object you wish to update.
+      # @param companyId [Integer] The ID of the company that this item belongs to.
+      # @param id [Integer] The ID of the item you wish to update
+      # @param model [Object] The item object you wish to update.
       # @return [Object]
       def update_item(companyId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{id}"
         put(path, model)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id.
-      # @param itemId [Integer] The item id.
-      # @param id [Integer] The item classification id.
-      # @param model [Object] The item object you wish to update.
+      # @param companyId [Integer] The company id.
+      # @param itemId [Integer] The item id.
+      # @param id [Integer] The item classification id.
+      # @param model [Object] The item object you wish to update.
       # @return [Object]
       def update_item_classification(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
         put(path, model)      end
 
       # 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
-      #
+      # 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.
-      # @param companyId [Integer] The company id.
-      # @param itemId [Integer] The item id
-      # @param id [Integer] The item parameter id
-      # @param model [Object] The item object you wish to update.
+      # @param companyId [Integer] The company id.
+      # @param itemId [Integer] The item id
+      # @param id [Integer] The item parameter id
+      # @param model [Object] The item object you wish to update.
       # @return [Object]
       def update_item_parameter(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         put(path, model)      end