avatax 22.8.0 → 23.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/gem-push.yml +3 -3
  3. data/.gitignore +2 -0
  4. data/README.md +1 -1
  5. data/avatax.gemspec +3 -3
  6. data/lib/avatax/api.rb +14 -0
  7. data/lib/avatax/client/accounts.rb +17 -17
  8. data/lib/avatax/client/addresses.rb +2 -2
  9. data/lib/avatax/client/advancedrules.rb +5 -5
  10. data/lib/avatax/client/ageverification.rb +60 -1
  11. data/lib/avatax/client/avafileforms.rb +5 -5
  12. data/lib/avatax/client/batches.rb +8 -8
  13. data/lib/avatax/client/certexpressinvites.rb +3 -3
  14. data/lib/avatax/client/certificates.rb +15 -15
  15. data/lib/avatax/client/companies.rb +36 -36
  16. data/lib/avatax/client/compliance.rb +1 -1
  17. data/lib/avatax/client/contacts.rb +6 -6
  18. data/lib/avatax/client/customers.rb +13 -13
  19. data/lib/avatax/client/datasources.rb +9 -9
  20. data/lib/avatax/client/definitions.rb +112 -78
  21. data/lib/avatax/client/distancethresholds.rb +6 -6
  22. data/lib/avatax/client/ecommercetoken.rb +4 -4
  23. data/lib/avatax/client/firmclientlinkages.rb +11 -11
  24. data/lib/avatax/client/free.rb +1 -1
  25. data/lib/avatax/client/fundingrequests.rb +3 -3
  26. data/lib/avatax/client/items.rb +52 -49
  27. data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
  28. data/lib/avatax/client/locations.rb +18 -18
  29. data/lib/avatax/client/multidocument.rb +10 -10
  30. data/lib/avatax/client/nexus.rb +15 -15
  31. data/lib/avatax/client/notices.rb +4 -4
  32. data/lib/avatax/client/notifications.rb +6 -6
  33. data/lib/avatax/client/provisioning.rb +2 -2
  34. data/lib/avatax/client/registrar.rb +32 -10
  35. data/lib/avatax/client/reports.rb +4 -4
  36. data/lib/avatax/client/settings.rb +9 -9
  37. data/lib/avatax/client/shippingverification.rb +4 -4
  38. data/lib/avatax/client/subscriptions.rb +3 -3
  39. data/lib/avatax/client/taxcodes.rb +9 -9
  40. data/lib/avatax/client/taxcontent.rb +16 -12
  41. data/lib/avatax/client/taxrules.rb +42 -6
  42. data/lib/avatax/client/transactions.rb +81 -22
  43. data/lib/avatax/client/upcs.rb +6 -6
  44. data/lib/avatax/client/userdefinedfields.rb +4 -4
  45. data/lib/avatax/client/users.rb +12 -12
  46. data/lib/avatax/client/utilities.rb +3 -3
  47. data/lib/avatax/client.rb +1 -0
  48. data/lib/avatax/configuration.rb +4 -1
  49. data/lib/avatax/connection.rb +17 -12
  50. data/lib/avatax/version.rb +1 -1
  51. data/spec/spec_helper.rb +2 -1
  52. metadata +10 -10
@@ -24,7 +24,7 @@ module AvaTax
24
24
  # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
25
25
  # @return [FetchResult]
26
26
  def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
27
- get(path, {}, "22.8.0") end
27
+ get(path, {}, AvaTax::VERSION) end
28
28
 
29
29
  # Test whether a form supports online login verification
30
30
  #
@@ -38,7 +38,7 @@ module AvaTax
38
38
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
39
39
  # @return [FetchResult]
40
40
  def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
41
- get(path, options, "22.8.0") end
41
+ get(path, options, AvaTax::VERSION) end
42
42
 
43
43
  # List all market place locations.
44
44
  #
@@ -50,7 +50,7 @@ module AvaTax
50
50
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
51
51
  # @return [FetchResult]
52
52
  def list_all_marketplace_locations(options={}) path = "/api/v2/definitions/listallmarketplacelocations"
