avatax 22.2.1 → 22.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +11 -11
  3. data/lib/avatax/client/addresses.rb +2 -2
  4. data/lib/avatax/client/advancedrules.rb +5 -5
  5. data/lib/avatax/client/avafileforms.rb +5 -5
  6. data/lib/avatax/client/batches.rb +8 -8
  7. data/lib/avatax/client/certexpressinvites.rb +3 -3
  8. data/lib/avatax/client/certificates.rb +15 -15
  9. data/lib/avatax/client/companies.rb +22 -22
  10. data/lib/avatax/client/compliance.rb +1 -1
  11. data/lib/avatax/client/contacts.rb +6 -6
  12. data/lib/avatax/client/customers.rb +13 -13
  13. data/lib/avatax/client/datasources.rb +6 -6
  14. data/lib/avatax/client/definitions.rb +75 -72
  15. data/lib/avatax/client/distancethresholds.rb +6 -6
  16. data/lib/avatax/client/ecommercetoken.rb +2 -2
  17. data/lib/avatax/client/filingcalendars.rb +3 -3
  18. data/lib/avatax/client/filings.rb +2 -2
  19. data/lib/avatax/client/firmclientlinkages.rb +9 -9
  20. data/lib/avatax/client/free.rb +1 -1
  21. data/lib/avatax/client/fundingrequests.rb +2 -2
  22. data/lib/avatax/client/items.rb +165 -28
  23. data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
  24. data/lib/avatax/client/locations.rb +12 -12
  25. data/lib/avatax/client/multidocument.rb +10 -10
  26. data/lib/avatax/client/nexus.rb +15 -15
  27. data/lib/avatax/client/notices.rb +4 -4
  28. data/lib/avatax/client/notifications.rb +3 -3
  29. data/lib/avatax/client/provisioning.rb +2 -2
  30. data/lib/avatax/client/registrar.rb +10 -21
  31. data/lib/avatax/client/reports.rb +4 -4
  32. data/lib/avatax/client/settings.rb +6 -6
  33. data/lib/avatax/client/shippingverification.rb +25 -9
  34. data/lib/avatax/client/subscriptions.rb +3 -3
  35. data/lib/avatax/client/taxcodes.rb +6 -6
  36. data/lib/avatax/client/taxcontent.rb +5 -5
  37. data/lib/avatax/client/taxrules.rb +6 -6
  38. data/lib/avatax/client/transactions.rb +21 -21
  39. data/lib/avatax/client/upcs.rb +6 -6
  40. data/lib/avatax/client/userdefinedfields.rb +3 -3
  41. data/lib/avatax/client/users.rb +8 -8
  42. data/lib/avatax/client/utilities.rb +3 -3
  43. data/lib/avatax/request.rb +10 -9
  44. data/lib/avatax/version.rb +1 -1
  45. metadata +2 -2
@@ -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.2.1") end
27
+ get(path, {}, "22.3.0") 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.2.1") end
41
+ get(path, options, "22.3.0") 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.2.1") end
53
+ get(path, options, "22.3.0") 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.2.1") end
70
+ get(path, options, "22.3.0") 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.2.1") end
89
+ get(path, options, "22.3.0") 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.2.1") end
107
+ get(path, options, "22.3.0") 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.2.1") end
125
+ get(path, options, "22.3.0") 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.2.1") end
139
+ get(path, options, "22.3.0") 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.2.1") end
152
+ get(path, options, "22.3.0") 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.2.1") end
165
+ get(path, options, "22.3.0") 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.2.1") end
178
+ get(path, options, "22.3.0") 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.2.1") end
192
+ get(path, options, "22.3.0") 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.2.1") end
211
+ get(path, options, "22.3.0") 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.2.1") end
236
+ get(path, options, "22.3.0") 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.2.1") end
253
+ get(path, {}, "22.3.0") 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.2.1") end
268
+ get(path, options, "22.3.0") 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.2.1") end
284
+ get(path, options, "22.3.0") 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.2.1") end
297
+ get(path, options, "22.3.0") end
298
298
 
299
299
  # List jurisdictions based on the filter provided
300
300
  #
@@ -311,7 +311,7 @@ module AvaTax
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.2.1") end
314
+ get(path, options, "22.3.0") 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.2.1") end
339
+ get(path, options, "22.3.0") end
340
340
 
341
341
  # List jurisdictions based on the TaxType, TaxSubType and RateType provided
342
342
  #
