avatax 23.1.0 → 23.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.
- checksums.yaml +4 -4
- data/avatax.gemspec +1 -1
- data/lib/avatax/client/accounts.rb +17 -17
- data/lib/avatax/client/addresses.rb +2 -2
- data/lib/avatax/client/advancedrules.rb +5 -5
- data/lib/avatax/client/ageverification.rb +4 -4
- data/lib/avatax/client/avafileforms.rb +5 -5
- data/lib/avatax/client/batches.rb +8 -8
- data/lib/avatax/client/certexpressinvites.rb +3 -3
- data/lib/avatax/client/certificates.rb +15 -15
- data/lib/avatax/client/companies.rb +36 -36
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/contacts.rb +6 -6
- data/lib/avatax/client/customers.rb +13 -13
- data/lib/avatax/client/datasources.rb +9 -9
- data/lib/avatax/client/definitions.rb +82 -82
- data/lib/avatax/client/distancethresholds.rb +6 -6
- data/lib/avatax/client/ecommercetoken.rb +4 -4
- data/lib/avatax/client/firmclientlinkages.rb +11 -11
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +3 -3
- data/lib/avatax/client/items.rb +46 -46
- data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
- data/lib/avatax/client/locations.rb +18 -18
- data/lib/avatax/client/multidocument.rb +10 -10
- data/lib/avatax/client/nexus.rb +15 -15
- data/lib/avatax/client/notices.rb +4 -4
- data/lib/avatax/client/notifications.rb +6 -6
- data/lib/avatax/client/provisioning.rb +2 -2
- data/lib/avatax/client/registrar.rb +14 -14
- data/lib/avatax/client/reports.rb +4 -4
- data/lib/avatax/client/settings.rb +9 -9
- data/lib/avatax/client/shippingverification.rb +4 -4
- data/lib/avatax/client/subscriptions.rb +3 -3
- data/lib/avatax/client/taxcodes.rb +6 -6
- data/lib/avatax/client/taxcontent.rb +8 -8
- data/lib/avatax/client/taxrules.rb +6 -6
- data/lib/avatax/client/transactions.rb +24 -24
- data/lib/avatax/client/upcs.rb +6 -6
- data/lib/avatax/client/userdefinedfields.rb +4 -4
- data/lib/avatax/client/users.rb +12 -12
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/version.rb +1 -1
- data/spec/spec_helper.rb +1 -0
- metadata +4 -4
@@ -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, {},
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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, {},
|
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,
|
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,
|
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,
|
297
|
+
get(path, options, AvaTax::VERSION) 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,
|
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,
|
339
|
+
get(path, options, AvaTax::VERSION) end
|
340
340
|
|
341
341
|
# List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
|
342
342
|
#
|
@@ -360,7 +360,7 @@ module AvaTax
|
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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, {},
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,
|
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,7 +634,7 @@ 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,
|
637
|
+
get(path, options, AvaTax::VERSION) end
|
638
638
|
|
639
639
|
# Retrieve the full list of Avalara-supported tax notice statuses.
|
640
640
|
#
|
@@ -647,7 +647,7 @@ module AvaTax
|
|
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,
|
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,
|
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,7 @@ 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,
|
677
|
+
get(path, options, AvaTax::VERSION) end
|
678
678
|
|
679
679
|
# Retrieve the parameters by companyCode and itemCode.
|
680
680
|
#
|
@@ -705,7 +705,7 @@ module AvaTax
|
|
705
705
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
706
706
|
# @return [FetchResult]
|
707
707
|
def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
|
708
|
-
get(path, options,
|
708
|
+
get(path, options, AvaTax::VERSION) end
|
709
709
|
|
710
710
|
# Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
|
711
711
|
#
|
@@ -719,7 +719,7 @@ module AvaTax
|
|
719
719
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
720
720
|
# @return [FetchResult]
|
721
721
|
def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
|
722
|
-
get(path, options,
|
722
|
+
get(path, options, AvaTax::VERSION) end
|
723
723
|
|
724
724
|
# Retrieve the full list of Avalara-supported permissions
|
725
725
|
#
|
@@ -730,7 +730,7 @@ module AvaTax
|
|
730
730
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
731
731
|
# @return [FetchResult]
|
732
732
|
def list_permissions(options={}) path = "/api/v2/definitions/permissions"
|
733
|
-
get(path, options,
|
733
|
+
get(path, options, AvaTax::VERSION) end
|
734
734
|
|
735
735
|
# Retrieve the full list of Avalara-supported postal codes.
|
736
736
|
#
|
@@ -742,7 +742,7 @@ module AvaTax
|
|
742
742
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
743
743
|
# @return [FetchResult]
|
744
744
|
def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
|
745
|
-
get(path, options,
|
745
|
+
get(path, options, AvaTax::VERSION) end
|
746
746
|
|
747
747
|
# List all customs duty programs recognized by AvaTax
|
748
748
|
#
|
@@ -762,7 +762,7 @@ module AvaTax
|
|
762
762
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
763
763
|
# @return [FetchResult]
|
764
764
|
def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
|
765
|
-
get(path, options,
|
765
|
+
get(path, options, AvaTax::VERSION) end
|
766
766
|
|
767
767
|
# List all available product classification systems.
|
768
768
|
#
|
@@ -778,7 +778,7 @@ module AvaTax
|
|
778
778
|
# @param countryCode [String] If not null, return all records with this code.
|
779
779
|
# @return [FetchResult]
|
780
780
|
def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
|
781
|
-
get(path, options,
|
781
|
+
get(path, options, AvaTax::VERSION) end
|
782
782
|
|
783
783
|
# List all product classification systems available to a company based on its nexus.
|
784
784
|
#
|
@@ -803,7 +803,7 @@ module AvaTax
|
|
803
803
|
# @param countryCode [String] If not null, return all records with this code.
|
804
804
|
# @return [FetchResult]
|
805
805
|
def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
|
806
|
-
get(path, options,
|
806
|
+
get(path, options, AvaTax::VERSION) end
|
807
807
|
|
808
808
|
# Retrieve the full list of rate types for each country
|
809
809
|
#
|
@@ -817,7 +817,7 @@ module AvaTax
|
|
817
817
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
818
818
|
# @return [FetchResult]
|
819
819
|
def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
|
820
|
-
get(path, options,
|
820
|
+
get(path, options, AvaTax::VERSION) end
|
821
821
|
|
822
822
|
# Retrieve the list of rate types by country, TaxType and by TaxSubType
|
823
823
|
#
|
@@ -833,7 +833,7 @@ module AvaTax
|
|
833
833
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
834
834
|
# @return [FetchResult]
|
835
835
|
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,
|
836
|
+
get(path, options, AvaTax::VERSION) end
|
837
837
|
|
838
838
|
# List all ISO 3166 regions
|
839
839
|
#
|
@@ -847,7 +847,7 @@ module AvaTax
|
|
847
847
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
848
848
|
# @return [FetchResult]
|
849
849
|
def list_regions(options={}) path = "/api/v2/definitions/regions"
|
850
|
-
get(path, options,
|
850
|
+
get(path, options, AvaTax::VERSION) end
|
851
851
|
|
852
852
|
# List all ISO 3166 regions for a country
|
853
853
|
#
|
@@ -862,26 +862,26 @@ module AvaTax
|
|
862
862
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
863
863
|
# @return [FetchResult]
|
864
864
|
def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
|
865
|
-
get(path, options,
|
865
|
+
get(path, options, AvaTax::VERSION) end
|
866
866
|
|
867
|
-
# Retrieve the list of applicable
|
867
|
+
# Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeId
|
868
868
|
#
|
869
|
-
# Returns a list of all ISO 3166 region codes for a specific country code
|
870
|
-
# This API is intended to be
|
871
|
-
# within the country for
|
869
|
+
# Returns a list of all ISO 3166 region codes for a specific country code and their US English friendly names.
|
870
|
+
# 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
|
871
|
+
# within the country for shipping addresses.
|
872
872
|
# Swagger Name: AvaTaxClient
|
873
|
-
# @param companyId [Integer]
|
874
|
-
# @param country [String] The country for which you want to retrieve the regions
|
875
|
-
# @param taxTypeId [String] The
|
876
|
-
# @param taxSubTypeId [String] The
|
877
|
-
# @param rateTypeId [Integer] The
|
878
|
-
# @param jurisdictionTypeId [String] The JurisdictionTypeId for which you want to retrieve the regions
|
873
|
+
# @param companyId [Integer] The ID of the company for which you want to retrieve the applicable regions
|
874
|
+
# @param country [String] The country for which you want to retrieve the regions
|
875
|
+
# @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.
|
876
|
+
# @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.
|
877
|
+
# @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."
|
878
|
+
# @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).
|
879
879
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
880
880
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
881
881
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
882
882
|
# @return [FetchResult]
|
883
883
|
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}"
|
884
|
-
get(path, options,
|
884
|
+
get(path, options, AvaTax::VERSION) end
|
885
885
|
|
886
886
|
# Retrieve the full list of Avalara-supported resource file types
|
887
887
|
#
|
@@ -894,7 +894,7 @@ module AvaTax
|
|
894
894
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
895
895
|
# @return [FetchResult]
|
896
896
|
def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
|
897
|
-
get(path, options,
|
897
|
+
get(path, options, AvaTax::VERSION) end
|
898
898
|
|
899
899
|
# Retrieve the full list of Avalara-supported usage of parameters used for returns.
|
900
900
|
#
|
@@ -908,7 +908,7 @@ module AvaTax
|
|
908
908
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
909
909
|
# @return [FetchResult]
|
910
910
|
def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
|
911
|
-
get(path, options,
|
911
|
+
get(path, options, AvaTax::VERSION) end
|
912
912
|
|
913
913
|
# Retrieve the full list of Avalara-supported permissions
|
914
914
|
#
|
@@ -922,7 +922,7 @@ module AvaTax
|
|
922
922
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
923
923
|
# @return [FetchResult]
|
924
924
|
def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
|
925
|
-
get(path, options,
|
925
|
+
get(path, options, AvaTax::VERSION) end
|
926
926
|
|
927
927
|
# Retrieve the full list of Avalara-supported subscription types
|
928
928
|
#
|
@@ -937,7 +937,7 @@ module AvaTax
|
|
937
937
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
938
938
|
# @return [FetchResult]
|
939
939
|
def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
|
940
|
-
get(path, options,
|
940
|
+
get(path, options, AvaTax::VERSION) end
|
941
941
|
|
942
942
|
# Retrieve the list all tags supported by avalara
|
943
943
|
#
|
@@ -949,7 +949,7 @@ module AvaTax
|
|
949
949
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
950
950
|
# @return [FetchResult]
|
951
951
|
def list_tags(options={}) path = "/api/v2/definitions/tags"
|
952
|
-
get(path, options,
|
952
|
+
get(path, options, AvaTax::VERSION) end
|
953
953
|
|
954
954
|
# Retrieve the full list of Avalara-supported tax authorities.
|
955
955
|
#
|
@@ -962,7 +962,7 @@ module AvaTax
|
|
962
962
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
963
963
|
# @return [FetchResult]
|
964
964
|
def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
|
965
|
-
get(path, options,
|
965
|
+
get(path, options, AvaTax::VERSION) end
|
966
966
|
|
967
967
|
# Retrieve the full list of Avalara-supported forms for each tax authority.
|
968
968
|
#
|
@@ -977,7 +977,7 @@ module AvaTax
|
|
977
977
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
978
978
|
# @return [FetchResult]
|
979
979
|
def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
|
980
|
-
get(path, options,
|
980
|
+
get(path, options, AvaTax::VERSION) end
|
981
981
|
|
982
982
|
# Retrieve the full list of Avalara-supported tax authority types.
|
983
983
|
#
|
@@ -990,7 +990,7 @@ module AvaTax
|
|
990
990
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
991
991
|
# @return [FetchResult]
|
992
992
|
def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
|
993
|
-
get(path, options,
|
993
|
+
get(path, options, AvaTax::VERSION) end
|
994
994
|
|
995
995
|
# Retrieve the full list of Avalara-supported tax codes.
|
996
996
|
#
|
@@ -1010,7 +1010,7 @@ module AvaTax
|
|
1010
1010
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1011
1011
|
# @return [FetchResult]
|
1012
1012
|
def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
|
1013
|
-
get(path, options,
|
1013
|
+
get(path, options, AvaTax::VERSION) end
|
1014
1014
|
|
1015
1015
|
# Retrieve the full list of Avalara-supported tax code types.
|
1016
1016
|
#
|
@@ -1022,7 +1022,7 @@ module AvaTax
|
|
1022
1022
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1023
1023
|
# @return [Object]
|
1024
1024
|
def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
|
1025
|
-
get(path, options,
|
1025
|
+
get(path, options, AvaTax::VERSION) end
|
1026
1026
|
|
1027
1027
|
# Retrieve the full list of the Tax Forms available
|
1028
1028
|
#
|
@@ -1035,7 +1035,7 @@ module AvaTax
|
|
1035
1035
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1036
1036
|
# @return [FetchResult]
|
1037
1037
|
def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
|
1038
|
-
get(path, options,
|
1038
|
+
get(path, options, AvaTax::VERSION) end
|
1039
1039
|
|
1040
1040
|
# Retrieve the full list of tax sub types
|
1041
1041
|
#
|
@@ -1048,7 +1048,7 @@ module AvaTax
|
|
1048
1048
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1049
1049
|
# @return [FetchResult]
|
1050
1050
|
def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
|
1051
|
-
get(path, options,
|
1051
|
+
get(path, options, AvaTax::VERSION) end
|
1052
1052
|
|
1053
1053
|
# Retrieve the full list of tax sub types by Country and TaxType
|
1054
1054
|
#
|
@@ -1064,7 +1064,7 @@ module AvaTax
|
|
1064
1064
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1065
1065
|
# @return [FetchResult]
|
1066
1066
|
def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
|
1067
|
-
get(path, options,
|
1067
|
+
get(path, options, AvaTax::VERSION) end
|
1068
1068
|
|
1069
1069
|
# Retrieve the full list of tax sub types by jurisdiction code and region
|
1070
1070
|
#
|
@@ -1079,7 +1079,7 @@ module AvaTax
|
|
1079
1079
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1080
1080
|
# @return [FetchResult]
|
1081
1081
|
def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
|
1082
|
-
get(path, options,
|
1082
|
+
get(path, options, AvaTax::VERSION) end
|
1083
1083
|
|
1084
1084
|
# Retrieve the full list of tax type groups
|
1085
1085
|
#
|
@@ -1092,7 +1092,7 @@ module AvaTax
|
|
1092
1092
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1093
1093
|
# @return [FetchResult]
|
1094
1094
|
def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
|
1095
|
-
get(path, options,
|
1095
|
+
get(path, options, AvaTax::VERSION) end
|
1096
1096
|
|
1097
1097
|
# Retrieve the list of applicable TaxTypes
|
1098
1098
|
#
|
@@ -1105,7 +1105,7 @@ module AvaTax
|
|
1105
1105
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1106
1106
|
# @return [FetchResult]
|
1107
1107
|
def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
|
1108
|
-
get(path, options,
|
1108
|
+
get(path, options, AvaTax::VERSION) end
|
1109
1109
|
|
1110
1110
|
# Retrieve the list of applicable UnitOfBasis
|
1111
1111
|
#
|
@@ -1120,7 +1120,7 @@ module AvaTax
|
|
1120
1120
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1121
1121
|
# @return [FetchResult]
|
1122
1122
|
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}"
|
1123
|
-
get(path, options,
|
1123
|
+
get(path, options, AvaTax::VERSION) end
|
1124
1124
|
|
1125
1125
|
# List all defined units of measurement
|
1126
1126
|
#
|
@@ -1134,7 +1134,7 @@ module AvaTax
|
|
1134
1134
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1135
1135
|
# @return [FetchResult]
|
1136
1136
|
def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
|
1137
|
-
get(path, options,
|
1137
|
+
get(path, options, AvaTax::VERSION) end
|
1138
1138
|
end
|
1139
1139
|
end
|
1140
1140
|
end
|