53
- get(path, options, "22.8.0") end
53
+ get(path, options, AvaTax::VERSION) end
54
54
 
55
55
  # Retrieve the full list of the AvaFile Forms available
56
56
  #
@@ -67,7 +67,7 @@ module AvaTax
67
67
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
68
68
  # @return [FetchResult]
69
69
  def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
70
- get(path, options, "22.8.0") end
70
+ get(path, options, AvaTax::VERSION) end
71
71
 
72
72
  # List certificate attributes used by a company
73
73
  #
@@ -86,7 +86,7 @@ module AvaTax
86
86
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
87
87
  # @return [FetchResult]
88
88
  def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
89
- get(path, options, "22.8.0") end
89
+ get(path, options, AvaTax::VERSION) end
90
90
 
91
91
  # List the certificate exempt reasons defined by a company
92
92
  #
@@ -104,7 +104,7 @@ module AvaTax
104
104
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
105
105
  # @return [FetchResult]
106
106
  def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
107
- get(path, options, "22.8.0") end
107
+ get(path, options, AvaTax::VERSION) end
108
108
 
109
109
  # List certificate exposure zones used by a company
110
110
  #
@@ -122,7 +122,7 @@ module AvaTax
122
122
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
123
123
  # @return [FetchResult]
124
124
  def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
125
- get(path, options, "22.8.0") end
125
+ get(path, options, AvaTax::VERSION) end
126
126
 
127
127
  # Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
128
128
  #
@@ -136,7 +136,7 @@ module AvaTax
136
136
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
137
137
  # @return [FetchResult]
138
138
  def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
139
- get(path, options, "22.8.0") end
139
+ get(path, options, AvaTax::VERSION) end
140
140
 
141
141
  # Retrieve the full list of communications service types
142
142
  #
@@ -149,7 +149,7 @@ module AvaTax
149
149
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
150
150
  # @return [FetchResult]
151
151
  def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
152
- get(path, options, "22.8.0") end
152
+ get(path, options, AvaTax::VERSION) end
153
153
 
154
154
  # Retrieve the full list of communications transactiontypes
155
155
  #
@@ -162,7 +162,7 @@ module AvaTax
162
162
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
163
163
  # @return [FetchResult]
164
164
  def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
165
- get(path, options, "22.8.0") end
165
+ get(path, options, AvaTax::VERSION) end
166
166
 
167
167
  # Retrieve the full list of communications transaction/service type pairs
168
168
  #
@@ -175,7 +175,7 @@ module AvaTax
175
175
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
176
176
  # @return [FetchResult]
177
177
  def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
178
- get(path, options, "22.8.0") end
178
+ get(path, options, AvaTax::VERSION) end
179
179
 
180
180
  # List all ISO 3166 countries
181
181
  #
@@ -189,7 +189,7 @@ module AvaTax
189
189
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
190
190
  # @return [FetchResult]
191
191
  def list_countries(options={}) path = "/api/v2/definitions/countries"
192
- get(path, options, "22.8.0") end
192
+ get(path, options, AvaTax::VERSION) end
193
193
 
194
194
  # List certificate exposure zones used by a company
195
195
  #
@@ -208,7 +208,7 @@ module AvaTax
208
208
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
209
209
  # @return [FetchResult]
210
210
  def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
211
- get(path, options, "22.8.0") end
211
+ get(path, options, AvaTax::VERSION) end
212
212
 
213
213
  # Lists the next level of HS Codes given a destination country and HS Code prefix.
214
214
  #
@@ -233,7 +233,7 @@ module AvaTax
233
233
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
234
234
  # @return [FetchResult]
235
235
  def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
236
- get(path, options, "22.8.0") end
236
+ get(path, options, AvaTax::VERSION) end
237
237
 
238
238
  # List top level HS Code Sections.
239
239
  #
@@ -250,7 +250,7 @@ module AvaTax
250
250
  # Swagger Name: AvaTaxClient
251
251
  # @return [FetchResult]
252
252
  def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
253
- get(path, {}, "22.8.0") end
253
+ get(path, {}, AvaTax::VERSION) end
254
254
 
