avatax 17.5.0 → 17.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e68966052154ce258501a8c039997122fff63ac2
-  data.tar.gz: 9d1228766e7416ba62d996181cb83dbf30dbd00b
+  metadata.gz: d024291daa0229f26ee75f83545a01c700dd1927
+  data.tar.gz: be58b1cb99c75e3a66b541b85252660ad3892573
 SHA512:
-  metadata.gz: fcf13c01588c96c59a6296ba9aca6d9e2103b7f6304eea00c8941d40d340a2fd48193fb3d35a6988f668452808f916ff9f1aa12f0b6113b5950b069034180fb1
-  data.tar.gz: f4a63d2c384e59b11d8d7f3d7296705b2f66526f5adcbd7fffd74ced8b7122c6693aa8202cf0aa3c56b3284bd37ac476b4739c14efc891324b6bdd6b0721a2ec
+  metadata.gz: 00f33c72ce25f9a0050371362695909e6f8222cef7f6edf27b4df9eb06be2baf1fd29dab70c4198e119c6e5fb208742b2f090c9186511c386d91eb5f301930ad
+  data.tar.gz: 86c779153a8aa1520b5a745691ebbca58123686d5d7ca59ef93fd7b15aabe74071a4b0012f96602496a67926d98dcccfeb28c9226fc05ad56aa850d76364b612

data/README.md

@@ -4,12 +4,13 @@ A Ruby wrapper for the AvaTax REST V2 APIs
 
 Installation
 ------------
