avatax 20.1.0 → 20.5.0

data/lib/avatax/client/filings.rb

@@ -5,20 +5,20 @@ module AvaTax
 
       # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
       #
-      # ### 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
+      # ### 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
       # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns these batches
-      # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
-      # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
-      # @param frequency [String] The frequency of the return you are trying to retrieve (See FilingFrequencyId::* for a list of allowable values)
-      # @param status [String] The status of the return(s) you are trying to retrieve (See FilingStatusId::* for a list of allowable values)
-      # @param country [String] The country of the return(s) you are trying to retrieve
-      # @param region [String] The region of the return(s) you are trying to retrieve
-      # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
-      # @param taxformCode [String] The unique tax form code of the form.
+      # @param companyId [Integer] The ID of the company that owns these batches
+      # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
+      # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
+      # @param frequency [String] The frequency of the return you are trying to retrieve (See FilingFrequencyId::* for a list of allowable values)
+      # @param status [String] The status of the return(s) you are trying to retrieve (See FilingStatusId::* for a list of allowable values)
+      # @param country [String] The country of the return(s) you are trying to retrieve
+      # @param region [String] The region of the return(s) you are trying to retrieve
+      # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
+      # @param taxformCode [String] The unique tax form code of the form.
       # @return [FetchResult]
       def get_filed_returns(companyId, options={})        path = "/api/v2/companies/#{companyId}/filings/returns/filed"
         get(path, options)      end

data/lib/avatax/client/firmclientlinkages.rb

@@ -5,117 +5,117 @@ module AvaTax
 
       # Approves linkage to a firm for a client account
       #
-      # This API enables the account admin of a client account to approve linkage request by a firm.
-      #
-      # ### Security Policies
-      #
+      # This API enables the account admin of a client account to approve linkage request by a firm.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param id [Integer] 
+      # @param id [Integer] 
       # @return [Object]
       def approve_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/approve"
         post(path)      end
 
       # Request a new FirmClient account and create an approved linkage to it
       #
-      # This API is for use by Firms only.
-      #
-      # Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
-      # Firms can create accounts of FirmClient for customers they are managing using this API.
-      #
-      # Calling this API creates an account with the specified product subscriptions, but without a new user for account.
-      # Account is then linked to the Firm so they can managed their returns.
-      # You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm.
-      #
-      # The created account will be created in `Active` status but there will be no user or license key associated with account.
-      #
-      # ### Security Policies
-      #
+      # This API is for use by Firms only.
+      #
+      # Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
+      # Firms can create accounts of FirmClient for customers they are managing using this API.
+      #
+      # Calling this API creates an account with the specified product subscriptions, but without a new user for account.
+      # Account is then linked to the Firm so they can managed their returns.
+      # You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm.
+      #
+      # The created account will be created in `Active` status but there will be no user or license key associated with account.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
-      # @param model [Object] Information about the account you wish to create.
+      # @param model [Object] Information about the account you wish to create.
       # @return [Object]
       def create_and_link_new_firm_client_account(model)        path = "/api/v2/firmclientlinkages/createandlinkclient"
         post(path, model)      end
 
       # Links a firm account with the client account
       #
-      # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
-      #
-      # ### Security Policies
-      #
+      # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param model [Object] FirmClientLinkageInputModel
+      # @param model [Object] FirmClientLinkageInputModel
       # @return [Object]
       def create_firm_client_linkage(model)        path = "/api/v2/firmclientlinkages"
         post(path, model)      end
 
       # Delete a linkage
       #
-      # This API marks a linkage between a firm and client as deleted.
-      #
-      # ### Security Policies
-      #
+      # This API marks a linkage between a firm and client as deleted.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param id [Integer] 
+      # @param id [Integer] 
       # @return [ErrorDetail[]]
       def delete_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
         delete(path)      end
 
       # Get linkage between a firm and client by id
       #
-      # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
-      #
-      # ### Security Policies
-      #
+      # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param id [Integer] 
+      # @param id [Integer] 
       # @return [Object]
       def get_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
         get(path)      end
 
       # List client linkages for a firm or client
       #
