avatax 19.12.1 → 20.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +14 -35
  3. data/lib/avatax/client/addresses.rb +4 -10
  4. data/lib/avatax/client/avafileforms.rb +10 -25
  5. data/lib/avatax/client/batches.rb +12 -30
  6. data/lib/avatax/client/certexpressinvites.rb +6 -15
  7. data/lib/avatax/client/certificates.rb +31 -76
  8. data/lib/avatax/client/companies.rb +32 -80
  9. data/lib/avatax/client/compliance.rb +2 -5
  10. data/lib/avatax/client/contacts.rb +12 -30
  11. data/lib/avatax/client/customers.rb +26 -65
  12. data/lib/avatax/client/datasources.rb +12 -30
  13. data/lib/avatax/client/definitions.rb +124 -284
  14. data/lib/avatax/client/distancethresholds.rb +12 -30
  15. data/lib/avatax/client/filings.rb +2 -5
  16. data/lib/avatax/client/firmclientlinkages.rb +18 -45
  17. data/lib/avatax/client/free.rb +6 -15
  18. data/lib/avatax/client/fundingrequests.rb +4 -10
  19. data/lib/avatax/client/items.rb +38 -95
  20. data/lib/avatax/client/jurisdictionoverrides.rb +12 -30
  21. data/lib/avatax/client/locations.rb +14 -35
  22. data/lib/avatax/client/multidocument.rb +20 -50
  23. data/lib/avatax/client/nexus.rb +16 -40
  24. data/lib/avatax/client/notifications.rb +6 -15
  25. data/lib/avatax/client/provisioning.rb +4 -10
  26. data/lib/avatax/client/registrar.rb +20 -50
  27. data/lib/avatax/client/reports.rb +8 -20
  28. data/lib/avatax/client/settings.rb +12 -30
  29. data/lib/avatax/client/subscriptions.rb +6 -15
  30. data/lib/avatax/client/taxcodes.rb +12 -30
  31. data/lib/avatax/client/taxcontent.rb +6 -15
  32. data/lib/avatax/client/taxrules.rb +12 -30
  33. data/lib/avatax/client/transactions.rb +49 -112
  34. data/lib/avatax/client/upcs.rb +12 -30
  35. data/lib/avatax/client/users.rb +16 -40
  36. data/lib/avatax/client/utilities.rb +6 -15
  37. data/lib/avatax/version.rb +1 -1
  38. metadata +2 -2
@@ -14,11 +14,8 @@ module AvaTax
14
14
  # @param companyId [Integer] The id of the company you which to create the datasources
15
15
  # @param model [DataSourceModel[]]
16
16
  # @return [DataSourceModel[]]
17
- def create_data_sources(companyId, model)
18
- path = "/api/v2/companies/#{companyId}/datasources"
19
- post(path, model)
20
- end
21
-
17
+ def create_data_sources(companyId, model) path = "/api/v2/companies/#{companyId}/datasources"
18
+ post(path, model) end
22
19
 
23
20
  # Delete a datasource by datasource id for a company.
24
21
  #
@@ -31,11 +28,8 @@ module AvaTax
31
28
  # @param companyId [Integer] The id of the company the datasource belongs to.
32
29
  # @param id [Integer] The id of the datasource you wish to delete.
33
30
  # @return [ErrorDetail[]]