@@ -348,7 +348,6 @@ module AvaTax
348
348
  # The jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API.
349
349
  # Swagger Name: AvaTaxClient
350
350
  # @param country [String] The country for which you want to retrieve the jurisdiction information
351
- # @param region [String] The region for which you want to retrieve the jurisdiction information
352
351
  # @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
353
352
  # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
354
353
  # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
@@ -357,8 +356,8 @@ module AvaTax
357
356
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
358
357
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
359
358
  # @return [FetchResult]
360
- def list_jurisdictions_by_rate_type_tax_type_mapping(country, region, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/regions/#{region}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
361
- get(path, options, "22.2.1") end
359
+ def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
360
+ get(path, options, "22.3.0") end
362
361
 
363
362
  # Retrieve the list of questions that are required for a tax location
364
363
  #
@@ -384,7 +383,7 @@ module AvaTax
384
383
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
385
384
  # @return [FetchResult]
386
385
  def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
387
- get(path, options, "22.2.1") end
386
+ get(path, options, "22.3.0") end
388
387
 
389
388
  # List all forms where logins can be verified automatically
390
389
  #
@@ -398,7 +397,7 @@ module AvaTax
398
397
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
399
398
  # @return [FetchResult]
400
399
  def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
401
- get(path, options, "22.2.1") end
400
+ get(path, options, "22.3.0") end
402
401
 
403
402
  # Retrieve the list of locations for a marketplace.
404
403
  #
@@ -410,7 +409,7 @@ module AvaTax
410
409
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
411
410
  # @return [FetchResult]
412
411
  def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
413
- get(path, options, "22.2.1") end
412
+ get(path, options, "22.3.0") end
414
413
 
415
414
  # Retrieve the full list of Avalara-supported nexus for all countries and regions.
416
415
  #
@@ -424,7 +423,7 @@ module AvaTax
424
423
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
425
424
  # @return [FetchResult]
426
425
  def list_nexus(options={}) path = "/api/v2/definitions/nexus"
427
- get(path, options, "22.2.1") end
426
+ get(path, options, "22.3.0") end
428
427
 
429
428
  # List all nexus that apply to a specific address.
430
429
  #
@@ -447,7 +446,7 @@ module AvaTax
447
446
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
448
447
  # @return [FetchResult]
449
448
  def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
450
- get(path, options, "22.2.1") end
449
+ get(path, options, "22.3.0") end
451
450
 
452
451
  # Retrieve the full list of Avalara-supported nexus for a country.
453
452
  #
@@ -462,7 +461,7 @@ module AvaTax
462
461
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
463
462
  # @return [FetchResult]
464
463
  def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
465
- get(path, options, "22.2.1") end
464
+ get(path, options, "22.3.0") end
466
465
 
467
466
  # Retrieve the full list of Avalara-supported nexus for a country and region.
468
467
  #
@@ -478,7 +477,7 @@ module AvaTax
478
477
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
479
478
  # @return [FetchResult]
480
479
  def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
481
- get(path, options, "22.2.1") end
480
+ get(path, options, "22.3.0") end
482
481
 
483
482
  # List nexus related to a tax form
484
483
  #
@@ -501,7 +500,7 @@ module AvaTax
501
500
  # @param formCode [String] The form code that we are looking up the nexus for
502
501
  # @return [Object]
503
502
  def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
504
- get(path, {}, "22.2.1") end
503
+ get(path, {}, "22.3.0") end
505
504
 
506
505
  # Retrieve the full list of Avalara-supported nexus for a tax type group.
507
506
  #
@@ -516,7 +515,7 @@ module AvaTax
516
515
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
517
516
  # @return [FetchResult]
518
517
  def list_nexus_by_tax_type_group(taxTypeGroup, options={}) path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
519
- get(path, options, "22.2.1") end
518
+ get(path, options, "22.3.0") end
520
519
 
521
520
  # Retrieve the full list of nexus tax type groups
522
521
  #
@@ -529,7 +528,7 @@ module AvaTax
529
528
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
530
529
  # @return [FetchResult]
531
530
  def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
532
- get(path, options, "22.2.1") end
531
+ get(path, options, "22.3.0") end
533
532
 
534
533
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
535
534
  #
@@ -542,7 +541,7 @@ module AvaTax
542
541
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
543
542
  # @return [FetchResult]
544
543
  def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
545
- get(path, options, "22.2.1") end
544
+ get(path, options, "22.3.0") end
546
545
 
547
546
  # Retrieve the full list of Avalara-supported tax notice customer types.
548
547
  #
@@ -555,7 +554,7 @@ module AvaTax
555
554
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
556
555
  # @return [FetchResult]
557
556
  def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
558
- get(path, options, "22.2.1") end
557
+ get(path, options, "22.3.0") end
559
558
 
560
559
  # Retrieve the full list of Avalara-supported tax notice filing types.
561
560
  #
@@ -568,7 +567,7 @@ module AvaTax
568
567
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
569
568
  # @return [FetchResult]
570
569
  def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
571
- get(path, options, "22.2.1") end
570
+ get(path, options, "22.3.0") end
572
571
 
573
572
  # Retrieve the full list of Avalara-supported tax notice priorities.
574
573
  #
@@ -581,7 +580,7 @@ module AvaTax
581
580
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
582
581
  # @return [FetchResult]
583
582
  def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
584
- get(path, options, "22.2.1") end
583
+ get(path, options, "22.3.0") end
585
584
 
586
585
  # Retrieve the full list of Avalara-supported tax notice reasons.
587
586
  #
@@ -594,7 +593,7 @@ module AvaTax
594
593
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
595
594
  # @return [FetchResult]
596
595
  def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
597
- get(path, options, "22.2.1") end
596
+ get(path, options, "22.3.0") end
598
597
 
599
598
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
600
599
  #
@@ -607,7 +606,7 @@ module AvaTax
607
606
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
608
607
  # @return [FetchResult]
609
608
  def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
610
- get(path, options, "22.2.1") end
609
+ get(path, options, "22.3.0") end
611
610
 
612
611
  # Retrieve the full list of Avalara-supported tax notice root causes
613
612
  #
@@ -620,7 +619,7 @@ module AvaTax
620
619
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
621
620
  # @return [FetchResult]
622
621
  def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
623
- get(path, options, "22.2.1") end
622
+ get(path, options, "22.3.0") end
624
623
 
625
624
  # Retrieve the full list of Avalara-supported tax notice statuses.
626
625
  #
@@ -633,7 +632,7 @@ module AvaTax
633
632
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
634
633
  # @return [FetchResult]
635
634
  def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
636
- get(path, options, "22.2.1") end
635
+ get(path, options, "22.3.0") end
637
636
 
638
637
  # Retrieve the full list of Avalara-supported tax notice types.
639
638
  #
@@ -646,7 +645,7 @@ module AvaTax
646
645
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
647
646
  # @return [FetchResult]
648
647
  def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
649
- get(path, options, "22.2.1") end
648
+ get(path, options, "22.3.0") end
650
649
 
651
650
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
652
651
  #
@@ -660,7 +659,7 @@ module AvaTax
660
659
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
661
660
  # @return [FetchResult]
662
661
  def list_parameters(options={}) path = "/api/v2/definitions/parameters"
663
- get(path, options, "22.2.1") end
662
+ get(path, options, "22.3.0") end
664
663
 
665
664
  # Retrieve the parameters by companyCode and itemCode.
666
665
  #
@@ -675,6 +674,10 @@ module AvaTax
675
674
  # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
676
675
  # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
677
676
  #
677
+ # For Item Code other than the five given above below two should also be used
678
+ # * Replace ''' with '\_-ava27-\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'
679
+ # * Replace '"' with '\_-ava22-\_' For example: 'Item"Code' becomes 'Item_-ava22-_Code'
680
+ #
678
681
  # ### Security Policies
679
682
  #
680
683
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -687,7 +690,7 @@ module AvaTax
687
690
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
688
691
  # @return [FetchResult]
689
692
  def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
690
- get(path, options, "22.2.1") end
693
+ get(path, options, "22.3.0") end
691
694
 
692
695
  # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
693
696
  #
@@ -701,7 +704,7 @@ module AvaTax
701
704
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
702
705
  # @return [FetchResult]
703
706
  def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
704
- get(path, options, "22.2.1") end
707
+ get(path, options, "22.3.0") end
705
708
 
706
709
  # Retrieve the full list of Avalara-supported permissions
707
710
  #
@@ -712,7 +715,7 @@ module AvaTax
712
715
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
713
716
  # @return [FetchResult]
714
717
  def list_permissions(options={}) path = "/api/v2/definitions/permissions"
715
- get(path, options, "22.2.1") end
718
+ get(path, options, "22.3.0") end
716
719
 
717
720
  # Retrieve the full list of Avalara-supported postal codes.
718
721
  #
@@ -724,7 +727,7 @@ module AvaTax
724
727
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
725
728
  # @return [FetchResult]
726
729
  def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
727
- get(path, options, "22.2.1") end
730
+ get(path, options, "22.3.0") end
728
731
 
729
732
  # List all customs duty programs recognized by AvaTax
730
733
  #
@@ -744,7 +747,7 @@ module AvaTax
744
747
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
745
748
  # @return [FetchResult]
746
749
  def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
747
- get(path, options, "22.2.1") end
750
+ get(path, options, "22.3.0") end
748
751
 
749
752
  # List all available product classification systems.
750
753
  #
@@ -760,7 +763,7 @@ module AvaTax
760
763
  # @param countryCode [String] If not null, return all records with this code.
761
764
  # @return [FetchResult]
762
765
  def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
763
- get(path, options, "22.2.1") end
766
+ get(path, options, "22.3.0") end
764
767
 
765
768
  # List all product classification systems available to a company based on its nexus.
766
769
  #
@@ -785,7 +788,7 @@ module AvaTax
785
788
  # @param countryCode [String] If not null, return all records with this code.
786
789
  # @return [FetchResult]
787
790
  def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
788
- get(path, options, "22.2.1") end
791
+ get(path, options, "22.3.0") end
789
792
 
790
793
  # Retrieve the full list of rate types for each country
791
794
  #
@@ -799,7 +802,7 @@ module AvaTax
799
802
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
800
803
  # @return [FetchResult]
801
804
  def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
802
- get(path, options, "22.2.1") end
805
+ get(path, options, "22.3.0") end
803
806
 
804
807
  # Retrieve the list of rate types by country, TaxType and by TaxSubType
805
808
  #
@@ -815,7 +818,7 @@ module AvaTax
815
818
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
816
819
  # @return [FetchResult]
817
820
  def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
818
- get(path, options, "22.2.1") end
821
+ get(path, options, "22.3.0") end
819
822
 
820
823
  # List all ISO 3166 regions
821
824
  #
@@ -829,7 +832,7 @@ module AvaTax
829
832
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
830
833
  # @return [FetchResult]
831
834
  def list_regions(options={}) path = "/api/v2/definitions/regions"
832
- get(path, options, "22.2.1") end
835
+ get(path, options, "22.3.0") end
833
836
 
834
837
  # List all ISO 3166 regions for a country
835
838
  #
@@ -844,7 +847,7 @@ module AvaTax
844
847
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
845
848
  # @return [FetchResult]
846
849
  def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
847
- get(path, options, "22.2.1") end
850
+ get(path, options, "22.3.0") end
848
851
 
849
852
  # Retrieve the full list of Avalara-supported resource file types
850
853
  #
@@ -857,7 +860,7 @@ module AvaTax
857
860
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
858
861
  # @return [FetchResult]
859
862
  def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
860
- get(path, options, "22.2.1") end
863
+ get(path, options, "22.3.0") end
861
864
 
862
865
  # Retrieve the full list of Avalara-supported usage of parameters used for returns.
863
866
  #
@@ -871,7 +874,7 @@ module AvaTax
871
874
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
872
875
  # @return [FetchResult]
873
876
  def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
874
- get(path, options, "22.2.1") end
877
+ get(path, options, "22.3.0") end
875
878
 
876
879
  # Retrieve the full list of Avalara-supported permissions
877
880
  #
@@ -885,7 +888,7 @@ module AvaTax
885
888
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
886
889
  # @return [FetchResult]
887
890
  def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
888
- get(path, options, "22.2.1") end
891
+ get(path, options, "22.3.0") end
889
892
 
890
893
  # Retrieve the full list of Avalara-supported subscription types
891
894
  #
@@ -900,7 +903,7 @@ module AvaTax
900
903
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
901
904
  # @return [FetchResult]
902
905
  def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
903
- get(path, options, "22.2.1") end
906
+ get(path, options, "22.3.0") end
904
907
 
905
908
  # Retrieve the list all tags supported by avalara
906
909
  #
@@ -912,7 +915,7 @@ module AvaTax
912
915
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
913
916
  # @return [FetchResult]
914
917
  def list_tags(options={}) path = "/api/v2/definitions/tags"
915
- get(path, options, "22.2.1") end
918
+ get(path, options, "22.3.0") end
916
919
 
917
920
  # Retrieve the full list of Avalara-supported tax authorities.
918
921
  #
@@ -925,7 +928,7 @@ module AvaTax
925
928
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
926
929
  # @return [FetchResult]
927
930
  def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
928
- get(path, options, "22.2.1") end
931
+ get(path, options, "22.3.0") end
929
932
 
930
933
  # Retrieve the full list of Avalara-supported forms for each tax authority.
931
934
  #
@@ -940,7 +943,7 @@ module AvaTax
940
943
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
941
944
  # @return [FetchResult]
942
945
  def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
943
- get(path, options, "22.2.1") end
946
+ get(path, options, "22.3.0") end
944
947
 
945
948
  # Retrieve the full list of Avalara-supported tax authority types.
946
949
  #
@@ -953,7 +956,7 @@ module AvaTax
953
956
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
954
957
  # @return [FetchResult]
955
958
  def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
956
- get(path, options, "22.2.1") end
959
+ get(path, options, "22.3.0") end
957
960
 
958
961
  # Retrieve the full list of Avalara-supported tax codes.
959
962
  #
@@ -973,7 +976,7 @@ module AvaTax
973
976
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
974
977
  # @return [FetchResult]
975
978
  def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
976
- get(path, options, "22.2.1") end
979
+ get(path, options, "22.3.0") end
977
980
 
978
981
  # Retrieve the full list of Avalara-supported tax code types.
979
982
  #
@@ -985,7 +988,7 @@ module AvaTax
985
988
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
986
989
  # @return [Object]
987
990
  def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
988
- get(path, options, "22.2.1") end
991
+ get(path, options, "22.3.0") end
989
992
 
990
993
  # Retrieve the full list of the Tax Forms available
991
994
  #
@@ -998,7 +1001,7 @@ module AvaTax
998
1001
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
999
1002
  # @return [FetchResult]
1000
1003
  def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
1001
- get(path, options, "22.2.1") end
1004
+ get(path, options, "22.3.0") end
1002
1005
 
1003
1006
  # Retrieve the full list of tax sub types
1004
1007
  #
@@ -1011,7 +1014,7 @@ module AvaTax
1011
1014
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1012
1015
  # @return [FetchResult]
1013
1016
  def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
1014
- get(path, options, "22.2.1") end
1017
+ get(path, options, "22.3.0") end
1015
1018
 
1016
1019
  # Retrieve the full list of tax sub types by Country and TaxType
1017
1020
  #
@@ -1026,7 +1029,7 @@ module AvaTax
1026
1029
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1027
1030
  # @return [FetchResult]
1028
1031
  def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
1029
- get(path, options, "22.2.1") end
1032
+ get(path, options, "22.3.0") end
1030
1033
 
1031
1034
  # Retrieve the full list of tax sub types by jurisdiction code and region
1032
1035
  #
@@ -1041,7 +1044,7 @@ module AvaTax
1041
1044
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1042
1045
  # @return [FetchResult]
1043
1046
  def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
1044
- get(path, options, "22.2.1") end
1047
+ get(path, options, "22.3.0") end
1045
1048
 
1046
1049
  # Retrieve the full list of tax type groups
1047
1050
  #
@@ -1054,7 +1057,7 @@ module AvaTax
1054
1057
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1055
1058
  # @return [FetchResult]
1056
1059
  def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
1057
- get(path, options, "22.2.1") end
1060
+ get(path, options, "22.3.0") end
1058
1061
 
1059
1062
  # Retrieve the list of applicable TaxTypes
1060
1063
  #
@@ -1067,7 +1070,7 @@ module AvaTax
1067
1070
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1068
1071
  # @return [FetchResult]
1069
1072
  def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
1070
- get(path, options, "22.2.1") end
1073
+ get(path, options, "22.3.0") end
1071
1074
 
1072
1075
  # Retrieve the list of applicable UnitOfBasis
1073
1076
  #
@@ -1082,7 +1085,7 @@ module AvaTax
1082
1085
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1083
1086
  # @return [FetchResult]
1084
1087
  def list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/unitofbasis/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
1085
- get(path, options, "22.2.1") end
1088
+ get(path, options, "22.3.0") end
1086
1089
 
1087
1090
  # List all defined units of measurement
1088
1091
  #
@@ -1096,7 +1099,7 @@ module AvaTax
1096
1099
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1097
1100
  # @return [FetchResult]
1098
1101
  def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
1099
- get(path, options, "22.2.1") end
1102
+ get(path, options, "22.3.0") end
1100
1103
  end
1101
1104
  end
1102
1105
  end