-      # This API enables the firm or account users to request the associated linkages to the account.
-      #
-      # ### Security Policies
-      #
+      # This API enables the firm or account users to request the associated linkages to the account.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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:* firmAccountName, clientAccountName
+      # @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:* firmAccountName, clientAccountName
       # @return [FetchResult]
       def list_firm_client_linkage(options={})        path = "/api/v2/firmclientlinkages"
         get(path, options)      end
 
       # Rejects linkage to a firm for a client account
       #
-      # This API enables the account admin of a client account to reject linkage request by a firm.
-      #
-      # ### Security Policies
-      #
+      # This API enables the account admin of a client account to reject linkage request by a firm.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param id [Integer] 
+      # @param id [Integer] 
       # @return [Object]
       def reject_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reject"
         post(path)      end
 
       # Reset linkage status between a client and firm back to requested
       #
-      # This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
-      #
-      # ### Security Policies
-      #
+      # This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param id [Integer] 
+      # @param id [Integer] 
       # @return [Object]
       def reset_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reset"
         post(path)      end
 
       # Revokes previously approved linkage to a firm for a client account
       #
-      # This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
-      #
-      # ### Security Policies
-      #
+      # This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
+      #
+      # ### Security Policies
+      #
       # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param id [Integer] 
+      # @param id [Integer] 
       # @return [Object]
       def revoke_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/revoke"
         post(path)      end

data/lib/avatax/client/free.rb

@@ -5,94 +5,94 @@ module AvaTax
 
       # FREE API - Request a free trial of AvaTax
       #
-      # Call this API to obtain a free AvaTax account.
-      #
-      # This API is free to use. No authentication credentials are required to call this API. You must read and
-      # accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be
-      # created.
-      #
-      # If all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality
-      # available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/).
-      #
-      # After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/).
-      #
-      # ### Security Policies
-      #
+      # Call this API to obtain a free AvaTax account.
+      #
+      # This API is free to use. No authentication credentials are required to call this API. You must read and
+      # accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be
+      # created.
+      #
+      # If all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality
+      # available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/).
+      #
+      # After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/).
+      #
+      # ### Security Policies
+      #
       # * This API may be called without providing authentication credentials.
-      # @param model [Object] Required information to provision a free trial account.
+      # @param model [Object] Required information to provision a free trial account.
       # @return [Object]
       def request_free_trial(model)        path = "/api/v2/accounts/freetrials/request"
         post(path, model)      end
 
       # FREE API - Sales tax rates for a specified address
       #
-      # # Free-To-Use
-      #
-      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
-      # Any customer can request a free AvaTax account and make use of the TaxRates API.
-      #
-      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
-      # response code 429 - `Too Many Requests`.
-      #
-      # This API assumes that you are selling general tangible personal property at a retail point-of-sale
-      # location in the United States only.
-      #
-      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
-      # which supports features including, but not limited to:
-      #
-      # * Nexus declarations
-      # * Taxability based on product/service type
-      # * Sourcing rules affecting origin/destination states
-      # * Customers who are exempt from certain taxes
-      # * States that have dollar value thresholds for tax amounts
-      # * Refunds for products purchased on a different date
-      # * Detailed jurisdiction names and state assigned codes
-      # * And more!
-      #
-      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
+      # # Free-To-Use
+      #
+      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
+      # Any customer can request a free AvaTax account and make use of the TaxRates API.
+      #
+      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
+      # response code 429 - `Too Many Requests`.
+      #
+      # This API assumes that you are selling general tangible personal property at a retail point-of-sale
+      # location in the United States only.
+      #
+      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
+      # which supports features including, but not limited to:
+      #
+      # * Nexus declarations
+      # * Taxability based on product/service type
+      # * Sourcing rules affecting origin/destination states
+      # * Customers who are exempt from certain taxes
+      # * States that have dollar value thresholds for tax amounts
+      # * Refunds for products purchased on a different date
+      # * Detailed jurisdiction names and state assigned codes
+      # * And more!
+      #
+      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # @param line1 [String] The street address of the location.
-      # @param line2 [String] The street address of the location.
-      # @param line3 [String] The street address of the location.
-      # @param city [String] The city name of the location.
-      # @param region [String] Name or ISO 3166 code identifying the region within the country.     This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions     For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
-      # @param postalCode [String] The postal code of the location.
-      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
+      # @param line1 [String] The street address of the location.
+      # @param line2 [String] The street address of the location.
+      # @param line3 [String] The street address of the location.
+      # @param city [String] The city name of the location.
+      # @param region [String] Name or ISO 3166 code identifying the region within the country.     This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions     For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
+      # @param postalCode [String] The postal code of the location.
+      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @return [Object]
       def tax_rates_by_address(options={})        path = "/api/v2/taxrates/byaddress"
         get(path, options)      end
 
       # FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
       #