255
255
  # List all ISO 4217 currencies supported by AvaTax.
256
256
  #
@@ -265,7 +265,7 @@ module AvaTax
265
265
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
266
266
  # @return [FetchResult]
267
267
  def list_currencies(options={}) path = "/api/v2/definitions/currencies"
268
- get(path, options, "22.8.0") end
268
+ get(path, options, AvaTax::VERSION) end
269
269
 
270
270
  # Retrieve the full list of Avalara-supported entity use codes
271
271
  #
@@ -281,7 +281,7 @@ module AvaTax
281
281
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
282
282
  # @return [FetchResult]
283
283
  def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
284
- get(path, options, "22.8.0") end
284
+ get(path, options, AvaTax::VERSION) end
285
285
 
286
286
  # Retrieve the full list of Avalara-supported filing frequencies.
287
287
  #
@@ -294,7 +294,7 @@ module AvaTax
294
294
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
295
295
  # @return [FetchResult]
296
296
  def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
297
- get(path, options, "22.8.0") end
297
+ get(path, options, AvaTax::VERSION) end
298
298
 
299
299
  # List jurisdictions based on the filter provided
300
300
  #
@@ -305,13 +305,13 @@ module AvaTax
305
305
  #
306
306
  # The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
307
307
  # Swagger Name: AvaTaxClient
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
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, isAcm, isSst
309
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.
310
310
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
311
311
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
312
312
  # @return [FetchResult]
313
313
  def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
314
- get(path, options, "22.8.0") end
314
+ get(path, options, AvaTax::VERSION) end
315
315
 
316
316
  # List jurisdictions near a specific address
317
317
  #
@@ -336,7 +336,7 @@ module AvaTax
336
336
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
337
337
  # @return [FetchResult]
338
338
  def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
339
- get(path, options, "22.8.0") end
339
+ get(path, options, AvaTax::VERSION) end
340
340
 
341
341
  # List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
342
342
  #
@@ -352,15 +352,15 @@ module AvaTax
352
352
  # @param country [String] The country for which you want to retrieve the jurisdiction information
353
353
  # @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
354
354
  # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
355
- # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
355
+ # @param rateTypeId [Integer] The ratetype for which you want to retrieve the jurisdiction information
356
356
  # @param region [String] The region for which you want to retrieve the jurisdiction information
357
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId
357
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId, stateFips
358
358
  # @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.
359
359
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
360
360
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
361
361
  # @return [FetchResult]
362
362
  def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
363
- get(path, options, "22.8.0") end
363
+ get(path, options, AvaTax::VERSION) end
364
364
 
365
365
  # List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
366
366
  #
@@ -372,7 +372,7 @@ module AvaTax
372
372
  # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
373
373
  # @return [string[]]
374
374
  def list_jurisdiction_types_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictionTypes/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
375
- get(path, options, "22.8.0") end
375
+ get(path, options, AvaTax::VERSION) end
376
376
 
377
377
  # Retrieve the list of questions that are required for a tax location
378
378
  #
@@ -398,7 +398,7 @@ module AvaTax
398
398
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
399
399
  # @return [FetchResult]
400
400
  def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
401
- get(path, options, "22.8.0") end
401
+ get(path, options, AvaTax::VERSION) end
402
402
 
403
403
  # List all forms where logins can be verified automatically
404
404
  #
@@ -412,7 +412,7 @@ module AvaTax
412
412
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
413
413
  # @return [FetchResult]
414
414
  def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
415
- get(path, options, "22.8.0") end
415
+ get(path, options, AvaTax::VERSION) end
416
416
 
417
417
  # Retrieve the list of locations for a marketplace.
418
418
  #
@@ -424,7 +424,7 @@ module AvaTax
424
424
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
425
425
  # @return [FetchResult]
426
426
  def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
427
- get(path, options, "22.8.0") end
427
+ get(path, options, AvaTax::VERSION) end
428
428
 
429
429
  # Retrieve the full list of Avalara-supported nexus for all countries and regions.
430
430
  #
