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