34
- def delete_data_source(companyId, id)
35
- path = "/api/v2/companies/#{companyId}/datasources/#{id}"
36
- delete(path)
37
- end
38
-
31
+ def delete_data_source(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
32
+ delete(path) end
39
33
 
40
34
  # Get data source by data source id
41
35
  #
@@ -48,11 +42,8 @@ module AvaTax
48
42
  # @param companyId [Integer]
49
43
  # @param id [Integer] data source id
50
44
  # @return [Object]
51
- def get_data_source_by_id(companyId, id)
52
- path = "/api/v2/companies/#{companyId}/datasources/#{id}"
53
- get(path)
54
- end
55
-
45
+ def get_data_source_by_id(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
46
+ get(path) end
56
47
 
57
48
  # Retrieve all datasources for this company
58
49
  #
@@ -68,11 +59,8 @@ module AvaTax
68
59
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
69
60
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
70
61
  # @return [FetchResult]
71
- def list_data_sources(companyId, options={})
72
- path = "/api/v2/companies/#{companyId}/datasources"
73
- get(path, options)
74
- end
75
-
62
+ def list_data_sources(companyId, options={}) path = "/api/v2/companies/#{companyId}/datasources"
63
+ get(path, options) end
76
64
 
77
65
  # Retrieve all datasources
78
66
  #
@@ -90,11 +78,8 @@ module AvaTax
90
78
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
91
79
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
92
80
  # @return [FetchResult]
93
- def query_data_sources(options={})
94
- path = "/api/v2/datasources"
95
- get(path, options)
96
- end
97
-
81
+ def query_data_sources(options={}) path = "/api/v2/datasources"
82
+ get(path, options) end
98
83
 
99
84
  # Update a datasource identified by id for a company
100
85
  #
@@ -108,11 +93,8 @@ module AvaTax
108
93
  # @param id [Integer] The id of the datasource you wish to delete.
109
94
  # @param model [Object]
110
95
  # @return [Object]
111
- def update_data_source(companyId, id, model)
112
- path = "/api/v2/companies/#{companyId}/datasources/#{id}"
113
- put(path, model)
114
- end
115
-
96
+ def update_data_source(companyId, id, model) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
97
+ put(path, model) end
116
98
  end
117
99
  end
118
100
  end
@@ -22,11 +22,8 @@ module AvaTax
22
22
  # @param country [String] The name or code of the destination country.
23
23
  # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
24
24
  # @return [FetchResult]
25
- def get_cross_border_code(country, hsCode)
26
- path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
27
- get(path)
28
- end
29
-
25
+ def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
26
+ get(path) end
30
27
 
31
28
  # Test whether a form supports online login verification
32
29
  #
@@ -38,11 +35,8 @@ module AvaTax
38
35
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
39
36
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
40
37
  # @return [FetchResult]
41
- def get_login_verifier_by_form(form, options={})
42
- path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
43
- get(path, options)
44
- end
45
-
38
+ def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
39
+ get(path, options) end
46
40
 
47
41
  # Retrieve the full list of the AvaFile Forms available
48
42
  #
@@ -57,11 +51,8 @@ module AvaTax
57
51
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
58
52
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
59
53
  # @return [FetchResult]
60
- def list_ava_file_forms(options={})
61
- path = "/api/v2/definitions/avafileforms"
62
- get(path, options)
63
- end
64
-
54
+ def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
55
+ get(path, options) end
65
56
 
66
57
  # List certificate attributes used by a company
67
58
  #
@@ -78,11 +69,8 @@ module AvaTax
78
69
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
79
70
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
80
71
  # @return [FetchResult]
81
- def list_certificate_attributes(options={})
82
- path = "/api/v2/definitions/certificateattributes"
83
- get(path, options)
84
- end
85
-
72
+ def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
73
+ get(path, options) end
86
74
 
87
75
  # List the certificate exempt reasons defined by a company
88
76
  #
@@ -98,11 +86,8 @@ module AvaTax
98
86
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
99
87
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
100
88
  # @return [FetchResult]
101
- def list_certificate_exempt_reasons(options={})
102
- path = "/api/v2/definitions/certificateexemptreasons"
103
- get(path, options)
104
- end
105
-
89
+ def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
90
+ get(path, options) end
106
91
 
107
92
  # List certificate exposure zones used by a company
108
93
  #
@@ -118,11 +103,8 @@ module AvaTax
118
103
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
119
104
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
120
105
  # @return [FetchResult]
121
- def list_certificate_exposure_zones(options={})
122
- path = "/api/v2/definitions/certificateexposurezones"
123
- get(path, options)
124
- end
125
-
106
+ def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
107
+ get(path, options) end
126
108
 
127
109
  # Retrieve the full list of communications service types
128
110
  #
@@ -133,11 +115,8 @@ module AvaTax
133
115
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
134
116
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
135
117
  # @return [FetchResult]
136
- def list_communications_service_types(id, options={})
137
- path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
138
- get(path, options)
139
- end
140
-
118
+ def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
119
+ get(path, options) end
141
120
 
142
121
  # Retrieve the full list of communications transactiontypes
143
122
  #
@@ -148,11 +127,8 @@ module AvaTax
148
127
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
149
128
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
150
129
  # @return [FetchResult]
151
- def list_communications_transaction_types(options={})
152
- path = "/api/v2/definitions/communications/transactiontypes"
153
- get(path, options)
154
- end
155
-
130
+ def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
131
+ get(path, options) end
156
132
 
157
133
  # Retrieve the full list of communications transaction/service type pairs
158
134
  #
@@ -163,11 +139,8 @@ module AvaTax
163
139
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
164
140
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
165
141
  # @return [FetchResult]
166
- def list_communications_t_s_pairs(options={})
167
- path = "/api/v2/definitions/communications/tspairs"
168
- get(path, options)
169
- end
170
-
142
+ def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
143
+ get(path, options) end
171
144
 
172
145
  # List all ISO 3166 countries
173
146
  #
@@ -179,11 +152,8 @@ module AvaTax
179
152
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
180
153
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
181
154
  # @return [FetchResult]
182
- def list_countries(options={})
183
- path = "/api/v2/definitions/countries"
184
- get(path, options)
185
- end
186
-
155
+ def list_countries(options={}) path = "/api/v2/definitions/countries"
156
+ get(path, options) end
187
157
 
188
158
  # List certificate exposure zones used by a company
189
159
  #
@@ -200,11 +170,8 @@ module AvaTax
200
170
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
201
171
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
202
172
  # @return [FetchResult]
203
- def list_cover_letters(options={})
204
- path = "/api/v2/definitions/coverletters"
205
- get(path, options)
206
- end
207
-
173
+ def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
174
+ get(path, options) end
208
175
 
209
176
  # Lists the next level of HS Codes given a destination country and HS Code prefix.
210
177
  #
@@ -227,11 +194,8 @@ module AvaTax
227
194
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
228
195
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
229
196
  # @return [FetchResult]
230
- def list_cross_border_codes(country, hsCode, options={})
231
- path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
232
- get(path, options)
233
- end
234
-
197
+ def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
198
+ get(path, options) end
235
199
 
236
200
  # List top level HS Code Sections.
237
201
  #
@@ -246,11 +210,8 @@ module AvaTax
246
210
  #
247
211
  # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
248
212
  # @return [FetchResult]
249
- def list_cross_border_sections()
250
- path = "/api/v2/definitions/crossborder/sections"
251
- get(path)
252
- end
253
-
213
+ def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
214
+ get(path) end
254
215
 
255
216
  # List all ISO 4217 currencies supported by AvaTax.
256
217
  #
@@ -263,11 +224,8 @@ module AvaTax
263
224
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
264
225
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
265
226
  # @return [FetchResult]
266
- def list_currencies(options={})
267
- path = "/api/v2/definitions/currencies"
268
- get(path, options)
269
- end
270
-
227
+ def list_currencies(options={}) path = "/api/v2/definitions/currencies"
228
+ get(path, options) end
271
229
 
272
230
  # Retrieve the full list of Avalara-supported entity use codes
273
231
  #
@@ -281,11 +239,8 @@ module AvaTax
281
239
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
282
240
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
283
241
  # @return [FetchResult]
284
- def list_entity_use_codes(options={})
285
- path = "/api/v2/definitions/entityusecodes"
286
- get(path, options)
287
- end
288
-
242
+ def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
243
+ get(path, options) end
289
244
 
290
245
  # Retrieve the full list of Avalara-supported filing frequencies.
291
246
  #
@@ -296,11 +251,8 @@ module AvaTax
296
251
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
297
252
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
298
253
  # @return [FetchResult]
299
- def list_filing_frequencies(options={})
300
- path = "/api/v2/definitions/filingfrequencies"
301
- get(path, options)
302
- end
303
-
254
+ def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
255
+ get(path, options) end
304
256
 
305
257
  # List jurisdictions based on the filter provided
306
258
  #
@@ -315,11 +267,8 @@ module AvaTax
315
267
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
316
268
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
317
269
  # @return [FetchResult]
318
- def list_jurisdictions(options={})
319
- path = "/api/v2/definitions/jurisdictions"
320
- get(path, options)
321
- end
322
-
270
+ def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
271
+ get(path, options) end
323
272
 
324
273
  # List jurisdictions near a specific address
325
274
  #
@@ -342,11 +291,8 @@ module AvaTax
342
291
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
343
292
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
344
293
  # @return [FetchResult]
345
- def list_jurisdictions_by_address(options={})
346
- path = "/api/v2/definitions/jurisdictionsnearaddress"
347
- get(path, options)
348
- end
349
-
294
+ def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
295
+ get(path, options) end
350
296
 
351
297
  # Retrieve the list of questions that are required for a tax location
352
298
  #
@@ -370,11 +316,8 @@ module AvaTax
370
316
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
371
317
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
372
318
  # @return [FetchResult]
373
- def list_location_questions_by_address(options={})
374
- path = "/api/v2/definitions/locationquestions"
375
- get(path, options)
376
- end
377
-
319
+ def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
320
+ get(path, options) end
378
321
 
379
322
  # List all forms where logins can be verified automatically
380
323
  #
@@ -386,11 +329,19 @@ module AvaTax
386
329
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
387
330
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
388
331
  # @return [FetchResult]
389
- def list_login_verifiers(options={})
390
- path = "/api/v2/definitions/filingcalendars/loginverifiers"
391
- get(path, options)
392
- end
332
+ def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
333
+ get(path, options) end
393
334
 
335
+ # Retrieve the list of locations for a marketplace.
336
+ #
337
+ # Retrieves the list of suggested locations for a marketplace.
338
+ # @param marketplaceId [String] MarketplaceId of a marketplace
339
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
340
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
341
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
342
+ # @return [FetchResult]
343
+ def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
344
+ get(path, options) end
394
345
 
395
346
  # Retrieve the full list of Avalara-supported nexus for all countries and regions.
396
347
  #
@@ -402,11 +353,8 @@ module AvaTax
402
353
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
403
354
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
404
355
  # @return [FetchResult]
405
- def list_nexus(options={})
406
- path = "/api/v2/definitions/nexus"
407
- get(path, options)
408
- end
409
-
356
+ def list_nexus(options={}) path = "/api/v2/definitions/nexus"
357
+ get(path, options) end
410
358
 
411
359
  # List all nexus that apply to a specific address.
412
360
  #
@@ -427,11 +375,8 @@ module AvaTax
427
375
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
428
376
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
429
377
  # @return [FetchResult]
430
- def list_nexus_by_address(options={})
431
- path = "/api/v2/definitions/nexus/byaddress"
432
- get(path, options)
433
- end
434
-
378
+ def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
379
+ get(path, options) end
435
380
 
436
381
  # Retrieve the full list of Avalara-supported nexus for a country.
437
382
  #
@@ -444,11 +389,8 @@ module AvaTax
444
389
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
445
390
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
446
391
  # @return [FetchResult]
447
- def list_nexus_by_country(country, options={})
448
- path = "/api/v2/definitions/nexus/#{country}"
449
- get(path, options)
450
- end
451
-
392
+ def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
393
+ get(path, options) end
452
394
 
453
395
  # Retrieve the full list of Avalara-supported nexus for a country and region.
454
396
  #
@@ -462,11 +404,8 @@ module AvaTax
462
404
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
463
405
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
464
406
  # @return [FetchResult]
465
- def list_nexus_by_country_and_region(country, region, options={})
466
- path = "/api/v2/definitions/nexus/#{country}/#{region}"
467
- get(path, options)
468
- end
469
-
407
+ def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
408
+ get(path, options) end
470
409
 
471
410
  # List nexus related to a tax form
472
411
  #
@@ -487,11 +426,8 @@ module AvaTax
487
426
  # * 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.
488
427
  # @param formCode [String] The form code that we are looking up the nexus for
489
428
  # @return [Object]
490
- def list_nexus_by_form_code(formCode)
491
- path = "/api/v2/definitions/nexus/byform/#{formCode}"
492
- get(path)
493
- end
494
-
429
+ def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
430
+ get(path) end
495
431
 
496
432
  # Retrieve the full list of nexus tax type groups
497
433
  #
@@ -502,11 +438,8 @@ module AvaTax
502
438
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
503
439
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
504
440
  # @return [FetchResult]
505
- def list_nexus_tax_type_groups(options={})
506
- path = "/api/v2/definitions/nexustaxtypegroups"
507
- get(path, options)
508
- end
509
-
441
+ def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
442
+ get(path, options) end
510
443
 
511
444
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
512
445
  #
@@ -517,11 +450,8 @@ module AvaTax
517
450
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
518
451
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
519
452
  # @return [FetchResult]
520
- def list_notice_customer_funding_options(options={})
521
- path = "/api/v2/definitions/noticecustomerfundingoptions"
522
- get(path, options)
523
- end
524
-
453
+ def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
454
+ get(path, options) end
525
455
 
526
456
  # Retrieve the full list of Avalara-supported tax notice customer types.
527
457
  #
@@ -532,11 +462,8 @@ module AvaTax
532
462
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
533
463
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
534
464
  # @return [FetchResult]
535
- def list_notice_customer_types(options={})
536
- path = "/api/v2/definitions/noticecustomertypes"
537
- get(path, options)
538
- end
539
-
465
+ def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
466
+ get(path, options) end
540
467
 
541
468
  # Retrieve the full list of Avalara-supported tax notice filing types.
542
469
  #
@@ -547,11 +474,8 @@ module AvaTax
547
474
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
548
475
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
549
476
  # @return [FetchResult]
550
- def list_notice_filingtypes(options={})
551
- path = "/api/v2/definitions/noticefilingtypes"
552
- get(path, options)
553
- end
554
-
477
+ def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
478
+ get(path, options) end
555
479
 
556
480
  # Retrieve the full list of Avalara-supported tax notice priorities.
557
481
  #
@@ -562,11 +486,8 @@ module AvaTax
562
486
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
563
487
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
564
488
  # @return [FetchResult]
565
- def list_notice_priorities(options={})
566
- path = "/api/v2/definitions/noticepriorities"
567
- get(path, options)
568
- end
569
-
489
+ def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
490
+ get(path, options) end
570
491
 
571
492
  # Retrieve the full list of Avalara-supported tax notice reasons.
572
493
  #
@@ -577,11 +498,8 @@ module AvaTax
577
498
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
578
499
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
579
500
  # @return [FetchResult]
580
- def list_notice_reasons(options={})
581
- path = "/api/v2/definitions/noticereasons"
582
- get(path, options)
583
- end
584
-
501
+ def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
502
+ get(path, options) end
585
503
 
586
504
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
587
505
  #
@@ -592,11 +510,8 @@ module AvaTax
592
510
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
593
511
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
594
512
  # @return [FetchResult]
595
- def list_notice_responsibilities(options={})
596
- path = "/api/v2/definitions/noticeresponsibilities"
597
- get(path, options)
598
- end
599
-
513
+ def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
514
+ get(path, options) end
600
515
 
601
516
  # Retrieve the full list of Avalara-supported tax notice root causes
602
517
  #
@@ -607,11 +522,8 @@ module AvaTax
607
522
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
608
523
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
609
524
  # @return [FetchResult]
610
- def list_notice_root_causes(options={})
611
- path = "/api/v2/definitions/noticerootcauses"
612
- get(path, options)
613
- end
614
-
525
+ def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
526
+ get(path, options) end
615
527
 
616
528
  # Retrieve the full list of Avalara-supported tax notice statuses.
617
529
  #
@@ -622,11 +534,8 @@ module AvaTax
622
534
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
623
535
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
624
536
  # @return [FetchResult]
625
- def list_notice_statuses(options={})
626
- path = "/api/v2/definitions/noticestatuses"
627
- get(path, options)
628
- end
629
-
537
+ def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
538
+ get(path, options) end
630
539
 
631
540
  # Retrieve the full list of Avalara-supported tax notice types.
632
541
  #
@@ -637,11 +546,8 @@ module AvaTax
637
546
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
638
547
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
639
548
  # @return [FetchResult]
640
- def list_notice_types(options={})
641
- path = "/api/v2/definitions/noticetypes"
642
- get(path, options)
643
- end
644
-
549
+ def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
550
+ get(path, options) end
645
551
 
646
552
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
647
553
  #
@@ -653,11 +559,8 @@ module AvaTax
653
559
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
654
560
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
655
561
  # @return [FetchResult]
656
- def list_parameters(options={})
657
- path = "/api/v2/definitions/parameters"
658
- get(path, options)
659
- end
660
-
562
+ def list_parameters(options={}) path = "/api/v2/definitions/parameters"
563
+ get(path, options) end
661
564
 
662
565
  # Retrieve the parameters by companyCode and itemCode.
663
566
  #
@@ -673,11 +576,8 @@ module AvaTax
673
576
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
674
577
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
675
578
  # @return [FetchResult]
676
- def list_parameters_by_item(companyCode, itemCode, options={})
677
- path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
678
- get(path, options)
679
- end
680
-
579
+ def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
580
+ get(path, options) end
681
581
 
682
582
  # Retrieve the full list of Avalara-supported permissions
683
583
  #
@@ -686,11 +586,8 @@ module AvaTax
686
586
  # @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.
687
587
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
688
588
  # @return [FetchResult]
689
- def list_permissions(options={})
690
- path = "/api/v2/definitions/permissions"
691
- get(path, options)
692
- end
693
-
589
+ def list_permissions(options={}) path = "/api/v2/definitions/permissions"
590
+ get(path, options) end
694
591
 
695
592
  # Retrieve the full list of Avalara-supported postal codes.
696
593
  #
@@ -700,11 +597,8 @@ module AvaTax
700
597
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
701
598
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
702
599
  # @return [FetchResult]
703
- def list_postal_codes(options={})
704
- path = "/api/v2/definitions/postalcodes"
705
- get(path, options)
706
- end
707
-
600
+ def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
601
+ get(path, options) end
708
602
 
709
603
  # List all customs duty programs recognized by AvaTax
710
604
  #
@@ -722,11 +616,8 @@ module AvaTax
722
616
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
723
617
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
724
618
  # @return [FetchResult]
725
- def list_preferred_programs(options={})
726
- path = "/api/v2/definitions/preferredprograms"
727
- get(path, options)
728
- end
729
-
619
+ def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
620
+ get(path, options) end
730
621
 
731
622
  # List all available product classification systems.
732
623
  #
@@ -739,11 +630,8 @@ module AvaTax
739
630
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
740
631
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
741
632
  # @return [FetchResult]
742
- def list_product_classification_systems(options={})
743
- path = "/api/v2/definitions/productclassificationsystems"
744
- get(path, options)
745
- end
746
-
633
+ def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
634
+ get(path, options) end
747
635
 
748
636
  # List all product classification systems available to a company based on its nexus.
749
637
  #
@@ -757,11 +645,8 @@ module AvaTax
757
645
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
758
646
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
759
647
  # @return [FetchResult]
760
- def list_product_classification_systems_by_company(companyCode, options={})
761
- path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
762
- get(path, options)
763
- end
764
-
648
+ def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
649
+ get(path, options) end
765
650
 
766
651
  # Retrieve the full list of rate types for each country
767
652
  #
@@ -773,11 +658,8 @@ module AvaTax
773
658
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
774
659
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
775
660
  # @return [FetchResult]
776
- def list_rate_types_by_country(country, options={})
777
- path = "/api/v2/definitions/countries/#{country}/ratetypes"
778
- get(path, options)
779
- end
780
-
661
+ def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
662
+ get(path, options) end
781
663
 
782
664
  # List all ISO 3166 regions
783
665
  #
@@ -789,11 +671,8 @@ module AvaTax
789
671
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
790
672
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
791
673
  # @return [FetchResult]
792
- def list_regions(options={})
793
- path = "/api/v2/definitions/regions"
794
- get(path, options)
795
- end
796
-
674
+ def list_regions(options={}) path = "/api/v2/definitions/regions"
675
+ get(path, options) end
797
676
 
798
677
  # List all ISO 3166 regions for a country
799
678
  #
@@ -806,11 +685,8 @@ module AvaTax
806
685
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
807
686
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
808
687
  # @return [FetchResult]
809
- def list_regions_by_country(country, options={})
810
- path = "/api/v2/definitions/countries/#{country}/regions"
811
- get(path, options)
812
- end
813
-
688
+ def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
689
+ get(path, options) end
814
690
 
815
691
  # Retrieve the full list of Avalara-supported resource file types
816
692
  #
@@ -821,11 +697,8 @@ module AvaTax
821
697
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
822
698
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
823
699
  # @return [FetchResult]
824
- def list_resource_file_types(options={})
825
- path = "/api/v2/definitions/resourcefiletypes"
826
- get(path, options)
827
- end
828
-
700
+ def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
701
+ get(path, options) end
829
702
 
830
703
  # Retrieve the full list of Avalara-supported permissions
831
704
  #
@@ -837,11 +710,8 @@ module AvaTax
837
710
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
838
711
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
839
712
  # @return [FetchResult]
840
- def list_security_roles(options={})
841
- path = "/api/v2/definitions/securityroles"
842
- get(path, options)
843
- end
844
-
713
+ def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
714
+ get(path, options) end
845
715
 
846
716
  # Retrieve the full list of Avalara-supported subscription types
847
717
  #
@@ -854,11 +724,8 @@ module AvaTax
854
724
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
855
725
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
856
726
  # @return [FetchResult]
857
- def list_subscription_types(options={})
858
- path = "/api/v2/definitions/subscriptiontypes"
859
- get(path, options)
860
- end
861
-
727
+ def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
728
+ get(path, options) end
862
729
 
863
730
  # Retrieve the full list of Avalara-supported tax authorities.
864
731
  #
@@ -869,11 +736,8 @@ module AvaTax
869
736
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
870
737
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
871
738
  # @return [FetchResult]
872
- def list_tax_authorities(options={})
873
- path = "/api/v2/definitions/taxauthorities"
874
- get(path, options)
875
- end
876
-
739
+ def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
740
+ get(path, options) end
877
741
 
878
742
  # Retrieve the full list of Avalara-supported forms for each tax authority.
879
743
  #
@@ -886,11 +750,8 @@ module AvaTax
886
750
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
887
751
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
888
752
  # @return [FetchResult]
889
- def list_tax_authority_forms(options={})
890
- path = "/api/v2/definitions/taxauthorityforms"
891
- get(path, options)
892
- end
893
-
753
+ def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
754
+ get(path, options) end
894
755
 
895
756
  # Retrieve the full list of Avalara-supported tax authority types.
896
757
  #
@@ -901,11 +762,8 @@ module AvaTax
901
762
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
902
763
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
903
764
  # @return [FetchResult]
904
- def list_tax_authority_types(options={})
905
- path = "/api/v2/definitions/taxauthoritytypes"
906
- get(path, options)
907
- end
908
-
765
+ def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
766
+ get(path, options) end
909
767
 
910
768
  # Retrieve the full list of Avalara-supported tax codes.
911
769
  #
@@ -923,11 +781,8 @@ module AvaTax
923
781
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
924
782
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
925
783
  # @return [FetchResult]
926
- def list_tax_codes(options={})
927
- path = "/api/v2/definitions/taxcodes"
928
- get(path, options)
929
- end
930
-
784
+ def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
785
+ get(path, options) end
931
786
 
932
787
  # Retrieve the full list of Avalara-supported tax code types.
933
788
  #
@@ -937,11 +792,8 @@ module AvaTax
937
792
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
938
793
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
939
794
  # @return [Object]
940
- def list_tax_code_types(options={})
941
- path = "/api/v2/definitions/taxcodetypes"
942
- get(path, options)
943
- end
944
-
795
+ def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
796
+ get(path, options) end
945
797
 
946
798
  # Retrieve the full list of the Tax Forms available
947
799
  #
@@ -952,11 +804,8 @@ module AvaTax
952
804
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
953
805
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
954
806
  # @return [FetchResult]
955
- def list_tax_forms(options={})
956
- path = "/api/v2/definitions/taxforms"
957
- get(path, options)
958
- end
959
-
807
+ def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
808
+ get(path, options) end
960
809
 
961
810
  # Retrieve the full list of tax sub types
962
811
  #
@@ -967,11 +816,8 @@ module AvaTax
967
816
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
968
817
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
969
818
  # @return [FetchResult]
970
- def list_tax_sub_types(options={})
971
- path = "/api/v2/definitions/taxsubtypes"
972
- get(path, options)
973
- end
974
-
819
+ def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
820
+ get(path, options) end
975
821
 
976
822
  # Retrieve the full list of tax type groups
977
823
  #
@@ -982,11 +828,8 @@ module AvaTax
982
828
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
983
829
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
984
830
  # @return [FetchResult]
985
- def list_tax_type_groups(options={})
986
- path = "/api/v2/definitions/taxtypegroups"
987
- get(path, options)
988
- end
989
-
831
+ def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
832
+ get(path, options) end
990
833
 
991
834
  # List all defined units of measurement
992
835
  #
@@ -998,11 +841,8 @@ module AvaTax
998
841
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
999
842
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1000
843
  # @return [FetchResult]
1001
- def list_unit_of_measurement(options={})
1002
- path = "/api/v2/definitions/unitofmeasurements"
1003
- get(path, options)
1004
- end
1005
-
844
+ def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
845
+ get(path, options) end
1006
846
  end
1007
847
  end
1008
848
  end