@@ -438,7 +438,7 @@ module AvaTax
438
438
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
439
439
  # @return [FetchResult]
440
440
  def list_nexus(options={}) path = "/api/v2/definitions/nexus"
441
- get(path, options, "22.8.0") end
441
+ get(path, options, AvaTax::VERSION) end
442
442
 
443
443
  # List all nexus that apply to a specific address.
444
444
  #
@@ -461,7 +461,7 @@ module AvaTax
461
461
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
462
462
  # @return [FetchResult]
463
463
  def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
464
- get(path, options, "22.8.0") end
464
+ get(path, options, AvaTax::VERSION) end
465
465
 
466
466
  # Retrieve the full list of Avalara-supported nexus for a country.
467
467
  #
@@ -476,7 +476,7 @@ module AvaTax
476
476
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
477
477
  # @return [FetchResult]
478
478
  def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
479
- get(path, options, "22.8.0") end
479
+ get(path, options, AvaTax::VERSION) end
480
480
 
481
481
  # Retrieve the full list of Avalara-supported nexus for a country and region.
482
482
  #
@@ -492,7 +492,7 @@ module AvaTax
492
492
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
493
493
  # @return [FetchResult]
494
494
  def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
495
- get(path, options, "22.8.0") end
495
+ get(path, options, AvaTax::VERSION) end
496
496
 
497
497
  # List nexus related to a tax form
498
498
  #
@@ -515,7 +515,7 @@ module AvaTax
515
515
  # @param formCode [String] The form code that we are looking up the nexus for
516
516
  # @return [Object]
517
517
  def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
518
- get(path, {}, "22.8.0") end
518
+ get(path, {}, AvaTax::VERSION) end
519
519
 
520
520
  # Retrieve the full list of Avalara-supported nexus for a tax type group.
521
521
  #
@@ -530,7 +530,7 @@ module AvaTax
530
530
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
531
531
  # @return [FetchResult]
532
532
  def list_nexus_by_tax_type_group(taxTypeGroup, options={}) path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
533
- get(path, options, "22.8.0") end
533
+ get(path, options, AvaTax::VERSION) end
534
534
 
535
535
  # Retrieve the full list of nexus tax type groups
536
536
  #
@@ -543,7 +543,7 @@ module AvaTax
543
543
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
544
544
  # @return [FetchResult]
545
545
  def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
546
- get(path, options, "22.8.0") end
546
+ get(path, options, AvaTax::VERSION) end
547
547
 
548
548
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
549
549
  #
@@ -556,7 +556,7 @@ module AvaTax
556
556
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
557
557
  # @return [FetchResult]
558
558
  def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
559
- get(path, options, "22.8.0") end
559
+ get(path, options, AvaTax::VERSION) end
560
560
 
561
561
  # Retrieve the full list of Avalara-supported tax notice customer types.
562
562
  #
@@ -569,7 +569,7 @@ module AvaTax
569
569
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
570
570
  # @return [FetchResult]
571
571
  def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
572
- get(path, options, "22.8.0") end
572
+ get(path, options, AvaTax::VERSION) end
573
573
 
574
574
  # Retrieve the full list of Avalara-supported tax notice filing types.
575
575
  #
@@ -582,7 +582,7 @@ module AvaTax
582
582
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
583
583
  # @return [FetchResult]
584
584
  def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
585
- get(path, options, "22.8.0") end
585
+ get(path, options, AvaTax::VERSION) end
586
586
 
587
587
  # Retrieve the full list of Avalara-supported tax notice priorities.
588
588
  #
@@ -595,7 +595,7 @@ module AvaTax
595
595
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
596
596
  # @return [FetchResult]
597
597
  def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
598
- get(path, options, "22.8.0") end
598
+ get(path, options, AvaTax::VERSION) end
599
599
 
600
600
  # Retrieve the full list of Avalara-supported tax notice reasons.
601
601
  #
@@ -608,7 +608,7 @@ module AvaTax
608
608
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
609
609
  # @return [FetchResult]
610
610
  def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
611
- get(path, options, "22.8.0") end
611
+ get(path, options, AvaTax::VERSION) end
612
612
 
