avatax 21.8.0 → 22.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +55 -55
- data/.rspec +1 -1
- data/.travis.yml +18 -18
- data/.vs/VSWorkspaceState.json +5 -5
- data/.yardopts +4 -4
- data/Gemfile +2 -2
- data/LICENSE +201 -201
- data/README.md +98 -98
- data/Rakefile +9 -9
- data/avatax.gemspec +38 -38
- data/example/avatax.rb +47 -47
- data/example/credentials.example.yaml +5 -5
- data/lib/avatax/api.rb +27 -27
- data/lib/avatax/client/accounts.rb +94 -83
- data/lib/avatax/client/addresses.rb +22 -20
- data/lib/avatax/client/advancedrules.rb +46 -41
- data/lib/avatax/client/ageverification.rb +29 -0
- data/lib/avatax/client/avafileforms.rb +46 -41
- data/lib/avatax/client/batches.rb +70 -62
- data/lib/avatax/client/certexpressinvites.rb +30 -27
- data/lib/avatax/client/certificates.rb +126 -111
- data/lib/avatax/client/companies.rb +192 -152
- data/lib/avatax/client/compliance.rb +25 -14
- data/lib/avatax/client/contacts.rb +54 -48
- data/lib/avatax/client/customers.rb +110 -97
- data/lib/avatax/client/datasources.rb +54 -48
- data/lib/avatax/client/definitions.rb +620 -446
- data/lib/avatax/client/distancethresholds.rb +54 -48
- data/lib/avatax/client/ecms.rb +73 -73
- data/lib/avatax/client/ecommercetoken.rb +20 -18
- data/lib/avatax/client/errortransactions.rb +61 -61
- data/lib/avatax/client/filingcalendars.rb +44 -20
- data/lib/avatax/client/filings.rb +24 -20
- data/lib/avatax/client/firmclientlinkages.rb +78 -69
- data/lib/avatax/client/free.rb +14 -13
- data/lib/avatax/client/fundingrequests.rb +22 -20
- data/lib/avatax/client/items.rb +206 -181
- data/lib/avatax/client/jurisdictionoverrides.rb +54 -48
- data/lib/avatax/client/locations.rb +102 -90
- data/lib/avatax/client/multidocument.rb +86 -76
- data/lib/avatax/client/nexus.rb +146 -103
- data/lib/avatax/client/notices.rb +30 -26
- data/lib/avatax/client/notifications.rb +30 -27
- data/lib/avatax/client/onboarding.rb +55 -55
- data/lib/avatax/client/pointofsale.rb +21 -21
- data/lib/avatax/client/provisioning.rb +22 -20
- data/lib/avatax/client/registrar.rb +94 -83
- data/lib/avatax/client/reports.rb +38 -34
- data/lib/avatax/client/settings.rb +54 -48
- data/lib/avatax/client/shippingverification.rb +66 -0
- data/lib/avatax/client/subscriptions.rb +30 -27
- data/lib/avatax/client/taxcodes.rb +54 -48
- data/lib/avatax/client/taxcontent.rb +46 -41
- data/lib/avatax/client/taxprofiles.rb +42 -42
- data/lib/avatax/client/taxrules.rb +56 -50
- data/lib/avatax/client/transactions.rb +174 -153
- data/lib/avatax/client/upcs.rb +54 -48
- data/lib/avatax/client/userdefinedfields.rb +52 -0
- data/lib/avatax/client/users.rb +70 -62
- data/lib/avatax/client/utilities.rb +30 -27
- data/lib/avatax/client.rb +37 -35
- data/lib/avatax/configuration.rb +76 -76
- data/lib/avatax/connection.rb +49 -49
- data/lib/avatax/request.rb +51 -42
- data/lib/avatax/version.rb +3 -3
- data/lib/avatax.rb +26 -26
- data/spec/avatax/client/accounts_spec.rb +13 -13
- data/spec/avatax/client/transactions_spec.rb +80 -80
- data/spec/avatax/request_spec.rb +25 -25
- data/spec/avatax_spec.rb +45 -45
- data/spec/credentials.yaml.example +4 -4
- data/spec/fixtures/accounts.json +15 -15
- data/spec/spec_helper.rb +27 -27
- metadata +9 -13
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Definitions
|
4
|
-
|
5
|
-
|
6
|
-
# Lists all parents of an HS Code.
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Definitions
|
4
|
+
|
5
|
+
|
6
|
+
# Lists all parents of an HS Code.
|
7
|
+
#
|
8
8
|
# Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings
|
9
9
|
#
|
10
10
|
# a list of HS Codes that are the parents and information branches of the HS Code for the given
|
@@ -18,169 +18,181 @@ module AvaTax
|
|
18
18
|
#
|
19
19
|
# ### Security Policies
|
20
20
|
#
|
21
|
-
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
21
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
22
|
+
# Swagger Name: AvaTaxClient
|
22
23
|
# @param country [String] The name or code of the destination country.
|
23
24
|
# @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
|
24
|
-
# @return [FetchResult]
|
25
|
-
def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
|
26
|
-
get(path) end
|
27
|
-
|
28
|
-
# Test whether a form supports online login verification
|
29
|
-
#
|
25
|
+
# @return [FetchResult]
|
26
|
+
def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
|
27
|
+
get(path, {}, "22.2.0") end
|
28
|
+
|
29
|
+
# Test whether a form supports online login verification
|
30
|
+
#
|
30
31
|
# This API is intended to be useful to identify whether the user should be allowed
|
31
|
-
# to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
|
32
|
+
# to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
|
33
|
+
# Swagger Name: AvaTaxClient
|
32
34
|
# @param form [String] The name of the form you would like to verify. This is the tax form code
|
33
35
|
# @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
|
34
36
|
# @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.
|
35
37
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
36
38
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
37
|
-
# @return [FetchResult]
|
38
|
-
def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
|
39
|
-
get(path, options) end
|
40
|
-
|
41
|
-
# List all market place locations.
|
42
|
-
#
|
43
|
-
# List all market place locations.
|
39
|
+
# @return [FetchResult]
|
40
|
+
def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
|
41
|
+
get(path, options, "22.2.0") end
|
42
|
+
|
43
|
+
# List all market place locations.
|
44
|
+
#
|
45
|
+
# List all market place locations.
|
46
|
+
# Swagger Name: AvaTaxClient
|
44
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/).
|
45
48
|
# @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.
|
46
49
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
47
50
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
48
|
-
# @return [FetchResult]
|
49
|
-
def list_all_marketplace_locations(options={}) path = "/api/v2/definitions/listallmarketplacelocations"
|
50
|
-
get(path, options) end
|
51
|
-
|
52
|
-
# Retrieve the full list of the AvaFile Forms available
|
53
|
-
#
|
51
|
+
# @return [FetchResult]
|
52
|
+
def list_all_marketplace_locations(options={}) path = "/api/v2/definitions/listallmarketplacelocations"
|
53
|
+
get(path, options, "22.2.0") end
|
54
|
+
|
55
|
+
# Retrieve the full list of the AvaFile Forms available
|
56
|
+
#
|
54
57
|
# This API is deprecated.
|
55
58
|
#
|
56
59
|
# Please use the ListTaxForms API.
|
57
60
|
#
|
58
61
|
# Returns the full list of Avalara-supported AvaFile Forms
|
59
|
-
# This API is intended to be useful to identify all the different AvaFile Forms
|
62
|
+
# This API is intended to be useful to identify all the different AvaFile Forms
|
63
|
+
# Swagger Name: AvaTaxClient
|
60
64
|
# @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
|
61
65
|
# @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.
|
62
66
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
63
67
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
64
|
-
# @return [FetchResult]
|
65
|
-
def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
|
66
|
-
get(path, options) end
|
67
|
-
|
68
|
-
# List certificate attributes used by a company
|
69
|
-
#
|
68
|
+
# @return [FetchResult]
|
69
|
+
def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
|
70
|
+
get(path, options, "22.2.0") end
|
71
|
+
|
72
|
+
# List certificate attributes used by a company
|
73
|
+
#
|
70
74
|
# List the certificate attributes defined by a company either specified by the user or the user's default company.
|
71
75
|
#
|
72
76
|
# A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
|
73
77
|
# certificate at any time.
|
74
78
|
#
|
75
79
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
76
|
-
# check and provision account.
|
80
|
+
# check and provision account.
|
81
|
+
# Swagger Name: AvaTaxClient
|
77
82
|
# @param companyid [Integer] Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company.
|
78
83
|
# @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/).
|
79
84
|
# @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.
|
80
85
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
81
86
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
82
|
-
# @return [FetchResult]
|
83
|
-
def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
|
84
|
-
get(path, options) end
|
85
|
-
|
86
|
-
# List the certificate exempt reasons defined by a company
|
87
|
-
#
|
87
|
+
# @return [FetchResult]
|
88
|
+
def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
|
89
|
+
get(path, options, "22.2.0") end
|
90
|
+
|
91
|
+
# List the certificate exempt reasons defined by a company
|
92
|
+
#
|
88
93
|
# List the certificate exempt reasons defined by a company.
|
89
94
|
#
|
90
95
|
# An exemption reason defines why a certificate allows a customer to be exempt
|
91
96
|
# for purposes of tax calculation.
|
92
97
|
#
|
93
98
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
94
|
-
# check and provision account.
|
99
|
+
# check and provision account.
|
100
|
+
# Swagger Name: AvaTaxClient
|
95
101
|
# @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/).
|
96
102
|
# @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.
|
97
103
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
98
104
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
99
|
-
# @return [FetchResult]
|
100
|
-
def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
|
101
|
-
get(path, options) end
|
102
|
-
|
103
|
-
# List certificate exposure zones used by a company
|
104
|
-
#
|
105
|
+
# @return [FetchResult]
|
106
|
+
def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
|
107
|
+
get(path, options, "22.2.0") end
|
108
|
+
|
109
|
+
# List certificate exposure zones used by a company
|
110
|
+
#
|
105
111
|
# List the certificate exposure zones defined by a company.
|
106
112
|
#
|
107
113
|
# An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
|
108
114
|
# authority or other legal entity to which a certificate may apply.
|
109
115
|
#
|
110
116
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
111
|
-
# check and provision account.
|
117
|
+
# check and provision account.
|
118
|
+
# Swagger Name: AvaTaxClient
|
112
119
|
# @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
|
113
120
|
# @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.
|
114
121
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
115
122
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
116
|
-
# @return [FetchResult]
|
117
|
-
def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
|
118
|
-
get(path, options) end
|
119
|
-
|
120
|
-
# Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
|
121
|
-
#
|
123
|
+
# @return [FetchResult]
|
124
|
+
def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
|
125
|
+
get(path, options, "22.2.0") end
|
126
|
+
|
127
|
+
# Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
|
128
|
+
#
|
122
129
|
# Returns the full list of Avalara-supported usage of extra parameters for item classification.
|
123
130
|
# The list of parameters is available for use with Item Classification.
|
124
|
-
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
131
|
+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
132
|
+
# Swagger Name: AvaTaxClient
|
125
133
|
# @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
|
126
134
|
# @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.
|
127
135
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
128
136
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
129
|
-
# @return [FetchResult]
|
130
|
-
def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
|
131
|
-
get(path, options) end
|
132
|
-
|
133
|
-
# Retrieve the full list of communications service types
|
134
|
-
#
|
135
|
-
# Returns full list of service types for a given transaction type ID.
|
137
|
+
# @return [FetchResult]
|
138
|
+
def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
|
139
|
+
get(path, options, "22.2.0") end
|
140
|
+
|
141
|
+
# Retrieve the full list of communications service types
|
142
|
+
#
|
143
|
+
# Returns full list of service types for a given transaction type ID.
|
144
|
+
# Swagger Name: AvaTaxClient
|
136
145
|
# @param id [Integer] The transaction type ID to examine
|
137
146
|
# @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
|
138
147
|
# @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.
|
139
148
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
140
149
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
141
|
-
# @return [FetchResult]
|
142
|
-
def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
|
143
|
-
get(path, options) end
|
144
|
-
|
145
|
-
# Retrieve the full list of communications transactiontypes
|
146
|
-
#
|
150
|
+
# @return [FetchResult]
|
151
|
+
def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
|
152
|
+
get(path, options, "22.2.0") end
|
153
|
+
|
154
|
+
# Retrieve the full list of communications transactiontypes
|
155
|
+
#
|
147
156
|
# Returns full list of communications transaction types which
|
148
|
-
# are accepted in communication tax calculation requests.
|
157
|
+
# are accepted in communication tax calculation requests.
|
158
|
+
# Swagger Name: AvaTaxClient
|
149
159
|
# @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/).
|
150
160
|
# @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.
|
151
161
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
152
162
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
153
|
-
# @return [FetchResult]
|
154
|
-
def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
|
155
|
-
get(path, options) end
|
156
|
-
|
157
|
-
# Retrieve the full list of communications transaction/service type pairs
|
158
|
-
#
|
163
|
+
# @return [FetchResult]
|
164
|
+
def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
|
165
|
+
get(path, options, "22.2.0") end
|
166
|
+
|
167
|
+
# Retrieve the full list of communications transaction/service type pairs
|
168
|
+
#
|
159
169
|
# Returns full list of communications transaction/service type pairs which
|
160
|
-
# are accepted in communication tax calculation requests.
|
170
|
+
# are accepted in communication tax calculation requests.
|
171
|
+
# Swagger Name: AvaTaxClient
|
161
172
|
# @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
|
162
173
|
# @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.
|
163
174
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
164
175
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
165
|
-
# @return [FetchResult]
|
166
|
-
def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
|
167
|
-
get(path, options) end
|
168
|
-
|
169
|
-
# List all ISO 3166 countries
|
170
|
-
#
|
176
|
+
# @return [FetchResult]
|
177
|
+
def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
|
178
|
+
get(path, options, "22.2.0") end
|
179
|
+
|
180
|
+
# List all ISO 3166 countries
|
181
|
+
#
|
171
182
|
# Returns a list of all ISO 3166 country codes, and their US English friendly names.
|
172
183
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
|
173
|
-
# a shipping address.
|
184
|
+
# a shipping address.
|
185
|
+
# Swagger Name: AvaTaxClient
|
174
186
|
# @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
|
175
187
|
# @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.
|
176
188
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
177
189
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
178
|
-
# @return [FetchResult]
|
179
|
-
def list_countries(options={}) path = "/api/v2/definitions/countries"
|
180
|
-
get(path, options) end
|
181
|
-
|
182
|
-
# List certificate exposure zones used by a company
|
183
|
-
#
|
190
|
+
# @return [FetchResult]
|
191
|
+
def list_countries(options={}) path = "/api/v2/definitions/countries"
|
192
|
+
get(path, options, "22.2.0") end
|
193
|
+
|
194
|
+
# List certificate exposure zones used by a company
|
195
|
+
#
|
184
196
|
# List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
|
185
197
|
#
|
186
198
|
# The CoverLetter model represents a message sent along with an invitation to use CertExpress to
|
@@ -188,17 +200,18 @@ module AvaTax
|
|
188
200
|
# certificates directly; this cover letter explains why the invitation was sent.
|
189
201
|
#
|
190
202
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
191
|
-
# check and provision account.
|
203
|
+
# check and provision account.
|
204
|
+
# Swagger Name: AvaTaxClient
|
192
205
|
# @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
|
193
206
|
# @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.
|
194
207
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
195
208
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
196
|
-
# @return [FetchResult]
|
197
|
-
def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
|
198
|
-
get(path, options) end
|
199
|
-
|
200
|
-
# Lists the next level of HS Codes given a destination country and HS Code prefix.
|
201
|
-
#
|
209
|
+
# @return [FetchResult]
|
210
|
+
def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
|
211
|
+
get(path, options, "22.2.0") end
|
212
|
+
|
213
|
+
# Lists the next level of HS Codes given a destination country and HS Code prefix.
|
214
|
+
#
|
202
215
|
# Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if
|
203
216
|
# additional children are available.
|
204
217
|
#
|
@@ -210,19 +223,20 @@ module AvaTax
|
|
210
223
|
#
|
211
224
|
# ### Security Policies
|
212
225
|
#
|
213
|
-
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
226
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
227
|
+
# Swagger Name: AvaTaxClient
|
214
228
|
# @param country [String] The name or code of the destination country.
|
215
229
|
# @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
|
216
230
|
# @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
|
217
231
|
# @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.
|
218
232
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
219
233
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
220
|
-
# @return [FetchResult]
|
221
|
-
def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
|
222
|
-
get(path, options) end
|
223
|
-
|
224
|
-
# List top level HS Code Sections.
|
225
|
-
#
|
234
|
+
# @return [FetchResult]
|
235
|
+
def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
|
236
|
+
get(path, options, "22.2.0") end
|
237
|
+
|
238
|
+
# List top level HS Code Sections.
|
239
|
+
#
|
226
240
|
# Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for
|
227
241
|
# classifying tariff codes and the items to which they apply. HS Codes are organized
|
228
242
|
# by Section/Chapter/Heading/Subheading/Classification.
|
@@ -232,77 +246,83 @@ module AvaTax
|
|
232
246
|
#
|
233
247
|
# ### Security Policies
|
234
248
|
#
|
235
|
-
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
236
|
-
#
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
#
|
249
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
250
|
+
# Swagger Name: AvaTaxClient
|
251
|
+
# @return [FetchResult]
|
252
|
+
def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
|
253
|
+
get(path, {}, "22.2.0") end
|
254
|
+
|
255
|
+
# List all ISO 4217 currencies supported by AvaTax.
|
256
|
+
#
|
242
257
|
# Lists all ISO 4217 currencies supported by AvaTax.
|
243
258
|
#
|
244
259
|
# 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
|
245
|
-
# `currencyCode` field in a `CreateTransactionModel`.
|
260
|
+
# `currencyCode` field in a `CreateTransactionModel`.
|
261
|
+
# Swagger Name: AvaTaxClient
|
246
262
|
# @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/).
|
247
263
|
# @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.
|
248
264
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
249
265
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
250
|
-
# @return [FetchResult]
|
251
|
-
def list_currencies(options={}) path = "/api/v2/definitions/currencies"
|
252
|
-
get(path, options) end
|
253
|
-
|
254
|
-
# Retrieve the full list of Avalara-supported entity use codes
|
255
|
-
#
|
266
|
+
# @return [FetchResult]
|
267
|
+
def list_currencies(options={}) path = "/api/v2/definitions/currencies"
|
268
|
+
get(path, options, "22.2.0") end
|
269
|
+
|
270
|
+
# Retrieve the full list of Avalara-supported entity use codes
|
271
|
+
#
|
256
272
|
# Returns the full list of Avalara-supported entity use codes.
|
257
273
|
# Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction
|
258
274
|
# is occurring. This information is generally used to determine taxability of the product.
|
259
275
|
# In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
|
260
|
-
# all transactions that are exempt.
|
276
|
+
# all transactions that are exempt.
|
277
|
+
# Swagger Name: AvaTaxClient
|
261
278
|
# @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
|
262
279
|
# @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.
|
263
280
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
264
281
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
265
|
-
# @return [FetchResult]
|
266
|
-
def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
|
267
|
-
get(path, options) end
|
268
|
-
|
269
|
-
# Retrieve the full list of Avalara-supported filing frequencies.
|
270
|
-
#
|
282
|
+
# @return [FetchResult]
|
283
|
+
def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
|
284
|
+
get(path, options, "22.2.0") end
|
285
|
+
|
286
|
+
# Retrieve the full list of Avalara-supported filing frequencies.
|
287
|
+
#
|
271
288
|
# Returns the full list of Avalara-supported filing frequencies.
|
272
|
-
# This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
|
289
|
+
# This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
|
290
|
+
# Swagger Name: AvaTaxClient
|
273
291
|
# @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/).
|
274
292
|
# @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.
|
275
293
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
276
294
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
277
|
-
# @return [FetchResult]
|
278
|
-
def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
|
279
|
-
get(path, options) end
|
280
|
-
|
281
|
-
# List jurisdictions based on the filter provided
|
282
|
-
#
|
295
|
+
# @return [FetchResult]
|
296
|
+
def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
|
297
|
+
get(path, options, "22.2.0") end
|
298
|
+
|
299
|
+
# List jurisdictions based on the filter provided
|
300
|
+
#
|
283
301
|
# Returns a list of all Avalara-supported taxing jurisdictions.
|
284
302
|
#
|
285
303
|
# This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
|
286
304
|
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
|
287
305
|
#
|
288
|
-
# The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
|
306
|
+
# The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
|
307
|
+
# Swagger Name: AvaTaxClient
|
289
308
|
# @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
|
290
309
|
# @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.
|
291
310
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
292
311
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
293
|
-
# @return [FetchResult]
|
294
|
-
def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
|
295
|
-
get(path, options) end
|
296
|
-
|
297
|
-
# List jurisdictions near a specific address
|
298
|
-
#
|
312
|
+
# @return [FetchResult]
|
313
|
+
def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
|
314
|
+
get(path, options, "22.2.0") end
|
315
|
+
|
316
|
+
# List jurisdictions near a specific address
|
317
|
+
#
|
299
318
|
# Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
|
300
319
|
#
|
301
320
|
# This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.
|
302
321
|
# It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
|
303
322
|
# jurisdiction in AvaTax.
|
304
323
|
#
|
305
|
-
# The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
|
324
|
+
# The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
|
325
|
+
# Swagger Name: AvaTaxClient
|
306
326
|
# @param line1 [String] The first address line portion of this address.
|
307
327
|
# @param line2 [String] The second address line portion of this address.
|
308
328
|
# @param line3 [String] The third address line portion of this address.
|
@@ -314,18 +334,41 @@ module AvaTax
|
|
314
334
|
# @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.
|
315
335
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
316
336
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
317
|
-
# @return [FetchResult]
|
318
|
-
def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
|
319
|
-
get(path, options) end
|
320
|
-
|
321
|
-
#
|
337
|
+
# @return [FetchResult]
|
338
|
+
def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
|
339
|
+
get(path, options, "22.2.0") end
|
340
|
+
|
341
|
+
# List jurisdictions based on the TaxType, TaxSubType and RateType provided
|
342
|
+
#
|
343
|
+
# Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType.
|
344
|
+
#
|
345
|
+
# This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
|
346
|
+
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
|
322
347
|
#
|
348
|
+
# The jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API.
|
349
|
+
# Swagger Name: AvaTaxClient
|
350
|
+
# @param country [String] The country for which you want to retrieve the jurisdiction information
|
351
|
+
# @param region [String] The region for which you want to retrieve the jurisdiction information
|
352
|
+
# @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
|
353
|
+
# @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
|
354
|
+
# @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
|
355
|
+
# @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, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId
|
356
|
+
# @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.
|
357
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
358
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
359
|
+
# @return [FetchResult]
|
360
|
+
def list_jurisdictions_by_rate_type_tax_type_mapping(country, region, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/regions/#{region}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
|
361
|
+
get(path, options, "22.2.0") end
|
362
|
+
|
363
|
+
# Retrieve the list of questions that are required for a tax location
|
364
|
+
#
|
323
365
|
# Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
|
324
366
|
# Some tax jurisdictions require that you register or provide additional information to configure each physical place where
|
325
367
|
# your company does business.
|
326
368
|
# This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.
|
327
369
|
# You can call this API call for any address and obtain information about what questions must be answered in order to properly
|
328
|
-
# file tax in that location.
|
370
|
+
# file tax in that location.
|
371
|
+
# Swagger Name: AvaTaxClient
|
329
372
|
# @param line1 [String] The first line of this location's address.
|
330
373
|
# @param line2 [String] The second line of this location's address.
|
331
374
|
# @param line3 [String] The third line of this location's address.
|
@@ -339,54 +382,58 @@ module AvaTax
|
|
339
382
|
# @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.
|
340
383
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
341
384
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
342
|
-
# @return [FetchResult]
|
343
|
-
def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
|
344
|
-
get(path, options) end
|
345
|
-
|
346
|
-
# List all forms where logins can be verified automatically
|
347
|
-
#
|
385
|
+
# @return [FetchResult]
|
386
|
+
def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
|
387
|
+
get(path, options, "22.2.0") end
|
388
|
+
|
389
|
+
# List all forms where logins can be verified automatically
|
390
|
+
#
|
348
391
|
# List all forms where logins can be verified automatically.
|
349
392
|
# This API is intended to be useful to identify whether the user should be allowed
|
350
|
-
# to automatically verify their login and password.
|
393
|
+
# to automatically verify their login and password.
|
394
|
+
# Swagger Name: AvaTaxClient
|
351
395
|
# @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
|
352
396
|
# @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.
|
353
397
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
354
398
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
355
|
-
# @return [FetchResult]
|
356
|
-
def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
|
357
|
-
get(path, options) end
|
358
|
-
|
359
|
-
# Retrieve the list of locations for a marketplace.
|
360
|
-
#
|
361
|
-
# Retrieves the list of suggested locations for a marketplace.
|
399
|
+
# @return [FetchResult]
|
400
|
+
def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
|
401
|
+
get(path, options, "22.2.0") end
|
402
|
+
|
403
|
+
# Retrieve the list of locations for a marketplace.
|
404
|
+
#
|
405
|
+
# Retrieves the list of suggested locations for a marketplace.
|
406
|
+
# Swagger Name: AvaTaxClient
|
362
407
|
# @param marketplaceId [String] MarketplaceId of a marketplace
|
363
408
|
# @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.
|
364
409
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
365
410
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
366
|
-
# @return [FetchResult]
|
367
|
-
def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
|
368
|
-
get(path, options) end
|
369
|
-
|
370
|
-
# Retrieve the full list of Avalara-supported nexus for all countries and regions.
|
371
|
-
#
|
411
|
+
# @return [FetchResult]
|
412
|
+
def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
|
413
|
+
get(path, options, "22.2.0") end
|
414
|
+
|
415
|
+
# Retrieve the full list of Avalara-supported nexus for all countries and regions.
|
416
|
+
#
|
372
417
|
# Returns the full list of all Avalara-supported nexus for all countries and regions.
|
373
418
|
#
|
374
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
419
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
420
|
+
# Swagger Name: AvaTaxClient
|
375
421
|
# @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, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
|
376
422
|
# @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.
|
377
423
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
378
424
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
379
|
-
# @return [FetchResult]
|
380
|
-
def list_nexus(options={}) path = "/api/v2/definitions/nexus"
|
381
|
-
get(path, options) end
|
382
|
-
|
383
|
-
# List all nexus that apply to a specific address.
|
384
|
-
#
|
425
|
+
# @return [FetchResult]
|
426
|
+
def list_nexus(options={}) path = "/api/v2/definitions/nexus"
|
427
|
+
get(path, options, "22.2.0") end
|
428
|
+
|
429
|
+
# List all nexus that apply to a specific address.
|
430
|
+
#
|
385
431
|
# Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
|
386
432
|
# This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.
|
387
433
|
# In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address
|
388
434
|
# where the company does business.
|
389
|
-
# The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
|
435
|
+
# The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
|
436
|
+
# Swagger Name: AvaTaxClient
|
390
437
|
# @param line1 [String] The first address line portion of this address.
|
391
438
|
# @param line2 [String] The first address line portion of this address.
|
392
439
|
# @param line3 [String] The first address line portion of this address.
|
@@ -398,41 +445,43 @@ module AvaTax
|
|
398
445
|
# @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.
|
399
446
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
400
447
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
401
|
-
# @return [FetchResult]
|
402
|
-
def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
|
403
|
-
get(path, options) end
|
404
|
-
|
405
|
-
# Retrieve the full list of Avalara-supported nexus for a country.
|
406
|
-
#
|
448
|
+
# @return [FetchResult]
|
449
|
+
def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
|
450
|
+
get(path, options, "22.2.0") end
|
451
|
+
|
452
|
+
# Retrieve the full list of Avalara-supported nexus for a country.
|
453
|
+
#
|
407
454
|
# Returns all Avalara-supported nexus for the specified country.
|
408
455
|
#
|
409
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
|
456
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
|
457
|
+
# Swagger Name: AvaTaxClient
|
410
458
|
# @param country [String] The country in which you want to fetch the system nexus
|
411
459
|
# @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, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
|
412
460
|
# @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.
|
413
461
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
414
462
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
415
|
-
# @return [FetchResult]
|
416
|
-
def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
|
417
|
-
get(path, options) end
|
418
|
-
|
419
|
-
# Retrieve the full list of Avalara-supported nexus for a country and region.
|
420
|
-
#
|
463
|
+
# @return [FetchResult]
|
464
|
+
def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
|
465
|
+
get(path, options, "22.2.0") end
|
466
|
+
|
467
|
+
# Retrieve the full list of Avalara-supported nexus for a country and region.
|
468
|
+
#
|
421
469
|
# Returns all Avalara-supported nexus for the specified country and region.
|
422
470
|
#
|
423
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
|
471
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
|
472
|
+
# Swagger Name: AvaTaxClient
|
424
473
|
# @param country [String] The two-character ISO-3166 code for the country.
|
425
474
|
# @param region [String] The two or three character region code for the region.
|
426
475
|
# @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, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
|
427
476
|
# @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.
|
428
477
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
429
478
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
430
|
-
# @return [FetchResult]
|
431
|
-
def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
|
432
|
-
get(path, options) end
|
433
|
-
|
434
|
-
# List nexus related to a tax form
|
435
|
-
#
|
479
|
+
# @return [FetchResult]
|
480
|
+
def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
|
481
|
+
get(path, options, "22.2.0") end
|
482
|
+
|
483
|
+
# List nexus related to a tax form
|
484
|
+
#
|
436
485
|
# Retrieves a list of nexus related to a tax form.
|
437
486
|
#
|
438
487
|
# The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
|
@@ -447,147 +496,174 @@ module AvaTax
|
|
447
496
|
#
|
448
497
|
# ### Security Policies
|
449
498
|
#
|
450
|
-
# * 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.
|
499
|
+
# * 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.
|
500
|
+
# Swagger Name: AvaTaxClient
|
451
501
|
# @param formCode [String] The form code that we are looking up the nexus for
|
452
|
-
# @return [Object]
|
453
|
-
def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
|
454
|
-
get(path) end
|
455
|
-
|
456
|
-
# Retrieve the full list of nexus tax type
|
457
|
-
#
|
502
|
+
# @return [Object]
|
503
|
+
def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
|
504
|
+
get(path, {}, "22.2.0") end
|
505
|
+
|
506
|
+
# Retrieve the full list of Avalara-supported nexus for a tax type group.
|
507
|
+
#
|
508
|
+
# Returns all Avalara-supported nexus for the specified specified tax type group.
|
509
|
+
#
|
510
|
+
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group.
|
511
|
+
# Swagger Name: AvaTaxClient
|
512
|
+
# @param taxTypeGroup [String] The tax type group to fetch the supporting system nexus for.
|
513
|
+
# @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, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
|
514
|
+
# @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.
|
515
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
516
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
517
|
+
# @return [FetchResult]
|
518
|
+
def list_nexus_by_tax_type_group(taxTypeGroup, options={}) path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
|
519
|
+
get(path, options, "22.2.0") end
|
520
|
+
|
521
|
+
# Retrieve the full list of nexus tax type groups
|
522
|
+
#
|
458
523
|
# Returns the full list of Avalara-supported nexus tax type groups
|
459
|
-
# This API is intended to be useful to identify all the different tax sub-types.
|
524
|
+
# This API is intended to be useful to identify all the different tax sub-types.
|
525
|
+
# Swagger Name: AvaTaxClient
|
460
526
|
# @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
|
461
527
|
# @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.
|
462
528
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
463
529
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
464
|
-
# @return [FetchResult]
|
465
|
-
def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
|
466
|
-
get(path, options) end
|
467
|
-
|
468
|
-
# Retrieve the full list of Avalara-supported tax notice customer funding options.
|
469
|
-
#
|
530
|
+
# @return [FetchResult]
|
531
|
+
def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
|
532
|
+
get(path, options, "22.2.0") end
|
533
|
+
|
534
|
+
# Retrieve the full list of Avalara-supported tax notice customer funding options.
|
535
|
+
#
|
470
536
|
# Returns the full list of Avalara-supported tax notice customer funding options.
|
471
|
-
# This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
|
537
|
+
# This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
|
538
|
+
# Swagger Name: AvaTaxClient
|
472
539
|
# @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
|
473
540
|
# @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.
|
474
541
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
475
542
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
476
|
-
# @return [FetchResult]
|
477
|
-
def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
|
478
|
-
get(path, options) end
|
479
|
-
|
480
|
-
# Retrieve the full list of Avalara-supported tax notice customer types.
|
481
|
-
#
|
543
|
+
# @return [FetchResult]
|
544
|
+
def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
|
545
|
+
get(path, options, "22.2.0") end
|
546
|
+
|
547
|
+
# Retrieve the full list of Avalara-supported tax notice customer types.
|
548
|
+
#
|
482
549
|
# Returns the full list of Avalara-supported tax notice customer types.
|
483
|
-
# This API is intended to be useful to identify all the different notice customer types.
|
550
|
+
# This API is intended to be useful to identify all the different notice customer types.
|
551
|
+
# Swagger Name: AvaTaxClient
|
484
552
|
# @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
|
485
553
|
# @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.
|
486
554
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
487
555
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
488
|
-
# @return [FetchResult]
|
489
|
-
def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
|
490
|
-
get(path, options) end
|
491
|
-
|
492
|
-
# Retrieve the full list of Avalara-supported tax notice filing types.
|
493
|
-
#
|
556
|
+
# @return [FetchResult]
|
557
|
+
def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
|
558
|
+
get(path, options, "22.2.0") end
|
559
|
+
|
560
|
+
# Retrieve the full list of Avalara-supported tax notice filing types.
|
561
|
+
#
|
494
562
|
# Returns the full list of Avalara-supported tax notice filing types.
|
495
|
-
# This API is intended to be useful to identify all the different notice filing types that can be used in notices.
|
563
|
+
# This API is intended to be useful to identify all the different notice filing types that can be used in notices.
|
564
|
+
# Swagger Name: AvaTaxClient
|
496
565
|
# @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
|
497
566
|
# @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.
|
498
567
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
499
568
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
500
|
-
# @return [FetchResult]
|
501
|
-
def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
|
502
|
-
get(path, options) end
|
503
|
-
|
504
|
-
# Retrieve the full list of Avalara-supported tax notice priorities.
|
505
|
-
#
|
569
|
+
# @return [FetchResult]
|
570
|
+
def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
|
571
|
+
get(path, options, "22.2.0") end
|
572
|
+
|
573
|
+
# Retrieve the full list of Avalara-supported tax notice priorities.
|
574
|
+
#
|
506
575
|
# Returns the full list of Avalara-supported tax notice priorities.
|
507
|
-
# This API is intended to be useful to identify all the different notice priorities that can be used in notices.
|
576
|
+
# This API is intended to be useful to identify all the different notice priorities that can be used in notices.
|
577
|
+
# Swagger Name: AvaTaxClient
|
508
578
|
# @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
|
509
579
|
# @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.
|
510
580
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
511
581
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
512
|
-
# @return [FetchResult]
|
513
|
-
def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
|
514
|
-
get(path, options) end
|
515
|
-
|
516
|
-
# Retrieve the full list of Avalara-supported tax notice reasons.
|
517
|
-
#
|
582
|
+
# @return [FetchResult]
|
583
|
+
def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
|
584
|
+
get(path, options, "22.2.0") end
|
585
|
+
|
586
|
+
# Retrieve the full list of Avalara-supported tax notice reasons.
|
587
|
+
#
|
518
588
|
# Returns the full list of Avalara-supported tax notice reasons.
|
519
|
-
# This API is intended to be useful to identify all the different tax notice reasons.
|
589
|
+
# This API is intended to be useful to identify all the different tax notice reasons.
|
590
|
+
# Swagger Name: AvaTaxClient
|
520
591
|
# @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
|
521
592
|
# @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.
|
522
593
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
523
594
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
524
|
-
# @return [FetchResult]
|
525
|
-
def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
|
526
|
-
get(path, options) end
|
527
|
-
|
528
|
-
# Retrieve the full list of Avalara-supported tax notice responsibility ids
|
529
|
-
#
|
595
|
+
# @return [FetchResult]
|
596
|
+
def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
|
597
|
+
get(path, options, "22.2.0") end
|
598
|
+
|
599
|
+
# Retrieve the full list of Avalara-supported tax notice responsibility ids
|
600
|
+
#
|
530
601
|
# Returns the full list of Avalara-supported tax notice responsibility ids
|
531
|
-
# This API is intended to be useful to identify all the different tax notice responsibilities.
|
602
|
+
# This API is intended to be useful to identify all the different tax notice responsibilities.
|
603
|
+
# Swagger Name: AvaTaxClient
|
532
604
|
# @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
|
533
605
|
# @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.
|
534
606
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
535
607
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
536
|
-
# @return [FetchResult]
|
537
|
-
def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
|
538
|
-
get(path, options) end
|
539
|
-
|
540
|
-
# Retrieve the full list of Avalara-supported tax notice root causes
|
541
|
-
#
|
608
|
+
# @return [FetchResult]
|
609
|
+
def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
|
610
|
+
get(path, options, "22.2.0") end
|
611
|
+
|
612
|
+
# Retrieve the full list of Avalara-supported tax notice root causes
|
613
|
+
#
|
542
614
|
# Returns the full list of Avalara-supported tax notice root causes
|
543
|
-
# This API is intended to be useful to identify all the different tax notice root causes.
|
615
|
+
# This API is intended to be useful to identify all the different tax notice root causes.
|
616
|
+
# Swagger Name: AvaTaxClient
|
544
617
|
# @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
|
545
618
|
# @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.
|
546
619
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
547
620
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
548
|
-
# @return [FetchResult]
|
549
|
-
def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
|
550
|
-
get(path, options) end
|
551
|
-
|
552
|
-
# Retrieve the full list of Avalara-supported tax notice statuses.
|
553
|
-
#
|
621
|
+
# @return [FetchResult]
|
622
|
+
def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
|
623
|
+
get(path, options, "22.2.0") end
|
624
|
+
|
625
|
+
# Retrieve the full list of Avalara-supported tax notice statuses.
|
626
|
+
#
|
554
627
|
# Returns the full list of Avalara-supported tax notice statuses.
|
555
|
-
# This API is intended to be useful to identify all the different tax notice statuses.
|
628
|
+
# This API is intended to be useful to identify all the different tax notice statuses.
|
629
|
+
# Swagger Name: AvaTaxClient
|
556
630
|
# @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
|
557
631
|
# @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.
|
558
632
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
559
633
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
560
|
-
# @return [FetchResult]
|
561
|
-
def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
|
562
|
-
get(path, options) end
|
563
|
-
|
564
|
-
# Retrieve the full list of Avalara-supported tax notice types.
|
565
|
-
#
|
634
|
+
# @return [FetchResult]
|
635
|
+
def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
|
636
|
+
get(path, options, "22.2.0") end
|
637
|
+
|
638
|
+
# Retrieve the full list of Avalara-supported tax notice types.
|
639
|
+
#
|
566
640
|
# Returns the full list of Avalara-supported tax notice types.
|
567
|
-
# This API is intended to be useful to identify all the different notice types that can be used in notices.
|
641
|
+
# This API is intended to be useful to identify all the different notice types that can be used in notices.
|
642
|
+
# Swagger Name: AvaTaxClient
|
568
643
|
# @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
|
569
644
|
# @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.
|
570
645
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
571
646
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
572
|
-
# @return [FetchResult]
|
573
|
-
def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
|
574
|
-
get(path, options) end
|
575
|
-
|
576
|
-
# Retrieve the full list of Avalara-supported extra parameters for creating transactions.
|
577
|
-
#
|
647
|
+
# @return [FetchResult]
|
648
|
+
def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
|
649
|
+
get(path, options, "22.2.0") end
|
650
|
+
|
651
|
+
# Retrieve the full list of Avalara-supported extra parameters for creating transactions.
|
652
|
+
#
|
578
653
|
# Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
|
579
654
|
# This list of parameters is available for use when configuring your transaction.
|
580
|
-
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
655
|
+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
656
|
+
# Swagger Name: AvaTaxClient
|
581
657
|
# @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
|
582
658
|
# @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.
|
583
659
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
584
660
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
585
|
-
# @return [FetchResult]
|
586
|
-
def list_parameters(options={}) path = "/api/v2/definitions/parameters"
|
587
|
-
get(path, options) end
|
588
|
-
|
589
|
-
# Retrieve the parameters by companyCode and itemCode.
|
590
|
-
#
|
661
|
+
# @return [FetchResult]
|
662
|
+
def list_parameters(options={}) path = "/api/v2/definitions/parameters"
|
663
|
+
get(path, options, "22.2.0") end
|
664
|
+
|
665
|
+
# Retrieve the parameters by companyCode and itemCode.
|
666
|
+
#
|
591
667
|
# Returns the list of parameters based on the company's service types and the item code.
|
592
668
|
# Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
|
593
669
|
# Ignores nexus for the AvaAlcohol service type.
|
@@ -601,53 +677,57 @@ module AvaTax
|
|
601
677
|
#
|
602
678
|
# ### Security Policies
|
603
679
|
#
|
604
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
680
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
681
|
+
# Swagger Name: AvaTaxClient
|
605
682
|
# @param companyCode [String] Company code.
|
606
683
|
# @param itemCode [String] Item code.
|
607
684
|
# @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
|
608
685
|
# @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.
|
609
686
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
610
687
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
611
|
-
# @return [FetchResult]
|
612
|
-
def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
|
613
|
-
get(path, options) end
|
614
|
-
|
615
|
-
# Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
|
616
|
-
#
|
688
|
+
# @return [FetchResult]
|
689
|
+
def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
|
690
|
+
get(path, options, "22.2.0") end
|
691
|
+
|
692
|
+
# Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
|
693
|
+
#
|
617
694
|
# Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.
|
618
695
|
# This list of parameters is available for use when configuring your transaction.
|
619
|
-
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
696
|
+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
697
|
+
# Swagger Name: AvaTaxClient
|
620
698
|
# @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
|
621
699
|
# @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.
|
622
700
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
623
701
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
624
|
-
# @return [FetchResult]
|
625
|
-
def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
|
626
|
-
get(path, options) end
|
627
|
-
|
628
|
-
# Retrieve the full list of Avalara-supported permissions
|
629
|
-
#
|
702
|
+
# @return [FetchResult]
|
703
|
+
def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
|
704
|
+
get(path, options, "22.2.0") end
|
705
|
+
|
706
|
+
# Retrieve the full list of Avalara-supported permissions
|
707
|
+
#
|
630
708
|
# Returns the full list of Avalara-supported permission types.
|
631
|
-
# This API is intended to be useful to identify the capabilities of a particular user logon.
|
709
|
+
# This API is intended to be useful to identify the capabilities of a particular user logon.
|
710
|
+
# Swagger Name: AvaTaxClient
|
632
711
|
# @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.
|
633
712
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
634
|
-
# @return [FetchResult]
|
635
|
-
def list_permissions(options={}) path = "/api/v2/definitions/permissions"
|
636
|
-
get(path, options) end
|
637
|
-
|
638
|
-
# Retrieve the full list of Avalara-supported postal codes.
|
639
|
-
#
|
640
|
-
# Retrieves the list of Avalara-supported postal codes.
|
713
|
+
# @return [FetchResult]
|
714
|
+
def list_permissions(options={}) path = "/api/v2/definitions/permissions"
|
715
|
+
get(path, options, "22.2.0") end
|
716
|
+
|
717
|
+
# Retrieve the full list of Avalara-supported postal codes.
|
718
|
+
#
|
719
|
+
# Retrieves the list of Avalara-supported postal codes.
|
720
|
+
# Swagger Name: AvaTaxClient
|
641
721
|
# @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/).
|
642
722
|
# @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.
|
643
723
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
644
724
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
645
|
-
# @return [FetchResult]
|
646
|
-
def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
|
647
|
-
get(path, options) end
|
648
|
-
|
649
|
-
# List all customs duty programs recognized by AvaTax
|
650
|
-
#
|
725
|
+
# @return [FetchResult]
|
726
|
+
def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
|
727
|
+
get(path, options, "22.2.0") end
|
728
|
+
|
729
|
+
# List all customs duty programs recognized by AvaTax
|
730
|
+
#
|
651
731
|
# List all preferred customs duty programs recognized by AvaTax.
|
652
732
|
#
|
653
733
|
# A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
|
@@ -656,32 +736,34 @@ module AvaTax
|
|
656
736
|
#
|
657
737
|
# To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
|
658
738
|
# preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
|
659
|
-
# the program.
|
739
|
+
# the program.
|
740
|
+
# Swagger Name: AvaTaxClient
|
660
741
|
# @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
|
661
742
|
# @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.
|
662
743
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
663
744
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
664
|
-
# @return [FetchResult]
|
665
|
-
def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
|
666
|
-
get(path, options) end
|
667
|
-
|
668
|
-
# List all available product classification systems.
|
669
|
-
#
|
745
|
+
# @return [FetchResult]
|
746
|
+
def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
|
747
|
+
get(path, options, "22.2.0") end
|
748
|
+
|
749
|
+
# List all available product classification systems.
|
750
|
+
#
|
670
751
|
# List all available product classification systems.
|
671
752
|
#
|
672
753
|
# Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
|
673
|
-
# More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
|
754
|
+
# More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
|
755
|
+
# Swagger Name: AvaTaxClient
|
674
756
|
# @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
|
675
757
|
# @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.
|
676
758
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
677
759
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
678
760
|
# @param countryCode [String] If not null, return all records with this code.
|
679
|
-
# @return [FetchResult]
|
680
|
-
def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
|
681
|
-
get(path, options) end
|
682
|
-
|
683
|
-
# List all product classification systems available to a company based on its nexus.
|
684
|
-
#
|
761
|
+
# @return [FetchResult]
|
762
|
+
def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
|
763
|
+
get(path, options, "22.2.0") end
|
764
|
+
|
765
|
+
# List all product classification systems available to a company based on its nexus.
|
766
|
+
#
|
685
767
|
# Lists all product classification systems available to a company based on its nexus.
|
686
768
|
#
|
687
769
|
# Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
|
@@ -693,160 +775,188 @@ module AvaTax
|
|
693
775
|
# * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
|
694
776
|
# * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
|
695
777
|
# * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
|
696
|
-
# * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
|
778
|
+
# * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
|
779
|
+
# Swagger Name: AvaTaxClient
|
697
780
|
# @param companyCode [String] The company code.
|
698
781
|
# @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
|
699
782
|
# @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.
|
700
783
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
701
784
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
702
785
|
# @param countryCode [String] If not null, return all records with this code.
|
703
|
-
# @return [FetchResult]
|
704
|
-
def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
|
705
|
-
get(path, options) end
|
706
|
-
|
707
|
-
# Retrieve the full list of rate types for each country
|
708
|
-
#
|
786
|
+
# @return [FetchResult]
|
787
|
+
def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
|
788
|
+
get(path, options, "22.2.0") end
|
789
|
+
|
790
|
+
# Retrieve the full list of rate types for each country
|
791
|
+
#
|
709
792
|
# Returns the full list of Avalara-supported rate type file types
|
710
|
-
# This API is intended to be useful to identify all the different rate types.
|
793
|
+
# This API is intended to be useful to identify all the different rate types.
|
794
|
+
# Swagger Name: AvaTaxClient
|
711
795
|
# @param country [String] The country to examine for rate types
|
712
796
|
# @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/).
|
713
797
|
# @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.
|
714
798
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
715
799
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
716
|
-
# @return [FetchResult]
|
717
|
-
def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
|
718
|
-
get(path, options) end
|
719
|
-
|
720
|
-
#
|
721
|
-
#
|
800
|
+
# @return [FetchResult]
|
801
|
+
def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
|
802
|
+
get(path, options, "22.2.0") end
|
803
|
+
|
804
|
+
# Retrieve the list of rate types by country, TaxType and by TaxSubType
|
805
|
+
#
|
806
|
+
# Returns the list of Avalara-supported rate type file types
|
807
|
+
# This API is intended to be useful to identify all the different rate types.
|
808
|
+
# Swagger Name: AvaTaxClient
|
809
|
+
# @param country [String] The country to examine for rate types
|
810
|
+
# @param taxTypeId [String] The taxType for the country to examine for rate types
|
811
|
+
# @param taxSubTypeId [String] The taxSubType for the country and taxType to examine for rate types
|
812
|
+
# @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, rateType, description
|
813
|
+
# @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.
|
814
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
815
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
816
|
+
# @return [FetchResult]
|
817
|
+
def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
|
818
|
+
get(path, options, "22.2.0") end
|
819
|
+
|
820
|
+
# List all ISO 3166 regions
|
821
|
+
#
|
722
822
|
# Returns a list of all ISO 3166 region codes and their US English friendly names.
|
723
823
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
|
724
|
-
# within the country for a shipping addresses.
|
824
|
+
# within the country for a shipping addresses.
|
825
|
+
# Swagger Name: AvaTaxClient
|
725
826
|
# @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
|
726
827
|
# @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.
|
727
828
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
728
829
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
729
|
-
# @return [FetchResult]
|
730
|
-
def list_regions(options={}) path = "/api/v2/definitions/regions"
|
731
|
-
get(path, options) end
|
732
|
-
|
733
|
-
# List all ISO 3166 regions for a country
|
734
|
-
#
|
830
|
+
# @return [FetchResult]
|
831
|
+
def list_regions(options={}) path = "/api/v2/definitions/regions"
|
832
|
+
get(path, options, "22.2.0") end
|
833
|
+
|
834
|
+
# List all ISO 3166 regions for a country
|
835
|
+
#
|
735
836
|
# Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
|
736
837
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
|
737
|
-
# within the country for a shipping addresses.
|
838
|
+
# within the country for a shipping addresses.
|
839
|
+
# Swagger Name: AvaTaxClient
|
738
840
|
# @param country [String] The country of which you want to fetch ISO 3166 regions
|
739
841
|
# @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
|
740
842
|
# @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.
|
741
843
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
742
844
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
743
|
-
# @return [FetchResult]
|
744
|
-
def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
|
745
|
-
get(path, options) end
|
746
|
-
|
747
|
-
# Retrieve the full list of Avalara-supported resource file types
|
748
|
-
#
|
845
|
+
# @return [FetchResult]
|
846
|
+
def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
|
847
|
+
get(path, options, "22.2.0") end
|
848
|
+
|
849
|
+
# Retrieve the full list of Avalara-supported resource file types
|
850
|
+
#
|
749
851
|
# Returns the full list of Avalara-supported resource file types
|
750
|
-
# This API is intended to be useful to identify all the different resource file types.
|
852
|
+
# This API is intended to be useful to identify all the different resource file types.
|
853
|
+
# Swagger Name: AvaTaxClient
|
751
854
|
# @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/).
|
752
855
|
# @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.
|
753
856
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
754
857
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
755
|
-
# @return [FetchResult]
|
756
|
-
def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
|
757
|
-
get(path, options) end
|
758
|
-
|
759
|
-
# Retrieve the full list of Avalara-supported usage of parameters used for returns.
|
760
|
-
#
|
858
|
+
# @return [FetchResult]
|
859
|
+
def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
|
860
|
+
get(path, options, "22.2.0") end
|
861
|
+
|
862
|
+
# Retrieve the full list of Avalara-supported usage of parameters used for returns.
|
863
|
+
#
|
761
864
|
# Returns the full list of Avalara-supported usage of extra parameters for the returns.
|
762
865
|
# This list of parameters is available for use with Returns.
|
763
|
-
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
866
|
+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
867
|
+
# Swagger Name: AvaTaxClient
|
764
868
|
# @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
|
765
869
|
# @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.
|
766
870
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
767
871
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
768
|
-
# @return [FetchResult]
|
769
|
-
def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
|
770
|
-
get(path, options) end
|
771
|
-
|
772
|
-
# Retrieve the full list of Avalara-supported permissions
|
773
|
-
#
|
872
|
+
# @return [FetchResult]
|
873
|
+
def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
|
874
|
+
get(path, options, "22.2.0") end
|
875
|
+
|
876
|
+
# Retrieve the full list of Avalara-supported permissions
|
877
|
+
#
|
774
878
|
# Returns the full list of Avalara-supported permission types.
|
775
879
|
# This API is intended to be useful when designing a user interface for selecting the security role of a user account.
|
776
|
-
# Some security roles are restricted for Avalara internal use.
|
880
|
+
# Some security roles are restricted for Avalara internal use.
|
881
|
+
# Swagger Name: AvaTaxClient
|
777
882
|
# @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/).
|
778
883
|
# @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.
|
779
884
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
780
885
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
781
|
-
# @return [FetchResult]
|
782
|
-
def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
|
783
|
-
get(path, options) end
|
784
|
-
|
785
|
-
# Retrieve the full list of Avalara-supported subscription types
|
786
|
-
#
|
886
|
+
# @return [FetchResult]
|
887
|
+
def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
|
888
|
+
get(path, options, "22.2.0") end
|
889
|
+
|
890
|
+
# Retrieve the full list of Avalara-supported subscription types
|
891
|
+
#
|
787
892
|
# Returns the full list of Avalara-supported subscription types.
|
788
893
|
# This API is intended to be useful for identifying which features you have added to your account.
|
789
894
|
# You may always contact Avalara's sales department for information on available products or services.
|
790
|
-
# You cannot change your subscriptions directly through the API.
|
895
|
+
# You cannot change your subscriptions directly through the API.
|
896
|
+
# Swagger Name: AvaTaxClient
|
791
897
|
# @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
898
|
# @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
899
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
794
900
|
# @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_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
|
797
|
-
get(path, options) end
|
798
|
-
|
799
|
-
# Retrieve the list all tags supported by avalara
|
800
|
-
#
|
801
|
-
# Retrieves the list of suggested locations for a marketplace.
|
901
|
+
# @return [FetchResult]
|
902
|
+
def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
|
903
|
+
get(path, options, "22.2.0") end
|
904
|
+
|
905
|
+
# Retrieve the list all tags supported by avalara
|
906
|
+
#
|
907
|
+
# Retrieves the list of suggested locations for a marketplace.
|
908
|
+
# Swagger Name: AvaTaxClient
|
802
909
|
# @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/).
|
803
910
|
# @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.
|
804
911
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
805
912
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
806
|
-
# @return [FetchResult]
|
807
|
-
def list_tags(options={}) path = "/api/v2/definitions/tags"
|
808
|
-
get(path, options) end
|
809
|
-
|
810
|
-
# Retrieve the full list of Avalara-supported tax authorities.
|
811
|
-
#
|
913
|
+
# @return [FetchResult]
|
914
|
+
def list_tags(options={}) path = "/api/v2/definitions/tags"
|
915
|
+
get(path, options, "22.2.0") end
|
916
|
+
|
917
|
+
# Retrieve the full list of Avalara-supported tax authorities.
|
918
|
+
#
|
812
919
|
# Returns the full list of Avalara-supported tax authorities.
|
813
|
-
# This API is intended to be useful to identify all the different authorities that receive tax.
|
920
|
+
# This API is intended to be useful to identify all the different authorities that receive tax.
|
921
|
+
# Swagger Name: AvaTaxClient
|
814
922
|
# @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/).
|
815
923
|
# @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.
|
816
924
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
817
925
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
818
|
-
# @return [FetchResult]
|
819
|
-
def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
|
820
|
-
get(path, options) end
|
821
|
-
|
822
|
-
# Retrieve the full list of Avalara-supported forms for each tax authority.
|
823
|
-
#
|
926
|
+
# @return [FetchResult]
|
927
|
+
def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
|
928
|
+
get(path, options, "22.2.0") end
|
929
|
+
|
930
|
+
# Retrieve the full list of Avalara-supported forms for each tax authority.
|
931
|
+
#
|
824
932
|
# Returns the full list of Avalara-supported forms for each tax authority.
|
825
933
|
# This list represents tax forms that Avalara recognizes.
|
826
934
|
# Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
|
827
|
-
# based on the customer's AvaTax data.
|
935
|
+
# based on the customer's AvaTax data.
|
936
|
+
# Swagger Name: AvaTaxClient
|
828
937
|
# @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/).
|
829
938
|
# @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.
|
830
939
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
831
940
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
832
|
-
# @return [FetchResult]
|
833
|
-
def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
|
834
|
-
get(path, options) end
|
835
|
-
|
836
|
-
# Retrieve the full list of Avalara-supported tax authority types.
|
837
|
-
#
|
941
|
+
# @return [FetchResult]
|
942
|
+
def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
|
943
|
+
get(path, options, "22.2.0") end
|
944
|
+
|
945
|
+
# Retrieve the full list of Avalara-supported tax authority types.
|
946
|
+
#
|
838
947
|
# Returns the full list of Avalara-supported tax authority types.
|
839
|
-
# This API is intended to be useful to identify all the different authority types.
|
948
|
+
# This API is intended to be useful to identify all the different authority types.
|
949
|
+
# Swagger Name: AvaTaxClient
|
840
950
|
# @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/).
|
841
951
|
# @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.
|
842
952
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
843
953
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
844
|
-
# @return [FetchResult]
|
845
|
-
def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
|
846
|
-
get(path, options) end
|
847
|
-
|
848
|
-
# Retrieve the full list of Avalara-supported tax codes.
|
849
|
-
#
|
954
|
+
# @return [FetchResult]
|
955
|
+
def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
|
956
|
+
get(path, options, "22.2.0") end
|
957
|
+
|
958
|
+
# Retrieve the full list of Avalara-supported tax codes.
|
959
|
+
#
|
850
960
|
# Retrieves the list of Avalara-supported system tax codes.
|
851
961
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
852
962
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -855,74 +965,138 @@ module AvaTax
|
|
855
965
|
#
|
856
966
|
# ### Security Policies
|
857
967
|
#
|
858
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
968
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
969
|
+
# Swagger Name: AvaTaxClient
|
859
970
|
# @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/).
|
860
971
|
# @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.
|
861
972
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
862
973
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
863
|
-
# @return [FetchResult]
|
864
|
-
def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
|
865
|
-
get(path, options) end
|
866
|
-
|
867
|
-
# Retrieve the full list of Avalara-supported tax code types.
|
868
|
-
#
|
974
|
+
# @return [FetchResult]
|
975
|
+
def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
|
976
|
+
get(path, options, "22.2.0") end
|
977
|
+
|
978
|
+
# Retrieve the full list of Avalara-supported tax code types.
|
979
|
+
#
|
869
980
|
# Returns the full list of recognized tax code types.
|
870
981
|
# A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
|
871
|
-
# This API is intended to be useful for broadly searching for tax codes by tax code type.
|
982
|
+
# This API is intended to be useful for broadly searching for tax codes by tax code type.
|
983
|
+
# Swagger Name: AvaTaxClient
|
872
984
|
# @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.
|
873
985
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
874
|
-
# @return [Object]
|
875
|
-
def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
|
876
|
-
get(path, options) end
|
877
|
-
|
878
|
-
# Retrieve the full list of the Tax Forms available
|
879
|
-
#
|
986
|
+
# @return [Object]
|
987
|
+
def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
|
988
|
+
get(path, options, "22.2.0") end
|
989
|
+
|
990
|
+
# Retrieve the full list of the Tax Forms available
|
991
|
+
#
|
880
992
|
# Returns the full list of Avalara-supported Tax Forms
|
881
|
-
# This API is intended to be useful to identify all the different Tax Forms
|
993
|
+
# This API is intended to be useful to identify all the different Tax Forms
|
994
|
+
# Swagger Name: AvaTaxClient
|
882
995
|
# @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/).
|
883
996
|
# @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.
|
884
997
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
885
998
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
886
|
-
# @return [FetchResult]
|
887
|
-
def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
|
888
|
-
get(path, options) end
|
889
|
-
|
890
|
-
# Retrieve the full list of tax sub types
|
891
|
-
#
|
999
|
+
# @return [FetchResult]
|
1000
|
+
def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
|
1001
|
+
get(path, options, "22.2.0") end
|
1002
|
+
|
1003
|
+
# Retrieve the full list of tax sub types
|
1004
|
+
#
|
892
1005
|
# Returns the full list of Avalara-supported tax sub-types
|
893
|
-
# This API is intended to be useful to identify all the different tax sub-types.
|
1006
|
+
# This API is intended to be useful to identify all the different tax sub-types.
|
1007
|
+
# Swagger Name: AvaTaxClient
|
894
1008
|
# @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/).
|
895
1009
|
# @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.
|
896
1010
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
897
1011
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
898
|
-
# @return [FetchResult]
|
899
|
-
def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
|
900
|
-
get(path, options) end
|
901
|
-
|
902
|
-
# Retrieve the full list of tax
|
903
|
-
#
|
1012
|
+
# @return [FetchResult]
|
1013
|
+
def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
|
1014
|
+
get(path, options, "22.2.0") end
|
1015
|
+
|
1016
|
+
# Retrieve the full list of tax sub types by Country and TaxType
|
1017
|
+
#
|
1018
|
+
# Returns the full list of Avalara-supported tax sub-types
|
1019
|
+
# This API is intended to be useful to identify all the different tax sub-types for given country and TaxType.
|
1020
|
+
# Swagger Name: AvaTaxClient
|
1021
|
+
# @param country [String] The country to examine for taxsubtype
|
1022
|
+
# @param taxTypeId [String] The taxType for the country to examine for taxsubtype
|
1023
|
+
# @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/).
|
1024
|
+
# @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.
|
1025
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1026
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1027
|
+
# @return [FetchResult]
|
1028
|
+
def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
|
1029
|
+
get(path, options, "22.2.0") end
|
1030
|
+
|
1031
|
+
# Retrieve the full list of tax sub types by jurisdiction code and region
|
1032
|
+
#
|
1033
|
+
# Returns the full list of Avalara-supported tax sub-types by jurisdiction and region
|
1034
|
+
# This API is intended to be useful to identify all the different tax sub-types.
|
1035
|
+
# Swagger Name: AvaTaxClient
|
1036
|
+
# @param jurisdictionCode [String] The jurisdiction code of the tax sub type.
|
1037
|
+
# @param region [String] The region of the tax sub type.
|
1038
|
+
# @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/).
|
1039
|
+
# @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.
|
1040
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1041
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1042
|
+
# @return [FetchResult]
|
1043
|
+
def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
|
1044
|
+
get(path, options, "22.2.0") end
|
1045
|
+
|
1046
|
+
# Retrieve the full list of tax type groups
|
1047
|
+
#
|
904
1048
|
# Returns the full list of Avalara-supported tax type groups
|
905
|
-
# This API is intended to be useful to identify all the different tax type groups.
|
1049
|
+
# This API is intended to be useful to identify all the different tax type groups.
|
1050
|
+
# Swagger Name: AvaTaxClient
|
906
1051
|
# @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
|
907
1052
|
# @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.
|
908
1053
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
909
1054
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
910
|
-
# @return [FetchResult]
|
911
|
-
def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
|
912
|
-
get(path, options) end
|
913
|
-
|
914
|
-
#
|
915
|
-
#
|
1055
|
+
# @return [FetchResult]
|
1056
|
+
def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
|
1057
|
+
get(path, options, "22.2.0") end
|
1058
|
+
|
1059
|
+
# Retrieve the list of applicable TaxTypes
|
1060
|
+
#
|
1061
|
+
# Retrieves the list of applicable TaxTypes based on Nexus of the company.
|
1062
|
+
# Swagger Name: AvaTaxClient
|
1063
|
+
# @param country [String] The country for which you want to retrieve the unitofbasis information
|
1064
|
+
# @param companyId [Integer] Your companyId to retrieve the applicable taxtypes
|
1065
|
+
# @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.
|
1066
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1067
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1068
|
+
# @return [FetchResult]
|
1069
|
+
def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
|
1070
|
+
get(path, options, "22.2.0") end
|
1071
|
+
|
1072
|
+
# Retrieve the list of applicable UnitOfBasis
|
1073
|
+
#
|
1074
|
+
# Retrieves the list of applicable UnitOfBasis
|
1075
|
+
# Swagger Name: AvaTaxClient
|
1076
|
+
# @param country [String] The country for which you want to retrieve the unitofbasis information
|
1077
|
+
# @param taxTypeId [String] The taxtype for which you want to retrieve the unitofbasis information
|
1078
|
+
# @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the unitofbasis information
|
1079
|
+
# @param rateTypeId [String] The ratetype for which you want to retrieve the unitofbasis information
|
1080
|
+
# @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.
|
1081
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1082
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1083
|
+
# @return [FetchResult]
|
1084
|
+
def list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/unitofbasis/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
|
1085
|
+
get(path, options, "22.2.0") end
|
1086
|
+
|
1087
|
+
# List all defined units of measurement
|
1088
|
+
#
|
916
1089
|
# List all units of measurement systems defined by Avalara.
|
917
1090
|
#
|
918
|
-
# A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
|
1091
|
+
# A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
|
1092
|
+
# Swagger Name: AvaTaxClient
|
919
1093
|
# @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
|
920
1094
|
# @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.
|
921
1095
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
922
1096
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
923
|
-
# @return [FetchResult]
|
924
|
-
def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
|
925
|
-
get(path, options) end
|
926
|
-
end
|
927
|
-
end
|
1097
|
+
# @return [FetchResult]
|
1098
|
+
def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
|
1099
|
+
get(path, options, "22.2.0") end
|
1100
|
+
end
|
1101
|
+
end
|
928
1102
|
end
|