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.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +11 -11
- data/lib/avatax/client/addresses.rb +2 -2
- data/lib/avatax/client/advancedrules.rb +5 -5
- 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 +22 -22
- 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 +6 -6
- data/lib/avatax/client/definitions.rb +75 -72
- data/lib/avatax/client/distancethresholds.rb +6 -6
- data/lib/avatax/client/ecommercetoken.rb +2 -2
- data/lib/avatax/client/filingcalendars.rb +3 -3
- data/lib/avatax/client/filings.rb +2 -2
- data/lib/avatax/client/firmclientlinkages.rb +9 -9
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +2 -2
- data/lib/avatax/client/items.rb +165 -28
- data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
- data/lib/avatax/client/locations.rb +12 -12
- 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 +3 -3
- data/lib/avatax/client/provisioning.rb +2 -2
- data/lib/avatax/client/registrar.rb +10 -21
- data/lib/avatax/client/reports.rb +4 -4
- data/lib/avatax/client/settings.rb +6 -6
- data/lib/avatax/client/shippingverification.rb +25 -9
- data/lib/avatax/client/subscriptions.rb +3 -3
- data/lib/avatax/client/taxcodes.rb +6 -6
- data/lib/avatax/client/taxcontent.rb +5 -5
- data/lib/avatax/client/taxrules.rb +6 -6
- data/lib/avatax/client/transactions.rb +21 -21
- data/lib/avatax/client/upcs.rb +6 -6
- data/lib/avatax/client/userdefinedfields.rb +3 -3
- data/lib/avatax/client/users.rb +8 -8
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/request.rb +10 -9
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
@@ -20,7 +20,7 @@ module AvaTax
|
|
20
20
|
# @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
|
21
21
|
# @return [JurisdictionOverrideModel[]]
|
22
22
|
def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
23
|
-
post(path, model, {}, "22.
|
23
|
+
post(path, model, {}, "22.3.0") end
|
24
24
|
|
25
25
|
# Delete a single override
|
26
26
|
#
|
@@ -34,7 +34,7 @@ module AvaTax
|
|
34
34
|
# @param id [Integer] The ID of the override you wish to delete
|
35
35
|
# @return [ErrorDetail[]]
|
36
36
|
def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
37
|
-
delete(path, {}, "22.
|
37
|
+
delete(path, {}, "22.3.0") end
|
38
38
|
|
39
39
|
# Retrieve a single override
|
40
40
|
#
|
@@ -53,7 +53,7 @@ module AvaTax
|
|
53
53
|
# @param id [Integer] The primary key of this override
|
54
54
|
# @return [Object]
|
55
55
|
def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
56
|
-
get(path, {}, "22.
|
56
|
+
get(path, {}, "22.3.0") end
|
57
57
|
|
58
58
|
# Retrieve overrides for this account
|
59
59
|
#
|
@@ -79,7 +79,7 @@ module AvaTax
|
|
79
79
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
80
80
|
# @return [FetchResult]
|
81
81
|
def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
82
|
-
get(path, options, "22.
|
82
|
+
get(path, options, "22.3.0") end
|
83
83
|
|
84
84
|
# Retrieve all overrides
|
85
85
|
#
|
@@ -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 query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
|
107
|
-
get(path, options, "22.
|
107
|
+
get(path, options, "22.3.0") end
|
108
108
|
|
109
109
|
# Update a single jurisdictionoverride
|
110
110
|
#
|
@@ -119,7 +119,7 @@ module AvaTax
|
|
119
119
|
# @param model [Object] The jurisdictionoverride object you wish to update.
|
120
120
|
# @return [Object]
|
121
121
|
def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
122
|
-
put(path, model, {}, "22.
|
122
|
+
put(path, model, {}, "22.3.0") end
|
123
123
|
end
|
124
124
|
end
|
125
125
|
end
|
@@ -26,7 +26,7 @@ module AvaTax
|
|
26
26
|
# @param model [LocationParameterModel[]] The location parameters you wish to create.
|
27
27
|
# @return [LocationParameterModel[]]
|
28
28
|
def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
29
|
-
post(path, model, {}, "22.
|
29
|
+
post(path, model, {}, "22.3.0") end
|
30
30
|
|
31
31
|
# Create a new location
|
32
32
|
#
|
@@ -40,7 +40,7 @@ module AvaTax
|
|
40
40
|
# @param model [LocationModel[]] The location you wish to create.
|
41
41
|
# @return [LocationModel[]]
|
42
42
|
def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
|
43
|
-
post(path, model, {}, "22.
|
43
|
+
post(path, model, {}, "22.3.0") end
|
44
44
|
|
45
45
|
# Delete a single location
|
46
46
|
#
|
@@ -54,7 +54,7 @@ module AvaTax
|
|
54
54
|
# @param id [Integer] The ID of the location you wish to delete.
|
55
55
|
# @return [ErrorDetail[]]
|
56
56
|
def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
57
|
-
delete(path, {}, "22.
|
57
|
+
delete(path, {}, "22.3.0") end
|
58
58
|
|
59
59
|
# Delete a single location parameter
|
60
60
|
#
|
@@ -75,7 +75,7 @@ module AvaTax
|
|
75
75
|
# @param id [Integer] The parameter id
|
76
76
|
# @return [ErrorDetail[]]
|
77
77
|
def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
78
|
-
delete(path, {}, "22.
|
78
|
+
delete(path, {}, "22.3.0") end
|
79
79
|
|
80
80
|
# Retrieve a single location
|
81
81
|
#
|
@@ -99,7 +99,7 @@ module AvaTax
|
|
99
99
|
# @param include [String] A comma separated list of additional data to retrieve.
|
100
100
|
# @return [Object]
|
101
101
|
def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
102
|
-
get(path, options, "22.
|
102
|
+
get(path, options, "22.3.0") end
|
103
103
|
|
104
104
|
# Retrieve a single company location parameter
|
105
105
|
#
|
@@ -120,7 +120,7 @@ module AvaTax
|
|
120
120
|
# @param id [Integer] The parameter id
|
121
121
|
# @return [Object]
|
122
122
|
def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
123
|
-
get(path, {}, "22.
|
123
|
+
get(path, {}, "22.3.0") end
|
124
124
|
|
125
125
|
# Retrieve parameters for a location
|
126
126
|
#
|
@@ -147,7 +147,7 @@ module AvaTax
|
|
147
147
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
148
148
|
# @return [FetchResult]
|
149
149
|
def list_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
150
|
-
get(path, options, "22.
|
150
|
+
get(path, options, "22.3.0") end
|
151
151
|
|
152
152
|
# Retrieve locations for this company
|
153
153
|
#
|
@@ -176,7 +176,7 @@ module AvaTax
|
|
176
176
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
177
177
|
# @return [FetchResult]
|
178
178
|
def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
|
179
|
-
get(path, options, "22.
|
179
|
+
get(path, options, "22.3.0") end
|
180
180
|
|
181
181
|
# Retrieve all locations
|
182
182
|
#
|
@@ -205,7 +205,7 @@ module AvaTax
|
|
205
205
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
206
206
|
# @return [FetchResult]
|
207
207
|
def query_locations(options={}) path = "/api/v2/locations"
|
208
|
-
get(path, options, "22.
|
208
|
+
get(path, options, "22.3.0") end
|
209
209
|
|
210
210
|
# Update a single location
|
211
211
|
#
|
@@ -222,7 +222,7 @@ module AvaTax
|
|
222
222
|
# @param model [Object] The location you wish to update.
|
223
223
|
# @return [Object]
|
224
224
|
def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
225
|
-
put(path, model, {}, "22.
|
225
|
+
put(path, model, {}, "22.3.0") end
|
226
226
|
|
227
227
|
# Update a location parameter
|
228
228
|
#
|
@@ -244,7 +244,7 @@ module AvaTax
|
|
244
244
|
# @param model [Object] The location parameter object you wish to update.
|
245
245
|
# @return [Object]
|
246
246
|
def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
247
|
-
put(path, model, {}, "22.
|
247
|
+
put(path, model, {}, "22.3.0") end
|
248
248
|
|
249
249
|
# Validate the location against local requirements
|
250
250
|
#
|
@@ -260,7 +260,7 @@ module AvaTax
|
|
260
260
|
# @param id [Integer] The primary key of this location
|
261
261
|
# @return [Object]
|
262
262
|
def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
|
263
|
-
get(path, {}, "22.
|
263
|
+
get(path, {}, "22.3.0") end
|
264
264
|
end
|
265
265
|
end
|
266
266
|
end
|
@@ -35,7 +35,7 @@ module AvaTax
|
|
35
35
|
# @param model [Object] The adjust request you wish to execute
|
36
36
|
# @return [Object]
|
37
37
|
def adjust_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
|
38
|
-
post(path, model, options, "22.
|
38
|
+
post(path, model, options, "22.3.0") end
|
39
39
|
|
40
40
|
# Get audit information about a MultiDocument transaction
|
41
41
|
#
|
@@ -71,7 +71,7 @@ module AvaTax
|
|
71
71
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
72
72
|
# @return [Object]
|
73
73
|
def audit_multi_document_transaction(code, type) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
|
74
|
-
get(path, {}, "22.
|
74
|
+
get(path, {}, "22.3.0") end
|
75
75
|
|
76
76
|
# Commit a MultiDocument transaction
|
77
77
|
#
|
@@ -100,7 +100,7 @@ module AvaTax
|
|
100
100
|
# @param model [Object] The commit request you wish to execute
|
101
101
|
# @return [Object]
|
102
102
|
def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
|
103
|
-
post(path, model, {}, "22.
|
103
|
+
post(path, model, {}, "22.3.0") end
|
104
104
|
|
105
105
|
# Create a new MultiDocument transaction
|
106
106
|
#
|
@@ -154,7 +154,7 @@ module AvaTax
|
|
154
154
|
# @param model [Object] the multi document transaction model
|
155
155
|
# @return [Object]
|
156
156
|
def create_multi_document_transaction(model, options={}) path = "/api/v2/transactions/multidocument"
|
157
|
-
post(path, model, options, "22.
|
157
|
+
post(path, model, options, "22.3.0") end
|
158
158
|
|
159
159
|
# Retrieve a MultiDocument transaction
|
160
160
|
#
|
@@ -189,7 +189,7 @@ module AvaTax
|
|
189
189
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
190
190
|
# @return [Object]
|
191
191
|
def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
|
192
|
-
get(path, options, "22.
|
192
|
+
get(path, options, "22.3.0") end
|
193
193
|
|
194
194
|
# Retrieve a MultiDocument transaction by ID
|
195
195
|
#
|
@@ -232,7 +232,7 @@ module AvaTax
|
|
232
232
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
233
233
|
# @return [Object]
|
234
234
|
def get_multi_document_transaction_by_id(id, options={}) path = "/api/v2/transactions/multidocument/#{id}"
|
235
|
-
get(path, options, "22.
|
235
|
+
get(path, options, "22.3.0") end
|
236
236
|
|
237
237
|
# Retrieve all MultiDocument transactions
|
238
238
|
#
|
@@ -276,7 +276,7 @@ module AvaTax
|
|
276
276
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
277
277
|
# @return [FetchResult]
|
278
278
|
def list_multi_document_transactions(options={}) path = "/api/v2/transactions/multidocument"
|
279
|
-
get(path, options, "22.
|
279
|
+
get(path, options, "22.3.0") end
|
280
280
|
|
281
281
|
# Create a refund for a MultiDocument transaction
|
282
282
|
#
|
@@ -336,7 +336,7 @@ module AvaTax
|
|
336
336
|
# @param model [Object] Information about the refund to create
|
337
337
|
# @return [Object]
|
338
338
|
def refund_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
|
339
|
-
post(path, model, options, "22.
|
339
|
+
post(path, model, options, "22.3.0") end
|
340
340
|
|
341
341
|
# Verify a MultiDocument transaction
|
342
342
|
#
|
@@ -363,7 +363,7 @@ module AvaTax
|
|
363
363
|
# @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
|
364
364
|
# @return [Object]
|
365
365
|
def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
|
366
|
-
post(path, model, {}, "22.
|
366
|
+
post(path, model, {}, "22.3.0") end
|
367
367
|
|
368
368
|
# Void a MultiDocument transaction
|
369
369
|
#
|
@@ -395,7 +395,7 @@ module AvaTax
|
|
395
395
|
# @param model [Object] The void request you wish to execute
|
396
396
|
# @return [Object]
|
397
397
|
def void_multi_document_transaction(code, type, model) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
|
398
|
-
post(path, model, {}, "22.
|
398
|
+
post(path, model, {}, "22.3.0") end
|
399
399
|
end
|
400
400
|
end
|
401
401
|
end
|
data/lib/avatax/client/nexus.rb
CHANGED
@@ -33,7 +33,7 @@ module AvaTax
|
|
33
33
|
# @param model [NexusModel[]] The nexus you wish to create.
|
34
34
|
# @return [NexusModel[]]
|
35
35
|
def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
|
36
|
-
post(path, model, {}, "22.
|
36
|
+
post(path, model, {}, "22.3.0") end
|
37
37
|
|
38
38
|
# Add parameters to a nexus.
|
39
39
|
#
|
@@ -57,7 +57,7 @@ module AvaTax
|
|
57
57
|
# @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
|
58
58
|
# @return [NexusParameterDetailModel[]]
|
59
59
|
def create_nexus_parameters(companyId, nexusId, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
60
|
-
post(path, model, {}, "22.
|
60
|
+
post(path, model, {}, "22.3.0") end
|
61
61
|
|
62
62
|
# Creates nexus for a list of addresses.
|
63
63
|
#
|
@@ -85,7 +85,7 @@ module AvaTax
|
|
85
85
|
# @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
|
86
86
|
# @return [NexusByAddressModel[]]
|
87
87
|
def declare_nexus_by_address(companyId, model) path = "/api/v2/companies/#{companyId}/nexus/byaddress"
|
88
|
-
post(path, model, {}, "22.
|
88
|
+
post(path, model, {}, "22.3.0") end
|
89
89
|
|
90
90
|
# Delete a single nexus
|
91
91
|
#
|
@@ -107,7 +107,7 @@ module AvaTax
|
|
107
107
|
# @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
|
108
108
|
# @return [ErrorDetail[]]
|
109
109
|
def delete_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
110
|
-
delete(path, options, "22.
|
110
|
+
delete(path, options, "22.3.0") end
|
111
111
|
|
112
112
|
# Delete a single nexus parameter
|
113
113
|
#
|
@@ -127,7 +127,7 @@ module AvaTax
|
|
127
127
|
# @param id [Integer] The parameter id
|
128
128
|
# @return [ErrorDetail[]]
|
129
129
|
def delete_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
130
|
-
delete(path, {}, "22.
|
130
|
+
delete(path, {}, "22.3.0") end
|
131
131
|
|
132
132
|
# Delete all parameters for an nexus
|
133
133
|
#
|
@@ -146,7 +146,7 @@ module AvaTax
|
|
146
146
|
# @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
|
147
147
|
# @return [ErrorDetail[]]
|
148
148
|
def delete_nexus_parameters(companyId, nexusId) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
149
|
-
delete(path, {}, "22.
|
149
|
+
delete(path, {}, "22.3.0") end
|
150
150
|
|
151
151
|
# Retrieve a single nexus
|
152
152
|
#
|
@@ -168,7 +168,7 @@ module AvaTax
|
|
168
168
|
# @param include [String]
|
169
169
|
# @return [Object]
|
170
170
|
def get_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
171
|
-
get(path, options, "22.
|
171
|
+
get(path, options, "22.3.0") end
|
172
172
|
|
173
173
|
# List company nexus related to a tax form
|
174
174
|
#
|
@@ -194,7 +194,7 @@ module AvaTax
|
|
194
194
|
# @param include [String]
|
195
195
|
# @return [Object]
|
196
196
|
def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
197
|
-
get(path, options, "22.
|
197
|
+
get(path, options, "22.3.0") end
|
198
198
|
|
199
199
|
# Retrieve a single nexus parameter
|
200
200
|
#
|
@@ -214,7 +214,7 @@ module AvaTax
|
|
214
214
|
# @param id [Integer] The parameter id
|
215
215
|
# @return [Object]
|
216
216
|
def get_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
217
|
-
get(path, {}, "22.
|
217
|
+
get(path, {}, "22.3.0") end
|
218
218
|
|
219
219
|
# Retrieve nexus for this company
|
220
220
|
#
|
@@ -242,7 +242,7 @@ module AvaTax
|
|
242
242
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
243
243
|
# @return [FetchResult]
|
244
244
|
def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
|
245
|
-
get(path, options, "22.
|
245
|
+
get(path, options, "22.3.0") end
|
246
246
|
|
247
247
|
# Retrieve nexus for this company By TaxTypeGroup
|
248
248
|
#
|
@@ -271,7 +271,7 @@ module AvaTax
|
|
271
271
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
272
272
|
# @return [FetchResult]
|
273
273
|
def list_nexus_by_company_and_tax_type_group(companyId, taxTypeGroup, options={}) path = "/api/v2/companies/#{companyId}/nexus/byTaxTypeGroup/#{taxTypeGroup}"
|
274
|
-
get(path, options, "22.
|
274
|
+
get(path, options, "22.3.0") end
|
275
275
|
|
276
276
|
# Retrieve parameters for a nexus
|
277
277
|
#
|
@@ -297,7 +297,7 @@ module AvaTax
|
|
297
297
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
298
298
|
# @return [FetchResult]
|
299
299
|
def list_nexus_parameters(companyId, nexusId, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
300
|
-
get(path, options, "22.
|
300
|
+
get(path, options, "22.3.0") end
|
301
301
|
|
302
302
|
# Retrieve all nexus
|
303
303
|
#
|
@@ -324,7 +324,7 @@ module AvaTax
|
|
324
324
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
325
325
|
# @return [FetchResult]
|
326
326
|
def query_nexus(options={}) path = "/api/v2/nexus"
|
327
|
-
get(path, options, "22.
|
327
|
+
get(path, options, "22.3.0") end
|
328
328
|
|
329
329
|
# Update a single nexus
|
330
330
|
#
|
@@ -357,7 +357,7 @@ module AvaTax
|
|
357
357
|
# @param model [Object] The nexus object you wish to update.
|
358
358
|
# @return [Object]
|
359
359
|
def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
360
|
-
put(path, model, {}, "22.
|
360
|
+
put(path, model, {}, "22.3.0") end
|
361
361
|
|
362
362
|
# Update an nexus parameter
|
363
363
|
#
|
@@ -379,7 +379,7 @@ module AvaTax
|
|
379
379
|
# @param model [Object] The nexus object you wish to update.
|
380
380
|
# @return [Object]
|
381
381
|
def update_nexus_parameter(companyId, nexusId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
382
|
-
put(path, model, {}, "22.
|
382
|
+
put(path, model, {}, "22.3.0") end
|
383
383
|
end
|
384
384
|
end
|
385
385
|
end
|
@@ -15,7 +15,7 @@ module AvaTax
|
|
15
15
|
# @param model [Object] The responsibility type to create
|
16
16
|
# @return [Object]
|
17
17
|
def create_notice_responsibility_type(model) path = "/api/v2/notices/responsibilities"
|
18
|
-
post(path, model, {}, "22.
|
18
|
+
post(path, model, {}, "22.3.0") end
|
19
19
|
|
20
20
|
# Creates a new tax notice root cause type.
|
21
21
|
#
|
@@ -29,7 +29,7 @@ module AvaTax
|
|
29
29
|
# @param model [Object] The root cause type to create
|
30
30
|
# @return [Object]
|
31
31
|
def create_notice_root_cause_type(model) path = "/api/v2/notices/rootcauses"
|
32
|
-
post(path, model, {}, "22.
|
32
|
+
post(path, model, {}, "22.3.0") end
|
33
33
|
|
34
34
|
# Delete a tax notice responsibility type.
|
35
35
|
#
|
@@ -42,7 +42,7 @@ module AvaTax
|
|
42
42
|
# @param responsibilityId [Integer] The unique ID of the responsibility type
|
43
43
|
# @return [ErrorDetail[]]
|
44
44
|
def delete_notice_responsibility_type(responsibilityId) path = "/api/v2/notices/responsibilities/#{responsibilityId}"
|
45
|
-
delete(path, {}, "22.
|
45
|
+
delete(path, {}, "22.3.0") end
|
46
46
|
|
47
47
|
# Delete a tax notice root cause type.
|
48
48
|
#
|
@@ -55,7 +55,7 @@ module AvaTax
|
|
55
55
|
# @param rootCauseId [Integer] The unique ID of the root cause type
|
56
56
|
# @return [ErrorDetail[]]
|
57
57
|
def delete_notice_root_cause_type(rootCauseId) path = "/api/v2/notices/rootcauses/#{rootCauseId}"
|
58
|
-
delete(path, {}, "22.
|
58
|
+
delete(path, {}, "22.3.0") end
|
59
59
|
end
|
60
60
|
end
|
61
61
|
end
|
@@ -27,7 +27,7 @@ module AvaTax
|
|
27
27
|
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
28
28
|
# @return [Object]
|
29
29
|
def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
|
30
|
-
put(path, {}, "22.
|
30
|
+
put(path, {}, "22.3.0") end
|
31
31
|
|
32
32
|
# Retrieve a single notification.
|
33
33
|
#
|
@@ -47,7 +47,7 @@ module AvaTax
|
|
47
47
|
# @param id [Integer] The id of the notification to retrieve.
|
48
48
|
# @return [Object]
|
49
49
|
def get_notification(id) path = "/api/v2/notifications/#{id}"
|
50
|
-
get(path, {}, "22.
|
50
|
+
get(path, {}, "22.3.0") end
|
51
51
|
|
52
52
|
# List all notifications.
|
53
53
|
#
|
@@ -73,7 +73,7 @@ module AvaTax
|
|
73
73
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
74
74
|
# @return [FetchResult]
|
75
75
|
def list_notifications(options={}) path = "/api/v2/notifications"
|
76
|
-
get(path, options, "22.
|
76
|
+
get(path, options, "22.3.0") end
|
77
77
|
end
|
78
78
|
end
|
79
79
|
end
|
@@ -29,7 +29,7 @@ module AvaTax
|
|
29
29
|
# @param model [Object] Information about the account you wish to create and the selected product offerings.
|
30
30
|
# @return [Object]
|
31
31
|
def request_new_account(model) path = "/api/v2/accounts/request"
|
32
|
-
post(path, model, {}, "22.
|
32
|
+
post(path, model, {}, "22.3.0") end
|
33
33
|
|
34
34
|
# Request a new entitilement to an existing customer
|
35
35
|
#
|
@@ -46,7 +46,7 @@ module AvaTax
|
|
46
46
|
# @param offer [String] The offer to be added to an already existing customer
|
47
47
|
# @return [Object]
|
48
48
|
def request_new_entitlement(id, offer) path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
|
49
|
-
post(path, {}, "22.
|
49
|
+
post(path, {}, "22.3.0") end
|
50
50
|
end
|
51
51
|
end
|
52
52
|
end
|
@@ -18,7 +18,7 @@ module AvaTax
|
|
18
18
|
# @param model [Object] The account you wish to create.
|
19
19
|
# @return [AccountModel[]]
|
20
20
|
def create_account(model) path = "/api/v2/accounts"
|
21
|
-
post(path, model, {}, "22.
|
21
|
+
post(path, model, {}, "22.3.0") end
|
22
22
|
|
23
23
|
# Create new notifications.
|
24
24
|
#
|
@@ -44,7 +44,7 @@ module AvaTax
|
|
44
44
|
# @param model [NotificationModel[]] The notifications you wish to create.
|
45
45
|
# @return [NotificationModel[]]
|
46
46
|
def create_notifications(model) path = "/api/v2/notifications"
|
47
|
-
post(path, model, {}, "22.
|
47
|
+
post(path, model, {}, "22.3.0") end
|
48
48
|
|
49
49
|
# Create a new subscription
|
50
50
|
#
|
@@ -62,7 +62,7 @@ module AvaTax
|
|
62
62
|
# @param model [SubscriptionModel[]] The subscription you wish to create.
|
63
63
|
# @return [SubscriptionModel[]]
|
64
64
|
def create_subscriptions(accountId, model) path = "/api/v2/accounts/#{accountId}/subscriptions"
|
65
|
-
post(path, model, {}, "22.
|
65
|
+
post(path, model, {}, "22.3.0") end
|
66
66
|
|
67
67
|
# Delete a single account
|
68
68
|
#
|
@@ -79,7 +79,7 @@ module AvaTax
|
|
79
79
|
# @param id [Integer] The ID of the account you wish to delete.
|
80
80
|
# @return [ErrorDetail[]]
|
81
81
|
def delete_account(id) path = "/api/v2/accounts/#{id}"
|
82
|
-
delete(path, {}, "22.
|
82
|
+
delete(path, {}, "22.3.0") end
|
83
83
|
|
84
84
|
# Delete a single notification.
|
85
85
|
#
|
@@ -102,7 +102,7 @@ module AvaTax
|
|
102
102
|
# @param id [Integer] The id of the notification you wish to delete.
|
103
103
|
# @return [ErrorDetail[]]
|
104
104
|
def delete_notification(id) path = "/api/v2/notifications/#{id}"
|
105
|
-
delete(path, {}, "22.
|
105
|
+
delete(path, {}, "22.3.0") end
|
106
106
|
|
107
107
|
# Delete a single subscription
|
108
108
|
#
|
@@ -119,18 +119,7 @@ module AvaTax
|
|
119
119
|
# @param id [Integer] The ID of the subscription you wish to delete.
|
120
120
|
# @return [ErrorDetail[]]
|
121
121
|
def delete_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
122
|
-
delete(path, {}, "22.
|
123
|
-
|
124
|
-
# Retrieve List of Accounts by Account Migration Status
|
125
|
-
#
|
126
|
-
# ### Security Policies
|
127
|
-
#
|
128
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
129
|
-
# Swagger Name: AvaTaxClient
|
130
|
-
# @param writeMode [String] (See TssAccountMigrationId::* for a list of allowable values)
|
131
|
-
# @return [Object]
|
132
|
-
def list_accounts_by_tss_write_mode(writeMode) path = "/api/v2/accounts/ListAccountsByTssWriteMode/#{writeMode}"
|
133
|
-
get(path, {}, "22.2.1") end
|
122
|
+
delete(path, {}, "22.3.0") end
|
134
123
|
|
135
124
|
# Reset a user's password programmatically
|
136
125
|
#
|
@@ -151,7 +140,7 @@ module AvaTax
|
|
151
140
|
# @param model [Object] The new password for this user
|
152
141
|
# @return [String]
|
153
142
|
def reset_password(userId, model, options={}) path = "/api/v2/passwords/#{userId}/reset"
|
154
|
-
post(path, model, options, "22.
|
143
|
+
post(path, model, options, "22.3.0") end
|
155
144
|
|
156
145
|
# Update a single account
|
157
146
|
#
|
@@ -168,7 +157,7 @@ module AvaTax
|
|
168
157
|
# @param model [Object] The account object you wish to update.
|
169
158
|
# @return [Object]
|
170
159
|
def update_account(id, model) path = "/api/v2/accounts/#{id}"
|
171
|
-
put(path, model, {}, "22.
|
160
|
+
put(path, model, {}, "22.3.0") end
|
172
161
|
|
173
162
|
# Update a single notification.
|
174
163
|
#
|
@@ -192,7 +181,7 @@ module AvaTax
|
|
192
181
|
# @param model [Object] The notification object you wish to update.
|
193
182
|
# @return [Object]
|
194
183
|
def update_notification(id, model) path = "/api/v2/notifications/#{id}"
|
195
|
-
put(path, model, {}, "22.
|
184
|
+
put(path, model, {}, "22.3.0") end
|
196
185
|
|
197
186
|
# Update a single subscription
|
198
187
|
#
|
@@ -214,7 +203,7 @@ module AvaTax
|
|
214
203
|
# @param model [Object] The subscription you wish to update.
|
215
204
|
# @return [Object]
|
216
205
|
def update_subscription(accountId, id, model) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
217
|
-
put(path, model, {}, "22.
|
206
|
+
put(path, model, {}, "22.3.0") end
|
218
207
|
end
|
219
208
|
end
|
220
209
|
end
|
@@ -27,7 +27,7 @@ module AvaTax
|
|
27
27
|
# @param id [Integer] The unique ID number of this report
|
28
28
|
# @return [Object]
|
29
29
|
def download_report(id) path = "/api/v2/reports/#{id}/attachment"
|
30
|
-
get(path, {}, "22.
|
30
|
+
get(path, {}, "22.3.0") end
|
31
31
|
|
32
32
|
# Retrieve a single report
|
33
33
|
#
|
@@ -46,7 +46,7 @@ module AvaTax
|
|
46
46
|
# @param id [Integer] The unique ID number of the report to retrieve
|
47
47
|
# @return [Object]
|
48
48
|
def get_report(id) path = "/api/v2/reports/#{id}"
|
49
|
-
get(path, {}, "22.
|
49
|
+
get(path, {}, "22.3.0") end
|
50
50
|
|
51
51
|
# Initiate an ExportDocumentLine report task
|
52
52
|
#
|
@@ -79,7 +79,7 @@ module AvaTax
|
|
79
79
|
# @param model [Object] Options that may be configured to customize the report.
|
80
80
|
# @return [ReportModel[]]
|
81
81
|
def initiate_export_document_line_report(companyId, model) path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
|
82
|
-
post(path, model, {}, "22.
|
82
|
+
post(path, model, {}, "22.3.0") end
|
83
83
|
|
84
84
|
# List all report tasks for account
|
85
85
|
#
|
@@ -105,7 +105,7 @@ module AvaTax
|
|
105
105
|
# @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.
|
106
106
|
# @return [FetchResult]
|
107
107
|
def list_reports(options={}) path = "/api/v2/reports"
|
108
|
-
get(path, options, "22.
|
108
|
+
get(path, options, "22.3.0") end
|
109
109
|
end
|
110
110
|
end
|
111
111
|
end
|
@@ -29,7 +29,7 @@ module AvaTax
|
|
29
29
|
# @param model [SettingModel[]] The setting you wish to create.
|
30
30
|
# @return [SettingModel[]]
|
31
31
|
def create_settings(companyId, model) path = "/api/v2/companies/#{companyId}/settings"
|
32
|
-
post(path, model, {}, "22.
|
32
|
+
post(path, model, {}, "22.3.0") end
|
33
33
|
|
34
34
|
# Delete a single setting
|
35
35
|
#
|
@@ -52,7 +52,7 @@ module AvaTax
|
|
52
52
|
# @param id [Integer] The ID of the setting you wish to delete.
|
53
53
|
# @return [ErrorDetail[]]
|
54
54
|
def delete_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
55
|
-
delete(path, {}, "22.
|
55
|
+
delete(path, {}, "22.3.0") end
|
56
56
|
|
57
57
|
# Retrieve a single setting
|
58
58
|
#
|
@@ -75,7 +75,7 @@ module AvaTax
|
|
75
75
|
# @param id [Integer] The primary key of this setting
|
76
76
|
# @return [Object]
|
77
77
|
def get_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
78
|
-
get(path, {}, "22.
|
78
|
+
get(path, {}, "22.3.0") end
|
79
79
|
|
80
80
|
# Retrieve all settings for this company
|
81
81
|
#
|
@@ -105,7 +105,7 @@ module AvaTax
|
|
105
105
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
106
106
|
# @return [FetchResult]
|
107
107
|
def list_settings_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/settings"
|
108
|
-
get(path, options, "22.
|
108
|
+
get(path, options, "22.3.0") end
|
109
109
|
|
110
110
|
# Retrieve all settings
|
111
111
|
#
|
@@ -134,7 +134,7 @@ module AvaTax
|
|
134
134
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
135
135
|
# @return [FetchResult]
|
136
136
|
def query_settings(options={}) path = "/api/v2/settings"
|
137
|
-
get(path, options, "22.
|
137
|
+
get(path, options, "22.3.0") end
|
138
138
|
|
139
139
|
# Update a single setting
|
140
140
|
#
|
@@ -162,7 +162,7 @@ module AvaTax
|
|
162
162
|
# @param model [Object] The setting you wish to update.
|
163
163
|
# @return [Object]
|
164
164
|
def update_setting(companyId, id, model) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
165
|
-
put(path, model, {}, "22.
|
165
|
+
put(path, model, {}, "22.3.0") end
|
166
166
|
end
|
167
167
|
end
|
168
168
|
end
|