613
613
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
614
614
  #
@@ -621,7 +621,7 @@ module AvaTax
621
621
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
622
622
  # @return [FetchResult]
623
623
  def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
624
- get(path, options, "22.8.0") end
624
+ get(path, options, AvaTax::VERSION) end
625
625
 
626
626
  # Retrieve the full list of Avalara-supported tax notice root causes
627
627
  #
@@ -634,20 +634,20 @@ module AvaTax
634
634
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
635
635
  # @return [FetchResult]
636
636
  def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
637
- get(path, options, "22.8.0") end
637
+ get(path, options, AvaTax::VERSION) end
638
638
 
639
639
  # Retrieve the full list of Avalara-supported tax notice statuses.
640
640
  #
641
641
  # Returns the full list of Avalara-supported tax notice statuses.
642
642
  # This API is intended to be useful to identify all the different tax notice statuses.
643
643
  # Swagger Name: AvaTaxClient
644
- # @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
644
+ # @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, activeFlag
645
645
  # @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.
646
646
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
647
647
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
648
648
  # @return [FetchResult]
649
649
  def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
650
- get(path, options, "22.8.0") end
650
+ get(path, options, AvaTax::VERSION) end
651
651
 
652
652
  # Retrieve the full list of Avalara-supported tax notice types.
653
653
  #
@@ -660,7 +660,7 @@ module AvaTax
660
660
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
661
661
  # @return [FetchResult]
662
662
  def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
663
- get(path, options, "22.8.0") end
663
+ get(path, options, AvaTax::VERSION) end
664
664
 
665
665
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
666
666
  #
@@ -674,7 +674,20 @@ module AvaTax
674
674
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
675
675
  # @return [FetchResult]
676
676
  def list_parameters(options={}) path = "/api/v2/definitions/parameters"
677
- get(path, options, "22.8.0") end
677
+ get(path, options, AvaTax::VERSION) end
678
+
679
+ # Retrieve the list of Avalara-supported parameters based on account subscriptions.
680
+ #
681
+ # Returns the list of Avalara-supported parameters based on account subscriptions.
682
+ # Swagger Name: AvaTaxClient
683
+ # @param accountId [Integer] The ID of the account to retrieve the parameters.
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
685
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
686
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
687
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
688
+ # @return [FetchResult]
689
+ def list_parameters_by_account(accountId, options={}) path = "/api/v2/definitions/accounts/#{accountId}/parameters"
690
+ get(path, options, AvaTax::VERSION) end
678
691
 
679
692
  # Retrieve the parameters by companyCode and itemCode.
680
693
  #
@@ -705,7 +718,7 @@ module AvaTax
705
718
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
706
719
  # @return [FetchResult]
707
720
  def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
708
- get(path, options, "22.8.0") end
721
+ get(path, options, AvaTax::VERSION) end
709
722
 
710
723
  # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
711
724
  #
@@ -713,13 +726,13 @@ module AvaTax
713
726
  # This list of parameters is available for use when configuring your transaction.
714
727
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
715
728
  # Swagger Name: AvaTaxClient
716
- # @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
729
+ # @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, valueDescriptions
717
730
  # @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.
718
731
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
719
732
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
720
733
  # @return [FetchResult]
721
734
  def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
722
- get(path, options, "22.8.0") end
735
+ get(path, options, AvaTax::VERSION) end
723
736
 
724
737
  # Retrieve the full list of Avalara-supported permissions
725
738
  #
@@ -730,7 +743,7 @@ module AvaTax
730
743
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
731
744
  # @return [FetchResult]
732
745
  def list_permissions(options={}) path = "/api/v2/definitions/permissions"
733
- get(path, options, "22.8.0") end
746
+ get(path, options, AvaTax::VERSION) end
734
747
 
735
748
  # Retrieve the full list of Avalara-supported postal codes.
736
749
  #
@@ -740,9 +753,10 @@ module AvaTax
740
753
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
741
754
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
742
755
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
756
+ # @param includeExpiredPostalCodes [Boolean] If set to true, returns expired postal codes. Defaults to false
743
757
  # @return [FetchResult]
