lib/avatax/client/definitions.rb in avatax-20.7.0 vs lib/avatax/client/definitions.rb in avatax-20.7.1

- old
+ new

@@ -20,32 +20,26 @@ # # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal. # @param country [String] The name or code of the destination country. # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents. # @return [FetchResult] - def get_cross_border_code(country, hsCode) - path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy" - get(path) - end + def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy" + get(path) end - # Test whether a form supports online login verification # # This API is intended to be useful to identify whether the user should be allowed # to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification. # @param form [String] The name of the form you would like to verify. This is the tax form code # @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields # @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 get_login_verifier_by_form(form, options={}) - path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}" - get(path, options) - end + def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}" + get(path, options) end - # Retrieve the full list of the AvaFile Forms available # # This API is deprecated. # # Please use the ListTaxForms API. @@ -55,16 +49,13 @@ # @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:* outletTypeId # @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_ava_file_forms(options={}) - path = "/api/v2/definitions/avafileforms" - get(path, options) - end + def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms" + get(path, options) end - # List certificate attributes used by a company # # List the certificate attributes defined by a company either specified by the user or the user's default company. # # A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a @@ -76,16 +67,13 @@ # @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. 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_certificate_attributes(options={}) - path = "/api/v2/definitions/certificateattributes" - get(path, options) - end + def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes" + get(path, options) end - # List the certificate exempt reasons defined by a company # # List the certificate exempt reasons defined by a company. # # An exemption reason defines why a certificate allows a customer to be exempt @@ -96,16 +84,13 @@ # @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. 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_certificate_exempt_reasons(options={}) - path = "/api/v2/definitions/certificateexemptreasons" - get(path, options) - end + def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons" + get(path, options) end - # List certificate exposure zones used by a company # # List the certificate exposure zones defined by a company. # # An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing @@ -116,77 +101,62 @@ # @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:* id, companyId, name, tag, description, created, modified, region, country # @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_certificate_exposure_zones(options={}) - path = "/api/v2/definitions/certificateexposurezones" - get(path, options) - end + def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones" + get(path, options) end - # Retrieve the full list of communications service types # # Returns full list of service types for a given transaction type ID. # @param id [Integer] The transaction type ID to examine # @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:* requiredParameters # @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_communications_service_types(id, options={}) - path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes" - get(path, options) - end + def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes" + get(path, options) end - # Retrieve the full list of communications transactiontypes # # Returns full list of communications transaction types which # are accepted in communication tax calculation requests. # @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. 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_communications_transaction_types(options={}) - path = "/api/v2/definitions/communications/transactiontypes" - get(path, options) - end + def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes" + get(path, options) end - # Retrieve the full list of communications transaction/service type pairs # # Returns full list of communications transaction/service type pairs which # are accepted in communication tax calculation requests. # @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:* requiredParameters # @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_communications_t_s_pairs(options={}) - path = "/api/v2/definitions/communications/tspairs" - get(path, options) - end + def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs" + get(path, options) end - # List all ISO 3166 countries # # Returns a list of all ISO 3166 country codes, and their US English friendly names. # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for # a shipping address. # @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:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion # @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_countries(options={}) - path = "/api/v2/definitions/countries" - get(path, options) - end + def list_countries(options={}) path = "/api/v2/definitions/countries" + get(path, options) end - # List certificate exposure zones used by a company # # List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. # # The CoverLetter model represents a message sent along with an invitation to use CertExpress to @@ -198,16 +168,13 @@ # @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:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version # @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_cover_letters(options={}) - path = "/api/v2/definitions/coverletters" - get(path, options) - end + def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters" + get(path, options) end - # Lists the next level of HS Codes given a destination country and HS Code prefix. # # Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if # additional children are available. # @@ -225,16 +192,13 @@ # @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:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength # @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_cross_border_codes(country, hsCode, options={}) - path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}" - get(path, options) - end + def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}" + get(path, options) end - # List top level HS Code Sections. # # Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for # classifying tariff codes and the items to which they apply. HS Codes are organized # by Section/Chapter/Heading/Subheading/Classification. @@ -244,16 +208,13 @@ # # ### Security Policies # # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal. # @return [FetchResult] - def list_cross_border_sections() - path = "/api/v2/definitions/crossborder/sections" - get(path) - end + def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections" + get(path) end - # List all ISO 4217 currencies supported by AvaTax. # # Lists all ISO 4217 currencies supported by AvaTax. # # This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the @@ -261,16 +222,13 @@ # @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. 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_currencies(options={}) - path = "/api/v2/definitions/currencies" - get(path, options) - end + def list_currencies(options={}) path = "/api/v2/definitions/currencies" + get(path, options) end - # Retrieve the full list of Avalara-supported entity use codes # # Returns the full list of Avalara-supported entity use codes. # Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction # is occurring. This information is generally used to determine taxability of the product. @@ -279,31 +237,25 @@ # @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:* validCountries # @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_entity_use_codes(options={}) - path = "/api/v2/definitions/entityusecodes" - get(path, options) - end + def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes" + get(path, options) end - # Retrieve the full list of Avalara-supported filing frequencies. # # Returns the full list of Avalara-supported filing frequencies. # This API is intended to be useful to identify all the different filing frequencies that can be used in notices. # @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. 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_filing_frequencies(options={}) - path = "/api/v2/definitions/filingfrequencies" - get(path, options) - end + def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies" + get(path, options) end - # List jurisdictions based on the filter provided # # Returns a list of all Avalara-supported taxing jurisdictions. # # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying @@ -313,16 +265,13 @@ # @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:* rate, salesRate, signatureCode, useRate # @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_jurisdictions(options={}) - path = "/api/v2/definitions/jurisdictions" - get(path, options) - end + def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions" + get(path, options) end - # List jurisdictions near a specific address # # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. # # This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information. @@ -340,16 +289,13 @@ # @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:* country, Jurisdictions # @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_jurisdictions_by_address(options={}) - path = "/api/v2/definitions/jurisdictionsnearaddress" - get(path, options) - end + def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress" + get(path, options) end - # Retrieve the list of questions that are required for a tax location # # Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. # Some tax jurisdictions require that you register or provide additional information to configure each physical place where # your company does business. @@ -368,62 +314,50 @@ # @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. 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_location_questions_by_address(options={}) - path = "/api/v2/definitions/locationquestions" - get(path, options) - end + def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions" + get(path, options) end - # List all forms where logins can be verified automatically # # List all forms where logins can be verified automatically. # This API is intended to be useful to identify whether the user should be allowed # to automatically verify their login and password. # @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields # @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_login_verifiers(options={}) - path = "/api/v2/definitions/filingcalendars/loginverifiers" - get(path, options) - end + def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers" + get(path, options) end - # Retrieve the list of locations for a marketplace. # # Retrieves the list of suggested locations for a marketplace. # @param marketplaceId [String] MarketplaceId of a marketplace # @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_marketplace_locations(options={}) - path = "/api/v2/definitions/marketplacelocations" - get(path, options) - end + def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations" + get(path, options) end - # Retrieve the full list of Avalara-supported nexus for all countries and regions. # # Returns the full list of all Avalara-supported nexus for all countries and regions. # # This API is intended to be useful if your user interface needs to display a selectable list of nexus. # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters # @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_nexus(options={}) - path = "/api/v2/definitions/nexus" - get(path, options) - end + def list_nexus(options={}) path = "/api/v2/definitions/nexus" + get(path, options) end - # List all nexus that apply to a specific address. # # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. # This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale. # In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address @@ -439,16 +373,13 @@ # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters # @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_nexus_by_address(options={}) - path = "/api/v2/definitions/nexus/byaddress" - get(path, options) - end + def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress" + get(path, options) end - # Retrieve the full list of Avalara-supported nexus for a country. # # Returns all Avalara-supported nexus for the specified country. # # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country. @@ -456,16 +387,13 @@ # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters # @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_nexus_by_country(country, options={}) - path = "/api/v2/definitions/nexus/#{country}" - get(path, options) - end + def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}" + get(path, options) end - # Retrieve the full list of Avalara-supported nexus for a country and region. # # Returns all Avalara-supported nexus for the specified country and region. # # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region. @@ -474,16 +402,13 @@ # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters # @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_nexus_by_country_and_region(country, region, options={}) - path = "/api/v2/definitions/nexus/#{country}/#{region}" - get(path, options) - end + def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}" + get(path, options) end - # List nexus related to a tax form # # Retrieves a list of nexus related to a tax form. # # The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated @@ -499,182 +424,146 @@ # ### Security Policies # # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. # @param formCode [String] The form code that we are looking up the nexus for # @return [Object] - def list_nexus_by_form_code(formCode) - path = "/api/v2/definitions/nexus/byform/#{formCode}" - get(path) - end + def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}" + get(path) end - # Retrieve the full list of nexus tax type groups # # Returns the full list of Avalara-supported nexus tax type groups # This API is intended to be useful to identify all the different tax sub-types. # @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn # @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_nexus_tax_type_groups(options={}) - path = "/api/v2/definitions/nexustaxtypegroups" - get(path, options) - end + def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice customer funding options. # # Returns the full list of Avalara-supported tax notice customer funding options. # This API is intended to be useful to identify all the different notice customer funding options that can be used in notices. # @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:* activeFlag, sortOrder # @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_notice_customer_funding_options(options={}) - path = "/api/v2/definitions/noticecustomerfundingoptions" - get(path, options) - end + def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice customer types. # # Returns the full list of Avalara-supported tax notice customer types. # This API is intended to be useful to identify all the different notice customer types. # @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:* activeFlag, sortOrder # @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_notice_customer_types(options={}) - path = "/api/v2/definitions/noticecustomertypes" - get(path, options) - end + def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice filing types. # # Returns the full list of Avalara-supported tax notice filing types. # This API is intended to be useful to identify all the different notice filing types that can be used in notices. # @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:* description, activeFlag, sortOrder # @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_notice_filingtypes(options={}) - path = "/api/v2/definitions/noticefilingtypes" - get(path, options) - end + def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice priorities. # # Returns the full list of Avalara-supported tax notice priorities. # This API is intended to be useful to identify all the different notice priorities that can be used in notices. # @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:* activeFlag, sortOrder # @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_notice_priorities(options={}) - path = "/api/v2/definitions/noticepriorities" - get(path, options) - end + def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice reasons. # # Returns the full list of Avalara-supported tax notice reasons. # This API is intended to be useful to identify all the different tax notice reasons. # @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:* description, activeFlag, sortOrder # @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_notice_reasons(options={}) - path = "/api/v2/definitions/noticereasons" - get(path, options) - end + def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice responsibility ids # # Returns the full list of Avalara-supported tax notice responsibility ids # This API is intended to be useful to identify all the different tax notice responsibilities. # @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:* sortOrder # @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_notice_responsibilities(options={}) - path = "/api/v2/definitions/noticeresponsibilities" - get(path, options) - end + def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice root causes # # Returns the full list of Avalara-supported tax notice root causes # This API is intended to be useful to identify all the different tax notice root causes. # @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:* sortOrder # @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_notice_root_causes(options={}) - path = "/api/v2/definitions/noticerootcauses" - get(path, options) - end + def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice statuses. # # Returns the full list of Avalara-supported tax notice statuses. # This API is intended to be useful to identify all the different tax notice statuses. # @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:* isOpen, sortOrder # @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_notice_statuses(options={}) - path = "/api/v2/definitions/noticestatuses" - get(path, options) - end + def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses" + get(path, options) end - # Retrieve the full list of Avalara-supported tax notice types. # # Returns the full list of Avalara-supported tax notice types. # This API is intended to be useful to identify all the different notice types that can be used in notices. # @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:* activeFlag, sortOrder # @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_notice_types(options={}) - path = "/api/v2/definitions/noticetypes" - get(path, options) - end + def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes" + get(path, options) end - # Retrieve the full list of Avalara-supported extra parameters for creating transactions. # # Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. # This list of parameters is available for use when configuring your transaction. # Some parameters are only available for use if you have subscribed to certain features of AvaTax. # @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:* serviceTypes, regularExpression, values # @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_parameters(options={}) - path = "/api/v2/definitions/parameters" - get(path, options) - end + def list_parameters(options={}) path = "/api/v2/definitions/parameters" + get(path, options) end - # Retrieve the parameters by companyCode and itemCode. # # Returns the list of parameters based on the company country and state jurisdiction and the item code. # # ### Security Policies @@ -685,59 +574,47 @@ # @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:* serviceTypes, regularExpression, values # @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_parameters_by_item(companyCode, itemCode, options={}) - path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}" - get(path, options) - end + def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}" + get(path, options) end - # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. # # Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. # This list of parameters is available for use when configuring your transaction. # Some parameters are only available for use if you have subscribed to certain features of AvaTax. # @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:* values # @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_parameters_usage(options={}) - path = "/api/v2/definitions/parametersusage" - get(path, options) - end + def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage" + get(path, options) end - # Retrieve the full list of Avalara-supported permissions # # Returns the full list of Avalara-supported permission types. # This API is intended to be useful to identify the capabilities of a particular user logon. # @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. # @return [FetchResult] - def list_permissions(options={}) - path = "/api/v2/definitions/permissions" - get(path, options) - end + def list_permissions(options={}) path = "/api/v2/definitions/permissions" + get(path, options) end - # Retrieve the full list of Avalara-supported postal codes. # # Retrieves the list of Avalara-supported postal codes. # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). # @param 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_postal_codes(options={}) - path = "/api/v2/definitions/postalcodes" - get(path, options) - end + def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes" + get(path, options) end - # List all customs duty programs recognized by AvaTax # # List all preferred customs duty programs recognized by AvaTax. # # A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. @@ -750,16 +627,13 @@ # @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:* effectiveDate, endDate # @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_preferred_programs(options={}) - path = "/api/v2/definitions/preferredprograms" - get(path, options) - end + def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms" + get(path, options) end - # List all available product classification systems. # # List all available product classification systems. # # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. @@ -768,16 +642,13 @@ # @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 countryCode [String] If not null, return all records with this code. # @return [FetchResult] - def list_product_classification_systems(options={}) - path = "/api/v2/definitions/productclassificationsystems" - get(path, options) - end + def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems" + get(path, options) end - # List all product classification systems available to a company based on its nexus. # # Lists all product classification systems available to a company based on its nexus. # # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. @@ -787,48 +658,39 @@ # @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 countryCode [String] If not null, return all records with this code. # @return [FetchResult] - def list_product_classification_systems_by_company(companyCode, options={}) - path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}" - get(path, options) - end + def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}" + get(path, options) end - # Retrieve the full list of rate types for each country # # Returns the full list of Avalara-supported rate type file types # This API is intended to be useful to identify all the different rate types. # @param country [String] The country to examine for rate types # @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. 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_rate_types_by_country(country, options={}) - path = "/api/v2/definitions/countries/#{country}/ratetypes" - get(path, options) - end + def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes" + get(path, options) end - # List all ISO 3166 regions # # Returns a list of all ISO 3166 region codes and their US English friendly names. # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region # within the country for a shipping addresses. # @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:* localizedNames # @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_regions(options={}) - path = "/api/v2/definitions/regions" - get(path, options) - end + def list_regions(options={}) path = "/api/v2/definitions/regions" + get(path, options) end - # List all ISO 3166 regions for a country # # Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region # within the country for a shipping addresses. @@ -836,47 +698,38 @@ # @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:* localizedNames # @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_regions_by_country(country, options={}) - path = "/api/v2/definitions/countries/#{country}/regions" - get(path, options) - end + def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions" + get(path, options) end - # Retrieve the full list of Avalara-supported resource file types # # Returns the full list of Avalara-supported resource file types # This API is intended to be useful to identify all the different resource file types. # @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. 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_resource_file_types(options={}) - path = "/api/v2/definitions/resourcefiletypes" - get(path, options) - end + def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes" + get(path, options) end - # Retrieve the full list of Avalara-supported permissions # # Returns the full list of Avalara-supported permission types. # This API is intended to be useful when designing a user interface for selecting the security role of a user account. # Some security roles are restricted for Avalara internal use. # @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. 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_security_roles(options={}) - path = "/api/v2/definitions/securityroles" - get(path, options) - end + def list_security_roles(options={}) path = "/api/v2/definitions/securityroles" + get(path, options) end - # Retrieve the full list of Avalara-supported subscription types # # Returns the full list of Avalara-supported subscription types. # This API is intended to be useful for identifying which features you have added to your account. # You may always contact Avalara's sales department for information on available products or services. @@ -884,31 +737,25 @@ # @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. 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_subscription_types(options={}) - path = "/api/v2/definitions/subscriptiontypes" - get(path, options) - end + def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes" + get(path, options) end - # Retrieve the full list of Avalara-supported tax authorities. # # Returns the full list of Avalara-supported tax authorities. # This API is intended to be useful to identify all the different authorities that receive tax. # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_authorities(options={}) - path = "/api/v2/definitions/taxauthorities" - get(path, options) - end + def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities" + get(path, options) end - # Retrieve the full list of Avalara-supported forms for each tax authority. # # Returns the full list of Avalara-supported forms for each tax authority. # This list represents tax forms that Avalara recognizes. # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically @@ -916,31 +763,25 @@ # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_authority_forms(options={}) - path = "/api/v2/definitions/taxauthorityforms" - get(path, options) - end + def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms" + get(path, options) end - # Retrieve the full list of Avalara-supported tax authority types. # # Returns the full list of Avalara-supported tax authority types. # This API is intended to be useful to identify all the different authority types. # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_authority_types(options={}) - path = "/api/v2/definitions/taxauthoritytypes" - get(path, options) - end + def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes" + get(path, options) end - # Retrieve the full list of Avalara-supported tax codes. # # Retrieves the list of Avalara-supported system tax codes. # A 'TaxCode' represents a uniquely identified type of product, good, or service. # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -953,88 +794,70 @@ # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_codes(options={}) - path = "/api/v2/definitions/taxcodes" - get(path, options) - end + def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes" + get(path, options) end - # Retrieve the full list of Avalara-supported tax code types. # # Returns the full list of recognized tax code types. # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode. # This API is intended to be useful for broadly searching for tax codes by tax code type. # @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. # @return [Object] - def list_tax_code_types(options={}) - path = "/api/v2/definitions/taxcodetypes" - get(path, options) - end + def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes" + get(path, options) end - # Retrieve the full list of the Tax Forms available # # Returns the full list of Avalara-supported Tax Forms # This API is intended to be useful to identify all the different Tax Forms # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_forms(options={}) - path = "/api/v2/definitions/taxforms" - get(path, options) - end + def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms" + get(path, options) end - # Retrieve the full list of tax sub types # # Returns the full list of Avalara-supported tax sub-types # This API is intended to be useful to identify all the different tax sub-types. # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_sub_types(options={}) - path = "/api/v2/definitions/taxsubtypes" - get(path, options) - end + def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes" + get(path, options) end - # Retrieve the full list of tax type groups # # Returns the full list of Avalara-supported tax type groups # This API is intended to be useful to identify all the different tax type groups. # @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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. # @return [FetchResult] - def list_tax_type_groups(options={}) - path = "/api/v2/definitions/taxtypegroups" - get(path, options) - end + def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups" + get(path, options) end - # List all defined units of measurement # # List all units of measurement systems defined by Avalara. # # A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others. # @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:* id # @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_unit_of_measurement(options={}) - path = "/api/v2/definitions/unitofmeasurements" - get(path, options) - end - + def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements" + get(path, options) end end end end \ No newline at end of file