-	gem install avatax (coming soon)
+	gem install avatax
 
 AvaTax REST and Search APIs
 ------------------------------
 Our [developer site](https://developer.avalara.com/) documents all the AvaTax REST and other APIs. Subscribe to the [RSS feed](developer.avalara.com/feed.xml) to stay up to date on the lates news and announcements.
 
+[API docs](http://www.rubydoc.info/github/avadev/AvaTax-REST-V2-Ruby-SDK/)
 
 Blog
 ----------------------------

data/lib/avatax/client/accounts.rb

@@ -4,104 +4,94 @@ module AvaTax
 
 
       # Reset this account's license key
-      # 
+      #
       # Resets the existing license key for this account to a new key.
       # To reset your account, you must specify the ID of the account you wish to reset and confirm the action.
       # Resetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created.
-      # 
-      # @param int id The ID of the account you wish to update.
-      # @param ResetLicenseKeyModel model A request confirming that you wish to reset the license key of this account.
-      # @return LicenseKeyModel
+      # @param id [Integer] The ID of the account you wish to update.
+      # @param model [Object] A request confirming that you wish to reset the license key of this account.
+      # @return [Object]
       def account_reset_license_key(id, model)
         path = "/api/v2/accounts/#{id}/resetlicensekey"
-        
         post(path, model)
       end
 
 
       # Activate an account by accepting terms and conditions
-      # 
+      #
       # Activate the account specified by the unique accountId number.
-      # 
-      # This activation request can only be called by account administrators. You must indicate 
+      #
+      # This activation request can only be called by account administrators. You must indicate
       # that you have read and accepted Avalara's terms and conditions to call this API.
-      # 
+      #
       # If you have not read or accepted the terms and conditions, this API call will return the
       # unchanged account model.
-      # 
-      # @param int id The ID of the account to activate
-      # @param ActivateAccountModel model The activation request
-      # @return AccountModel
+      # @param id [Integer] The ID of the account to activate
+      # @param model [Object] The activation request
+      # @return [Object]
       def activate_account(id, model)
         path = "/api/v2/accounts/#{id}/activate"
-        
         post(path, model)
       end
 
 
       # Retrieve a single account
-      # 
+      #
       # Get the account object identified by this URL.
       # You may use the '$include' parameter to fetch additional nested data:
-      # 
+      #
       # * Subscriptions
       # * Users
-      # 
-      # @param int id The ID of the account to retrieve
-      # @param string include A comma separated list of child objects to return underneath the primary object.
-      # @return AccountModel
+      # @param id [Integer] The ID of the account to retrieve
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @return [Object]
       def get_account(id, options={})
         path = "/api/v2/accounts/#{id}"
-        
         get(path, options)
       end
 
 
       # Get configuration settings for this account
-      # 
+      #
       # Retrieve a list of all configuration settings tied to this account.
-      # 
+      #
       # Configuration settings provide you with the ability to control features of your account and of your
       # tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for
       # Avalara internal software configuration values; to store your own account-level settings, please
       # create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
-      # 
+      #
       # Account settings are permanent settings that cannot be deleted. You can set the value of an
       # account setting to null if desired.
-      # 
+      #
       # Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
       # tax calculation and address resolution, and should only be changed with care.
-      # 
-      # @param int id 
-      # @return AccountConfigurationModel[]
+      # @param id [Integer] 
+      # @return [object[]]
       def get_account_configuration(id)
         path = "/api/v2/accounts/#{id}/configuration"
-        
         get(path)
       end
 
 
       # Change configuration settings for this account
-      # 
+      #
       # Update configuration settings tied to this account.
-      # 
+      #
       # Configuration settings provide you with the ability to control features of your account and of your
       # tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for
       # Avalara internal software configuration values; to store your own account-level settings, please
       # create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
-      # 
+      #
       # Account settings are permanent settings that cannot be deleted. You can set the value of an
       # account setting to null if desired.
-      # 
+      #
       # Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
       # tax calculation and address resolution, and should only be changed with care.
-      # 
-      # @param int id 
-      # @param AccountConfigurationModel[] model 
-      # @return AccountConfigurationModel[]
+      # @param id [Integer] 
+      # @param model [object[]] 
+      # @return [object[]]
       def set_account_configuration(id, model)
         path = "/api/v2/accounts/#{id}/configuration"
-        
         post(path, model)
       end
 

data/lib/avatax/client/addresses.rb

@@ -4,46 +4,42 @@ module AvaTax
 
 
       # Retrieve geolocation information for a specified address
-      # 
-      # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API 
-      # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used 
-      # to identify how closely this address can be located. If the address cannot be clearly located, use the 
+      #
+      # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
+      # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
+      # to identify how closely this address can be located. If the address cannot be clearly located, use the
       # 'messages' structure to learn more about problems with this address.
       # This is the same API as the POST /api/v2/addresses/resolve endpoint.
       # Both verbs are supported to provide for flexible implementation.
-      # 
-      # @param string line1 Line 1
-      # @param string line2 Line 2
-      # @param string line3 Line 3
-      # @param string city City
-      # @param string region State / Province / Region
-      # @param string postalCode Postal Code / Zip Code
-      # @param string country Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
-      # @param string textCase selectable text case for address validation (See TextCase::* for a list of allowable values)
-      # @param float latitude Geospatial latitude measurement
-      # @param float longitude Geospatial longitude measurement
-      # @return AddressResolutionModel
+      # @param line1 [String] Line 1
+      # @param line2 [String] Line 2
+      # @param line3 [String] Line 3
+      # @param city [String] City
+      # @param region [String] State / Province / Region
+      # @param postalCode [String] Postal Code / Zip Code
+      # @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
+      # @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
+      # @param latitude [BigDecimal] Geospatial latitude measurement
+      # @param longitude [BigDecimal] Geospatial longitude measurement
+      # @return [Object]
       def resolve_address(options={})
         path = "/api/v2/addresses/resolve"
-        
         get(path, options)
       end
 
 
       # Retrieve geolocation information for a specified address
-      # 
-      # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API 
-      # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used 
-      # to identify how closely this address can be located. If the address cannot be clearly located, use the 
+      #
+      # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
+      # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
+      # to identify how closely this address can be located. If the address cannot be clearly located, use the
       # 'messages' structure to learn more about problems with this address.
       # This is the same API as the GET /api/v2/addresses/resolve endpoint.
       # Both verbs are supported to provide for flexible implementation.
-      # 
-      # @param AddressValidationInfo model The address to resolve
-      # @return AddressResolutionModel
+      # @param model [Object] The address to resolve
+      # @return [Object]
       def resolve_address_post(model)
         path = "/api/v2/addresses/resolve"
-        
         post(path, model)
       end
 

data/lib/avatax/client/batches.rb

@@ -4,111 +4,99 @@ module AvaTax
 
 
       # Create a new batch
-      # 
+      #
       # Create one or more new batch objects attached to this company.
       # A batch object is a large collection of API calls stored in a compact file.
       # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
       # You may fetch a batch to check on its status and retrieve the results of the batch operation.
       # Each batch object may have one or more file objects attached.
-      # 
-      # @param int companyId The ID of the company that owns this batch.
-      # @param BatchModel[] model The batch you wish to create.
-      # @return BatchModel[]
+      # @param companyId [Integer] The ID of the company that owns this batch.
+      # @param model [object[]] The batch you wish to create.
+      # @return [object[]]
       def create_batches(companyId, model)
         path = "/api/v2/companies/#{companyId}/batches"
-        
         post(path, model)
       end
 
 
       # Delete a single batch
-      # 
+      #
       # Mark the existing batch object at this URL as deleted.
-      # 
-      # @param int companyId The ID of the company that owns this batch.
-      # @param int id The ID of the batch you wish to delete.
-      # @return ErrorDetail[]
+      # @param companyId [Integer] The ID of the company that owns this batch.
+      # @param id [Integer] The ID of the batch you wish to delete.
+      # @return [object[]]
       def delete_batch(companyId, id)
         path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        
         delete(path)
       end
 
 
       # Download a single batch file
-      # 
+      #
       # Download a single batch file identified by this URL.
-      # 
-      # @param int companyId The ID of the company that owns this batch
-      # @param int batchId The ID of the batch object
-      # @param int id The primary key of this batch file object
-      # @return FileResult
+      # @param companyId [Integer] The ID of the company that owns this batch
+      # @param batchId [Integer] The ID of the batch object
+      # @param id [Integer] The primary key of this batch file object
+      # @return [Object]
       def download_batch(companyId, batchId, id)
         path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
-        
         get(path)
       end
 
 
       # Retrieve a single batch
-      # 
+      #
       # Get the batch object identified by this URL.
       # A batch object is a large collection of API calls stored in a compact file.
       # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
       # You may fetch a batch to check on its status and retrieve the results of the batch operation.
-      # 
-      # @param int companyId The ID of the company that owns this batch
-      # @param int id The primary key of this batch
-      # @return BatchModel
+      # @param companyId [Integer] The ID of the company that owns this batch
+      # @param id [Integer] The primary key of this batch
+      # @return [Object]
       def get_batch(companyId, id)
         path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve all batches for this company
-      # 
+      #
       # List all batch objects attached to the specified company.
       # A batch object is a large collection of API calls stored in a compact file.
       # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
       # You may fetch a batch to check on its status and retrieve the results of the batch operation.
       # 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.
-      # 
-      # @param int companyId The ID of the company that owns these batches
-      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
-      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # @param companyId [Integer] The ID of the company that owns these batches
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_batches_by_company(companyId, options={})
         path = "/api/v2/companies/#{companyId}/batches"
-        
         get(path, options)
       end
 
 
       # Retrieve all batches
-      # 
+      #
       # Get multiple batch objects across all companies.
       # A batch object is a large collection of API calls stored in a compact file.
       # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
       # You may fetch a batch to check on its status and retrieve the results of the batch operation.
-      # 
+      #
       # 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.
-      # 
-      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
-      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # @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 child objects to return underneath the primary object.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_batches(options={})
         path = "/api/v2/batches"
-        
         get(path, options)
       end
 

data/lib/avatax/client/companies.rb

@@ -3,49 +3,69 @@ module AvaTax
     module Companies 
 
 
+      # Change the filing status of this company
+      #
+      # Changes the current filing status of this company.
+      #
+      # For customers using Avalara's Managed Returns Service, each company within their account can request
+      # for Avalara to file tax returns on their behalf. Avalara compliance team members will review all
+      # requested filing calendars prior to beginning filing tax returns on behalf of this company.
+      #
+      # The following changes may be requested through this API:
+      #
+      # * If a company is in `NotYetFiling` status, the customer may request this be changed to `FilingRequested`.
+      # * Avalara compliance team members may change a company from `FilingRequested` to `FirstFiling`.
+      # * Avalara compliance team members may change a company from `FirstFiling` to `Active`.
+      #
+      # All other status changes must be requested through the Avalara customer support team.
+      # @param id [Integer] 
+      # @param model [Object] 
+      # @return [String]
+      def change_filing_status(id, model)
+        path = "/api/v2/companies/#{id}/filingstatus"
+        post(path, model)
+      end
+
+
       # Quick setup for a company with a single physical address
-      # 
+      #
       # Shortcut to quickly setup a single-physical-location company with critical information and activate it.
       # This API provides quick and simple company setup functionality and does the following things:
-      #  
+      #
       # * Create a company object with its own tax profile
       # * Add a key contact person for the company
       # * Set up one physical location for the main office
       # * Declare nexus in all taxing jurisdictions for that main office address
       # * Activate the company
-      #  
-      # This API only provides a limited subset of functionality compared to the 'Create Company' API call. 
+      #
+      # This API only provides a limited subset of functionality compared to the 'Create Company' API call.
       # If you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead.
-      # 
-      # @param CompanyInitializationModel model Information about the company you wish to create.
-      # @return CompanyModel
+      # @param model [Object] Information about the company you wish to create.
+      # @return [Object]
       def company_initialize(model)
         path = "/api/v2/companies/initialize"
-        
         post(path, model)
       end
 
 
       # Create new companies
-      # 
+      #
       # Create one or more new company objects.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
       # You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
-      # 
-      # @param CompanyModel[] model Either a single company object or an array of companies to create
-      # @return CompanyModel[]
+      # @param model [object[]] Either a single company object or an array of companies to create
+      # @return [object[]]
       def create_companies(model)
         path = "/api/v2/companies"
-        
         post(path, model)
       end
 
 
       # Request managed returns funding setup for a company
-      # 
+      #
       # This API is available by invitation only.
-      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are 
-      # required to setup their funding configuration before Avalara can begin filing tax returns on their 
+      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
+      # required to setup their funding configuration before Avalara can begin filing tax returns on their
       # behalf.
       # Funding configuration for each company is set up by submitting a funding setup request, which can
       # be sent either via email or via an embedded HTML widget.
@@ -53,36 +73,32 @@ module AvaTax
       # before approval.
       # This API records that an ambedded HTML funding setup widget was activated.
       # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
-      # 
-      # @param int id The unique identifier of the company
-      # @param FundingInitiateModel model The funding initialization request
-      # @return FundingStatusModel
+      # @param id [Integer] The unique identifier of the company
+      # @param model [Object] The funding initialization request
+      # @return [Object]
       def create_funding_request(id, model)
         path = "/api/v2/companies/#{id}/funding/setup"
-        
         post(path, model)
       end
 
 
       # Delete a single company
-      # 
+      #
       # Deleting a company will delete all child companies, and all users attached to this company.
-      # 
-      # @param int id The ID of the company you wish to delete.
-      # @return ErrorDetail[]
+      # @param id [Integer] The ID of the company you wish to delete.
+      # @return [object[]]
       def delete_company(id)
         path = "/api/v2/companies/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single company
-      # 
+      #
       # Get the company object identified by this URL.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
       # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
-      # 
+      #
       #  * Contacts
       #  * Items
       #  * Locations
@@ -91,65 +107,83 @@ module AvaTax
       #  * TaxCodes
       #  * TaxRules
       #  * UPC
-      # 
-      # @param int id The ID of the company to retrieve.
-      # @param string include A comma separated list of child objects to return underneath the primary object.
-      # @return CompanyModel
+      #  * ECMS
+      # @param id [Integer] The ID of the company to retrieve.
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @return [Object]
       def get_company(id, options={})
         path = "/api/v2/companies/#{id}"
-        
         get(path, options)
       end
 
 
       # Get configuration settings for this company
-      # 
+      #
       # Retrieve a list of all configuration settings tied to this company.
-      # 
+      #
       # Configuration settings provide you with the ability to control features of your account and of your
       # tax software. The category names `AvaCertServiceConfig` is reserved for
       # Avalara internal software configuration values; to store your own account-level settings, please
       # create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
-      # 
+      #
       # Company settings are permanent settings that cannot be deleted. You can set the value of a
       # company setting to null if desired.
-      # 
+      #
       # Avalara-based account settings for `AvaCertServiceConfig` affect your account's exemption certificate
       # processing, and should only be changed with care.
-      # 
-      # @param int id 
-      # @return CompanyConfigurationModel[]
+      # @param id [Integer] 
+      # @return [object[]]
       def get_company_configuration(id)
         path = "/api/v2/companies/#{id}/configuration"
-        
+        get(path)
+      end
+
+
+      # Get this company's filing status
+      #
+      # Retrieve the current filing status of this company.
+      #
+      # For customers using Avalara's Managed Returns Service, each company within their account can request
+      # for Avalara to file tax returns on their behalf. Avalara compliance team members will review all
+      # requested filing calendars prior to beginning filing tax returns on behalf of this company.
+      #
+      # A company's filing status can be one of the following values:
+      #
+      # * `NoReporting` - This company is not configured to report tax returns; instead, it reports through a parent company.
+      # * `NotYetFiling` - This company has not yet begun filing tax returns through Avalara's Managed Returns Service.
+      # * `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing.
+      # * `FirstFiling` - The company has recently filing tax returns and is in a new status.
+      # * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns.
+      # @param id [Integer] 
+      # @return [String]
+      def get_filing_status(id)
+        path = "/api/v2/companies/#{id}/filingstatus"
         get(path)
       end
 
 
       # Check managed returns funding configuration for a company
-      # 
+      #
       # This API is available by invitation only.
       # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
       # Returns a list of funding setup requests and their current status.
       # Each object in the result is a request that was made to setup or adjust funding configuration for this company.
-      # 
-      # @param int id The unique identifier of the company
-      # @return FundingStatusModel[]
+      # @param id [Integer] The unique identifier of the company
+      # @return [object[]]
       def list_funding_requests_by_company(id)
         path = "/api/v2/companies/#{id}/funding"
-        
         get(path)
       end
 
 
       # Retrieve all companies
-      # 
+      #
       # Get multiple company objects.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # 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:
-      #  
+      #
       # * Contacts
       # * Items
       # * Locations
@@ -158,58 +192,53 @@ module AvaTax
       # * TaxCodes
       # * TaxRules
       # * UPC
-      # 
-      # @param string include A comma separated list of child objects to return underneath the primary object.
-      # @param string filter 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 int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # * ECMS
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_companies(options={})
         path = "/api/v2/companies"
-        
         get(path, options)
       end
 
 
       # Change configuration settings for this account
-      # 
+      #
       # Update configuration settings tied to this account.
-      # 
+      #
       # Configuration settings provide you with the ability to control features of your account and of your
       # tax software. The category names `AvaCertServiceConfig` is reserved for
       # Avalara internal software configuration values; to store your own account-level settings, please
       # create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
-      # 
+      #
       # Company settings are permanent settings that cannot be deleted. You can set the value of a
       # company setting to null if desired.
-      # 
+      #
       # Avalara-based account settings for `AvaCertServiceConfig` affect your account's exemption certificate
       # processing, and should only be changed with care.
-      # 
-      # @param int id 
-      # @param CompanyConfigurationModel[] model 
-      # @return CompanyConfigurationModel[]
+      # @param id [Integer] 
+      # @param model [object[]] 
+      # @return [object[]]
       def set_company_configuration(id, model)
         path = "/api/v2/companies/#{id}/configuration"
-        
         post(path, model)
       end
 
 
       # Update a single company
-      # 
+      #
       # Replace the existing company object at this URL with an updated object.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
-      # All data from the existing object will be replaced with data in the object you PUT. 
+      # 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.
-      # 
-      # @param int id The ID of the company you wish to update.
-      # @param CompanyModel model The company object you wish to update.
-      # @return CompanyModel
+      # @param id [Integer] The ID of the company you wish to update.
+      # @param model [Object] The company object you wish to update.
+      # @return [Object]
       def update_company(id, model)
         path = "/api/v2/companies/#{id}"
-        
         put(path, model)
       end