744
758
  def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
745
- get(path, options, "22.8.0") end
759
+ get(path, options, AvaTax::VERSION) end
746
760
 
747
761
  # List all customs duty programs recognized by AvaTax
748
762
  #
@@ -762,7 +776,7 @@ module AvaTax
762
776
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
763
777
  # @return [FetchResult]
764
778
  def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
765
- get(path, options, "22.8.0") end
779
+ get(path, options, AvaTax::VERSION) end
766
780
 
767
781
  # List all available product classification systems.
768
782
  #
@@ -778,7 +792,7 @@ module AvaTax
778
792
  # @param countryCode [String] If not null, return all records with this code.
779
793
  # @return [FetchResult]
780
794
  def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
781
- get(path, options, "22.8.0") end
795
+ get(path, options, AvaTax::VERSION) end
782
796
 
783
797
  # List all product classification systems available to a company based on its nexus.
784
798
  #
@@ -803,7 +817,7 @@ module AvaTax
803
817
  # @param countryCode [String] If not null, return all records with this code.
804
818
  # @return [FetchResult]
805
819
  def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
806
- get(path, options, "22.8.0") end
820
+ get(path, options, AvaTax::VERSION) end
807
821
 
808
822
  # Retrieve the full list of rate types for each country
809
823
  #
@@ -817,7 +831,7 @@ module AvaTax
817
831
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
818
832
  # @return [FetchResult]
819
833
  def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
820
- get(path, options, "22.8.0") end
834
+ get(path, options, AvaTax::VERSION) end
821
835
 
822
836
  # Retrieve the list of rate types by country, TaxType and by TaxSubType
823
837
  #
@@ -833,7 +847,7 @@ module AvaTax
833
847
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
834
848
  # @return [FetchResult]
835
849
  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"
836
- get(path, options, "22.8.0") end
850
+ get(path, options, AvaTax::VERSION) end
837
851
 
838
852
  # List all ISO 3166 regions
839
853
  #
@@ -847,7 +861,7 @@ module AvaTax
847
861
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
848
862
  # @return [FetchResult]
849
863
  def list_regions(options={}) path = "/api/v2/definitions/regions"
850
- get(path, options, "22.8.0") end
864
+ get(path, options, AvaTax::VERSION) end
851
865
 
852
866
  # List all ISO 3166 regions for a country
853
867
  #
@@ -862,7 +876,26 @@ module AvaTax
862
876
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
863
877
  # @return [FetchResult]
864
878
  def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
865
- get(path, options, "22.8.0") end
879
+ get(path, options, AvaTax::VERSION) end
880
+
881
+ # Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeId
882
+ #
883
+ # Returns a list of all ISO 3166 region codes for a specific country code and their US English friendly names.
884
+ # This API is intended to be used as a way to provide a dropdown box in your website to allow customers to select a region
885
+ # within the country for shipping addresses.
886
+ # Swagger Name: AvaTaxClient
887
+ # @param companyId [Integer] The ID of the company for which you want to retrieve the applicable regions
888
+ # @param country [String] The country for which you want to retrieve the regions
889
+ # @param taxTypeId [String] The taxTypeId for which you want to retrieve the regions. Example values include Autimotive, tires, Lodging, S, U, I, O, All, etc. Run the "/api/v2/definitions/taxtypes/countries/{country}?companyId=" endpoint for a list of taxTypeId values.
890
+ # @param taxSubTypeId [String] The taxSubType for which you want to retrieve the regions. Example values include Accommodations, BikeTax, IGST, S, U, All, etc. Run the "api/v2/definitions/taxsubtypes" endpoint for a list of taxSubTypes values.
891
+ # @param rateTypeId [Integer] The rateTypeId for which you want to retrieve the regions. Note: The rateTypeId is an integer. Run the "/api/v2/definitions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/ratetypes" endpoint for a list of rateTypeId values."
892
+ # @param jurisdictionTypeId [String] The JurisdictionTypeId for which you want to retrieve the regions. This is a three-character string. Accepted values are ```CNT``` (country), ```STA``` (state), ```CTY``` (county), ```CIT``` (city), or ```STJ``` (special jurisdiction).
893
+ # @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.
894
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
895
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
896
+ # @return [FetchResult]
897
+ def list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type(companyId, country, taxTypeId, taxSubTypeId, rateTypeId, jurisdictionTypeId, options={}) path = "/api/v2/definitions/companies/#{companyId}/countries/#{country}/regions/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/rateTypeId/#{rateTypeId}/jurisdictionTypeId/#{jurisdictionTypeId}"
898
+ get(path, options, AvaTax::VERSION) end
866
899
 
