Skip to content

Commit 99fcee1

Browse files
authored
Merge pull request #102 from avadev/21.6.0
21.6.0
2 parents a3e7977 + d8f0108 commit 99fcee1

File tree

8 files changed

+208
-404
lines changed

8 files changed

+208
-404
lines changed

lib/avatax/client/definitions.rb

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,19 @@ def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitio
106106
def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
107107
get(path, options) end
108108

109+
# Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
110+
#
111+
# Returns the full list of Avalara-supported usage of extra parameters for item classification.
112+
# The list of parameters is available for use with Item Classification.
113+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
114+
# @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
115+
# @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.
116+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
117+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
118+
# @return [FetchResult]
119+
def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
120+
get(path, options) end
121+
109122
# Retrieve the full list of communications service types
110123
#
111124
# Returns full list of service types for a given transaction type ID.
@@ -564,7 +577,16 @@ def list_parameters(options={}) path = "/api/v2/definitions/parameters"
564577

565578
# Retrieve the parameters by companyCode and itemCode.
566579
#
567-
# Returns the list of parameters based on the company country and state jurisdiction and the item code.
580+
# Returns the list of parameters based on the company's service types and the item code.
581+
# Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
582+
# Ignores nexus for the AvaAlcohol service type.
583+
#
584+
# NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
585+
# * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
586+
# * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
587+
# * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
588+
# * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
589+
# * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
568590
#
569591
# ### Security Policies
570592
#
@@ -653,6 +675,14 @@ def list_product_classification_systems(options={}) path = "/api/v2/defin
653675
#
654676
# Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
655677
# More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
678+
#
679+
#
680+
# NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
681+
# * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
682+
# * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
683+
# * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
684+
# * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
685+
# * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
656686
# @param companyCode [String] The company code.
657687
# @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:* countries
658688
# @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.
@@ -715,6 +745,19 @@ def list_regions_by_country(country, options={}) path = "/api/v2/definiti
715745
def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
716746
get(path, options) end
717747

748+
# Retrieve the full list of Avalara-supported usage of parameters used for returns.
749+
#
750+
# Returns the full list of Avalara-supported usage of extra parameters for the returns.
751+
# This list of parameters is available for use with Returns.
752+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
753+
# @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
754+
# @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.
755+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
756+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
757+
# @return [FetchResult]
758+
def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
759+
get(path, options) end
760+
718761
# Retrieve the full list of Avalara-supported permissions
719762
#
720763
# Returns the full list of Avalara-supported permission types.
@@ -742,6 +785,17 @@ def list_security_roles(options={}) path = "/api/v2/definitions/securityr
742785
def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
743786
get(path, options) end
744787

788+
# Retrieve the list all tags supported by avalara
789+
#
790+
# Retrieves the list of suggested locations for a marketplace.
791+
# @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/).
792+
# @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.
793+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
794+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
795+
# @return [FetchResult]
796+
def list_tags(options={}) path = "/api/v2/definitions/tags"
797+
get(path, options) end
798+
745799
# Retrieve the full list of Avalara-supported tax authorities.
746800
#
747801
# Returns the full list of Avalara-supported tax authorities.

0 commit comments

Comments
 (0)