-      # # Free-To-Use
-      #
-      # This API is only available for a US postal codes.
-      #
-      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
-      # Any customer can request a free AvaTax account and make use of the TaxRates API.
-      #
-      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
-      # response code 429 - `Too Many Requests`.
-      #
-      # This API assumes that you are selling general tangible personal property at a retail point-of-sale
-      # location in the United States only.
-      #
-      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
-      # which supports features including, but not limited to:
-      #
-      # * Nexus declarations
-      # * Taxability based on product/service type
-      # * Sourcing rules affecting origin/destination states
-      # * Customers who are exempt from certain taxes
-      # * States that have dollar value thresholds for tax amounts
-      # * Refunds for products purchased on a different date
-      # * Detailed jurisdiction names and state assigned codes
-      # * And more!
-      #
-      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
+      # # Free-To-Use
+      #
+      # This API is only available for a US postal codes.
+      #
+      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
+      # Any customer can request a free AvaTax account and make use of the TaxRates API.
+      #
+      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
+      # response code 429 - `Too Many Requests`.
+      #
+      # This API assumes that you are selling general tangible personal property at a retail point-of-sale
+      # location in the United States only.
+      #
+      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
+      # which supports features including, but not limited to:
+      #
+      # * Nexus declarations
+      # * Taxability based on product/service type
+      # * Sourcing rules affecting origin/destination states
+      # * Customers who are exempt from certain taxes
+      # * States that have dollar value thresholds for tax amounts
+      # * Refunds for products purchased on a different date
+      # * Detailed jurisdiction names and state assigned codes
+      # * And more!
+      #
+      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
-      # @param postalCode [String] The postal code of the location.
+      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
+      # @param postalCode [String] The postal code of the location.
       # @return [Object]
       def tax_rates_by_postal_code(options={})        path = "/api/v2/taxrates/bypostalcode"
         get(path, options)      end

data/lib/avatax/client/fundingrequests.rb

@@ -5,46 +5,46 @@ module AvaTax
 
       # Request the javascript for a funding setup widget
       #
-      # 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
-      # 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.
-      # When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members
-      # before approval.
-      # This API returns back the actual javascript code to insert into your application to render the
-      # JavaScript funding setup widget inline.
-      # Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page.
-      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
-      #
-      # ### 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 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
+      # 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.
+      # When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members
+      # before approval.
+      # This API returns back the actual javascript code to insert into your application to render the
+      # JavaScript funding setup widget inline.
+      # Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page.
+      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      #
+      # ### 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 />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param id [Integer] The unique ID number of this funding request
+      # @param id [Integer] The unique ID number of this funding request
       # @return [Object]
       def activate_funding_request(id)        path = "/api/v2/fundingrequests/#{id}/widget"
         get(path)      end
 
       # Retrieve status about a funding setup request
       #
-      # 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
-      # 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.
-      # When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members
-      # before approval.
-      # This API checks the status on an existing funding request.
-      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # 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
+      # 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.
+      # When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members
+      # before approval.
+      # This API checks the status on an existing funding request.
+      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param id [Integer] The unique ID number of this funding request
+      # @param id [Integer] The unique ID number of this funding request
       # @return [Object]
       def funding_request_status(id)        path = "/api/v2/fundingrequests/#{id}"
         get(path)      end