867
900
  # Retrieve the full list of Avalara-supported resource file types
868
901
  #
@@ -875,7 +908,7 @@ module AvaTax
875
908
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
876
909
  # @return [FetchResult]
877
910
  def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
878
- get(path, options, "22.8.0") end
911
+ get(path, options, AvaTax::VERSION) end
879
912
 
880
913
  # Retrieve the full list of Avalara-supported usage of parameters used for returns.
881
914
  #
@@ -889,7 +922,7 @@ module AvaTax
889
922
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
890
923
  # @return [FetchResult]
891
924
  def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
892
- get(path, options, "22.8.0") end
925
+ get(path, options, AvaTax::VERSION) end
893
926
 
894
927
  # Retrieve the full list of Avalara-supported permissions
895
928
  #
@@ -903,7 +936,7 @@ module AvaTax
903
936
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
904
937
  # @return [FetchResult]
905
938
  def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
906
- get(path, options, "22.8.0") end
939
+ get(path, options, AvaTax::VERSION) end
907
940
 
908
941
  # Retrieve the full list of Avalara-supported subscription types
909
942
  #
@@ -912,13 +945,13 @@ module AvaTax
912
945
  # You may always contact Avalara's sales department for information on available products or services.
913
946
  # You cannot change your subscriptions directly through the API.
914
947
  # Swagger Name: AvaTaxClient
915
- # @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/).
948
+ # @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:* taxTypeGroupIdSK
916
949
  # @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.
917
950
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
918
951
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
919
952
  # @return [FetchResult]
920
953
  def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
921
- get(path, options, "22.8.0") end
954
+ get(path, options, AvaTax::VERSION) end
922
955
 
923
956
  # Retrieve the list all tags supported by avalara
924
957
  #
@@ -930,7 +963,7 @@ module AvaTax
930
963
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
931
964
  # @return [FetchResult]
932
965
  def list_tags(options={}) path = "/api/v2/definitions/tags"
933
- get(path, options, "22.8.0") end
966
+ get(path, options, AvaTax::VERSION) end
934
967
 
935
968
  # Retrieve the full list of Avalara-supported tax authorities.
936
969
  #
@@ -943,7 +976,7 @@ module AvaTax
943
976
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
944
977
  # @return [FetchResult]
945
978
  def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
946
- get(path, options, "22.8.0") end
979
+ get(path, options, AvaTax::VERSION) end
947
980
 
948
981
  # Retrieve the full list of Avalara-supported forms for each tax authority.
949
982
  #
@@ -958,7 +991,7 @@ module AvaTax
958
991
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
959
992
  # @return [FetchResult]
960
993
  def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
961
- get(path, options, "22.8.0") end
994
+ get(path, options, AvaTax::VERSION) end
962
995
 
963
996
  # Retrieve the full list of Avalara-supported tax authority types.
964
997
  #
@@ -971,7 +1004,7 @@ module AvaTax
971
1004
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
972
1005
  # @return [FetchResult]
973
1006
  def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
974
- get(path, options, "22.8.0") end
1007
+ get(path, options, AvaTax::VERSION) end
975
1008
 
976
1009
  # Retrieve the full list of Avalara-supported tax codes.
977
1010
  #
@@ -983,7 +1016,7 @@ module AvaTax
983
1016
  #
984
1017
  # ### Security Policies
985
1018
  #
986
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
1019
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
987
1020
  # Swagger Name: AvaTaxClient
988
1021
  # @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/).
989
1022
  # @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.
@@ -991,7 +1024,7 @@ module AvaTax
991
1024
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
992
1025
  # @return [FetchResult]
993
1026
  def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
994
- get(path, options, "22.8.0") end
1027
+ get(path, options, AvaTax::VERSION) end
995
1028
 
996
1029
  # Retrieve the full list of Avalara-supported tax code types.
997
1030
  #
@@ -1003,7 +1036,7 @@ module AvaTax
1003
1036
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
1004
1037
  # @return [Object]
1005
1038
  def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
1006
- get(path, options, "22.8.0") end
1039
+ get(path, options, AvaTax::VERSION) end
1007
1040
 
1008
1041
  # Retrieve the full list of the Tax Forms available
1009
1042
  #
@@ -1016,7 +1049,7 @@ module AvaTax
1016
1049
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1017
1050
  # @return [FetchResult]
1018
1051
  def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
1019
- get(path, options, "22.8.0") end
1052
+ get(path, options, AvaTax::VERSION) end
1020
1053
 
1021
1054
  # Retrieve the full list of tax sub types
1022
1055
  #
@@ -1029,7 +1062,7 @@ module AvaTax
1029
1062
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1030
1063
  # @return [FetchResult]
1031
1064
  def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
1032
- get(path, options, "22.8.0") end
1065
+ get(path, options, AvaTax::VERSION) end
1033
1066
 
1034
1067
  # Retrieve the full list of tax sub types by Country and TaxType
1035
1068
  #
@@ -1038,13 +1071,14 @@ module AvaTax
1038
1071
  # Swagger Name: AvaTaxClient
1039
1072
  # @param country [String] The country to examine for taxsubtype
1040
1073
  # @param taxTypeId [String] The taxType for the country to examine for taxsubtype
1074
+ # @param companyId [Integer] Id of the company the user wish to fetch the applicable tax sub types
1041
1075
  # @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/).
1042
1076
  # @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.
1043
1077
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
1044
1078
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1045
1079
  # @return [FetchResult]
1046
1080
  def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
1047
- get(path, options, "22.8.0") end
1081
+ get(path, options, AvaTax::VERSION) end
1048
1082
 
1049
1083
  # Retrieve the full list of tax sub types by jurisdiction code and region
1050
1084
  #
@@ -1059,7 +1093,7 @@ module AvaTax
1059
1093
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1060
1094
  # @return [FetchResult]
1061
1095
  def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
1062
- get(path, options, "22.8.0") end
1096
+ get(path, options, AvaTax::VERSION) end
1063
1097
 
1064
1098
  # Retrieve the full list of tax type groups
1065
1099
  #
@@ -1072,7 +1106,7 @@ module AvaTax
1072
1106
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1073
1107
  # @return [FetchResult]
1074
1108
  def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
1075
- get(path, options, "22.8.0") end
1109
+ get(path, options, AvaTax::VERSION) end
1076
1110
 
1077
1111
  # Retrieve the list of applicable TaxTypes
1078
1112
  #
@@ -1085,7 +1119,7 @@ module AvaTax
1085
1119
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1086
1120
  # @return [FetchResult]
1087
1121
  def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
1088
- get(path, options, "22.8.0") end
1122
+ get(path, options, AvaTax::VERSION) end
1089
1123
 
1090
1124
  # Retrieve the list of applicable UnitOfBasis
1091
1125
  #
@@ -1100,7 +1134,7 @@ module AvaTax
1100
1134
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1101
1135
  # @return [FetchResult]
1102
1136
  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}"
1103
- get(path, options, "22.8.0") end
1137
+ get(path, options, AvaTax::VERSION) end
1104
1138
 
1105
1139
  # List all defined units of measurement
1106
1140
  #
@@ -1114,7 +1148,7 @@ module AvaTax
1114
1148
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1115
1149
  # @return [FetchResult]
1116
1150
  def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
1117
- get(path, options, "22.8.0") end
1151
+ get(path, options, AvaTax::VERSION) end
1118
1152
  end
1119
1153
  end
1120
1154
  end