avatax 21.10.0 → 21.12.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 +22 -11
- data/lib/avatax/client/addresses.rb +4 -2
- data/lib/avatax/client/advancedrules.rb +10 -5
- data/lib/avatax/client/ageverification.rb +29 -0
- data/lib/avatax/client/avafileforms.rb +10 -5
- data/lib/avatax/client/batches.rb +16 -8
- data/lib/avatax/client/certexpressinvites.rb +6 -3
- data/lib/avatax/client/certificates.rb +30 -15
- data/lib/avatax/client/companies.rb +42 -21
- data/lib/avatax/client/compliance.rb +25 -14
- data/lib/avatax/client/contacts.rb +12 -6
- data/lib/avatax/client/customers.rb +26 -13
- data/lib/avatax/client/datasources.rb +12 -6
- data/lib/avatax/client/definitions.rb +140 -70
- data/lib/avatax/client/distancethresholds.rb +12 -6
- data/lib/avatax/client/ecommercetoken.rb +4 -2
- data/lib/avatax/client/filingcalendars.rb +7 -4
- data/lib/avatax/client/filings.rb +4 -2
- data/lib/avatax/client/firmclientlinkages.rb +18 -9
- data/lib/avatax/client/free.rb +2 -1
- data/lib/avatax/client/fundingrequests.rb +4 -2
- data/lib/avatax/client/items.rb +50 -25
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -6
- data/lib/avatax/client/locations.rb +24 -12
- data/lib/avatax/client/multidocument.rb +20 -10
- data/lib/avatax/client/nexus.rb +30 -15
- data/lib/avatax/client/notices.rb +8 -4
- data/lib/avatax/client/notifications.rb +6 -3
- data/lib/avatax/client/provisioning.rb +4 -2
- data/lib/avatax/client/registrar.rb +22 -11
- data/lib/avatax/client/reports.rb +8 -4
- data/lib/avatax/client/settings.rb +12 -6
- data/lib/avatax/client/shippingverification.rb +66 -0
- data/lib/avatax/client/subscriptions.rb +6 -3
- data/lib/avatax/client/taxcodes.rb +12 -6
- data/lib/avatax/client/taxcontent.rb +10 -5
- data/lib/avatax/client/taxrules.rb +12 -6
- data/lib/avatax/client/transactions.rb +42 -21
- data/lib/avatax/client/upcs.rb +12 -6
- data/lib/avatax/client/userdefinedfields.rb +52 -0
- data/lib/avatax/client/users.rb +16 -8
- data/lib/avatax/client/utilities.rb +6 -3
- data/lib/avatax/client.rb +2 -0
- data/lib/avatax/connection.rb +1 -1
- data/lib/avatax/request.rb +10 -9
- data/lib/avatax/version.rb +1 -1
- metadata +5 -2
@@ -31,12 +31,13 @@ module AvaTax
|
|
31
31
|
#
|
32
32
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
33
33
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
34
|
+
# Swagger Name: AvaTaxClient
|
34
35
|
# @param companyId [Integer] The ID number of the company recording this certificate
|
35
36
|
# @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
|
36
37
|
# @param model [CertificateModel[]] Certificates to be created
|
37
38
|
# @return [CertificateModel[]]
|
38
39
|
def create_certificates(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/certificates"
|
39
|
-
post(path, model, options) end
|
40
|
+
post(path, model, options, "21.12.0") end
|
40
41
|
|
41
42
|
# Revoke and delete a certificate
|
42
43
|
#
|
@@ -58,11 +59,12 @@ module AvaTax
|
|
58
59
|
#
|
59
60
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
60
61
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
62
|
+
# Swagger Name: AvaTaxClient
|
61
63
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
62
64
|
# @param id [Integer] The unique ID number of this certificate
|
63
65
|
# @return [ErrorDetail[]]
|
64
66
|
def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
65
|
-
delete(path) end
|
67
|
+
delete(path, {}, "21.12.0") end
|
66
68
|
|
67
69
|
# Download an image for this certificate
|
68
70
|
#
|
@@ -85,13 +87,14 @@ module AvaTax
|
|
85
87
|
#
|
86
88
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
87
89
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
90
|
+
# Swagger Name: AvaTaxClient
|
88
91
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
89
92
|
# @param id [Integer] The unique ID number of this certificate
|
90
93
|
# @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
|
91
94
|
# @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
|
92
95
|
# @return [Object]
|
93
96
|
def download_certificate_image(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
|
94
|
-
get(path, options) end
|
97
|
+
get(path, options, "21.12.0") end
|
95
98
|
|
96
99
|
# Retrieve a single certificate
|
97
100
|
#
|
@@ -117,12 +120,13 @@ module AvaTax
|
|
117
120
|
#
|
118
121
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
119
122
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
123
|
+
# Swagger Name: AvaTaxClient
|
120
124
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
121
125
|
# @param id [Integer] The unique ID number of this certificate
|
122
126
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
123
127
|
# @return [Object]
|
124
128
|
def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
125
|
-
get(path, options) end
|
129
|
+
get(path, options, "21.12.0") end
|
126
130
|
|
127
131
|
# Check a company's exemption certificate status.
|
128
132
|
#
|
@@ -138,10 +142,11 @@ module AvaTax
|
|
138
142
|
#
|
139
143
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
140
144
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
145
|
+
# Swagger Name: AvaTaxClient
|
141
146
|
# @param companyId [Integer] The company ID to check
|
142
147
|
# @return [Object]
|
143
148
|
def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
|
144
|
-
get(path) end
|
149
|
+
get(path, {}, "21.12.0") end
|
145
150
|
|
146
151
|
# Link attributes to a certificate
|
147
152
|
#
|
@@ -164,12 +169,13 @@ module AvaTax
|
|
164
169
|
#
|
165
170
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
166
171
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
172
|
+
# Swagger Name: AvaTaxClient
|
167
173
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
168
174
|
# @param id [Integer] The unique ID number of this certificate
|
169
175
|
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
|
170
176
|
# @return [FetchResult]
|
171
177
|
def link_attributes_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
|
172
|
-
post(path, model) end
|
178
|
+
post(path, model, {}, "21.12.0") end
|
173
179
|
|
174
180
|
# Link customers to a certificate
|
175
181
|
#
|
@@ -193,12 +199,13 @@ module AvaTax
|
|
193
199
|
#
|
194
200
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
195
201
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
202
|
+
# Swagger Name: AvaTaxClient
|
196
203
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
197
204
|
# @param id [Integer] The unique ID number of this certificate
|
198
205
|
# @param model [Object] The list of customers needed be added to the Certificate for exemption
|
199
206
|
# @return [FetchResult]
|
200
207
|
def link_customers_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
|
201
|
-
post(path, model) end
|
208
|
+
post(path, model, {}, "21.12.0") end
|
202
209
|
|
203
210
|
# List all attributes applied to this certificate
|
204
211
|
#
|
@@ -221,11 +228,12 @@ module AvaTax
|
|
221
228
|
#
|
222
229
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
223
230
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
231
|
+
# Swagger Name: AvaTaxClient
|
224
232
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
225
233
|
# @param id [Integer] The unique ID number of this certificate
|
226
234
|
# @return [FetchResult]
|
227
235
|
def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
|
228
|
-
get(path) end
|
236
|
+
get(path, {}, "21.12.0") end
|
229
237
|
|
230
238
|
# List customers linked to this certificate
|
231
239
|
#
|
@@ -248,12 +256,13 @@ module AvaTax
|
|
248
256
|
#
|
249
257
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
250
258
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
259
|
+
# Swagger Name: AvaTaxClient
|
251
260
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
252
261
|
# @param id [Integer] The unique ID number of this certificate
|
253
262
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
|
254
263
|
# @return [FetchResult]
|
255
264
|
def list_customers_for_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
|
256
|
-
get(path, options) end
|
265
|
+
get(path, options, "21.12.0") end
|
257
266
|
|
258
267
|
# List all certificates for a company
|
259
268
|
#
|
@@ -279,6 +288,7 @@ module AvaTax
|
|
279
288
|
#
|
280
289
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
281
290
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
291
|
+
# Swagger Name: AvaTaxClient
|
282
292
|
# @param companyId [Integer] The ID number of the company to search
|
283
293
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
284
294
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
|
@@ -287,7 +297,7 @@ module AvaTax
|
|
287
297
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
288
298
|
# @return [FetchResult]
|
289
299
|
def query_certificates(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates"
|
290
|
-
get(path, options) end
|
300
|
+
get(path, options, "21.12.0") end
|
291
301
|
|
292
302
|
# Request setup of exemption certificates for this company.
|
293
303
|
#
|
@@ -305,10 +315,11 @@ module AvaTax
|
|
305
315
|
#
|
306
316
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
307
317
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
318
|
+
# Swagger Name: AvaTaxClient
|
308
319
|
# @param companyId [Integer]
|
309
320
|
# @return [Object]
|
310
321
|
def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
|
311
|
-
post(path) end
|
322
|
+
post(path, {}, "21.12.0") end
|
312
323
|
|
313
324
|
# Unlink attributes from a certificate
|
314
325
|
#
|
@@ -331,12 +342,13 @@ module AvaTax
|
|
331
342
|
#
|
332
343
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
333
344
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
345
|
+
# Swagger Name: AvaTaxClient
|
334
346
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
335
347
|
# @param id [Integer] The unique ID number of this certificate
|
336
348
|
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
|
337
349
|
# @return [FetchResult]
|
338
350
|
def unlink_attributes_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
|
339
|
-
post(path, model) end
|
351
|
+
post(path, model, {}, "21.12.0") end
|
340
352
|
|
341
353
|
# Unlink customers from a certificate
|
342
354
|
#
|
@@ -361,12 +373,13 @@ module AvaTax
|
|
361
373
|
#
|
362
374
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
363
375
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
376
|
+
# Swagger Name: AvaTaxClient
|
364
377
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
365
378
|
# @param id [Integer] The unique ID number of this certificate
|
366
379
|
# @param model [Object] The list of customers to unlink from this certificate
|
367
380
|
# @return [FetchResult]
|
368
381
|
def unlink_customers_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
|
369
|
-
post(path, model) end
|
382
|
+
post(path, model, {}, "21.12.0") end
|
370
383
|
|
371
384
|
# Update a single certificate
|
372
385
|
#
|
@@ -386,12 +399,13 @@ module AvaTax
|
|
386
399
|
#
|
387
400
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
388
401
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
402
|
+
# Swagger Name: AvaTaxClient
|
389
403
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
390
404
|
# @param id [Integer] The unique ID number of this certificate
|
391
405
|
# @param model [Object] The new certificate object that will replace the existing one
|
392
406
|
# @return [Object]
|
393
407
|
def update_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
394
|
-
put(path, model) end
|
408
|
+
put(path, model, {}, "21.12.0") end
|
395
409
|
|
396
410
|
# Upload an image or PDF attachment for this certificate
|
397
411
|
#
|
@@ -414,12 +428,13 @@ module AvaTax
|
|
414
428
|
#
|
415
429
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
416
430
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
431
|
+
# Swagger Name: AvaTaxClient
|
417
432
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
418
433
|
# @param id [Integer] The unique ID number of this certificate
|
419
434
|
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
|
420
435
|
# @return [String]
|
421
436
|
def upload_certificate_image(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
|
422
|
-
post(path) end
|
437
|
+
post(path, {}, "21.12.0") end
|
423
438
|
end
|
424
439
|
end
|
425
440
|
end
|
@@ -32,10 +32,11 @@ module AvaTax
|
|
32
32
|
# ### Security Policies
|
33
33
|
#
|
34
34
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
35
|
+
# Swagger Name: AvaTaxClient
|
35
36
|
# @param id [Integer] The ID of the company to check if its integration is certified.
|
36
37
|
# @return [String]
|
37
38
|
def certify_integration(id) path = "/api/v2/companies/#{id}/certify"
|
38
|
-
get(path) end
|
39
|
+
get(path, {}, "21.12.0") end
|
39
40
|
|
40
41
|
# Change the filing status of this company
|
41
42
|
#
|
@@ -56,11 +57,12 @@ module AvaTax
|
|
56
57
|
# ### Security Policies
|
57
58
|
#
|
58
59
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
60
|
+
# Swagger Name: AvaTaxClient
|
59
61
|
# @param id [Integer]
|
60
62
|
# @param model [Object]
|
61
63
|
# @return [String]
|
62
64
|
def change_filing_status(id, model) path = "/api/v2/companies/#{id}/filingstatus"
|
63
|
-
post(path, model) end
|
65
|
+
post(path, model, {}, "21.12.0") end
|
64
66
|
|
65
67
|
# Quick setup for a company with a single physical address
|
66
68
|
#
|
@@ -80,10 +82,11 @@ module AvaTax
|
|
80
82
|
# ### Security Policies
|
81
83
|
#
|
82
84
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
85
|
+
# Swagger Name: AvaTaxClient
|
83
86
|
# @param model [Object] Information about the company you wish to create.
|
84
87
|
# @return [Object]
|
85
88
|
def company_initialize(model) path = "/api/v2/companies/initialize"
|
86
|
-
post(path, model) end
|
89
|
+
post(path, model, {}, "21.12.0") end
|
87
90
|
|
88
91
|
# Create new companies
|
89
92
|
#
|
@@ -96,10 +99,11 @@ module AvaTax
|
|
96
99
|
# ### Security Policies
|
97
100
|
#
|
98
101
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
102
|
+
# Swagger Name: AvaTaxClient
|
99
103
|
# @param model [CompanyModel[]] Either a single company object or an array of companies to create
|
100
104
|
# @return [CompanyModel[]]
|
101
105
|
def create_companies(model) path = "/api/v2/companies"
|
102
|
-
post(path, model) end
|
106
|
+
post(path, model, {}, "21.12.0") end
|
103
107
|
|
104
108
|
# Add parameters to a company.
|
105
109
|
#
|
@@ -118,11 +122,12 @@ module AvaTax
|
|
118
122
|
# ### Security Policies
|
119
123
|
#
|
120
124
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
125
|
+
# Swagger Name: AvaTaxClient
|
121
126
|
# @param companyId [Integer] The ID of the company that owns this company parameter.
|
122
127
|
# @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
|
123
128
|
# @return [CompanyParameterDetailModel[]]
|
124
129
|
def create_company_parameters(companyId, model) path = "/api/v2/companies/#{companyId}/parameters"
|
125
|
-
post(path, model) end
|
130
|
+
post(path, model, {}, "21.12.0") end
|
126
131
|
|
127
132
|
# Request managed returns funding setup for a company
|
128
133
|
#
|
@@ -141,11 +146,12 @@ module AvaTax
|
|
141
146
|
#
|
142
147
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
143
148
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
149
|
+
# Swagger Name: AvaTaxClient
|
144
150
|
# @param id [Integer] The unique identifier of the company
|
145
151
|
# @param model [Object] The funding initialization request
|
146
152
|
# @return [Object]
|
147
153
|
def create_funding_request(id, model) path = "/api/v2/companies/#{id}/funding/setup"
|
148
|
-
post(path, model) end
|
154
|
+
post(path, model, {}, "21.12.0") end
|
149
155
|
|
150
156
|
# Delete a single company
|
151
157
|
#
|
@@ -154,10 +160,11 @@ module AvaTax
|
|
154
160
|
# ### Security Policies
|
155
161
|
#
|
156
162
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
163
|
+
# Swagger Name: AvaTaxClient
|
157
164
|
# @param id [Integer] The ID of the company you wish to delete.
|
158
165
|
# @return [ErrorDetail[]]
|
159
166
|
def delete_company(id) path = "/api/v2/companies/#{id}"
|
160
|
-
delete(path) end
|
167
|
+
delete(path, {}, "21.12.0") end
|
161
168
|
|
162
169
|
# Delete a single company parameter
|
163
170
|
#
|
@@ -171,11 +178,12 @@ module AvaTax
|
|
171
178
|
# ### Security Policies
|
172
179
|
#
|
173
180
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
181
|
+
# Swagger Name: AvaTaxClient
|
174
182
|
# @param companyId [Integer] The company id
|
175
183
|
# @param id [Integer] The parameter id
|
176
184
|
# @return [ErrorDetail[]]
|
177
185
|
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
178
|
-
delete(path) end
|
186
|
+
delete(path, {}, "21.12.0") end
|
179
187
|
|
180
188
|
# Check the funding configuration of a company
|
181
189
|
#
|
@@ -188,10 +196,11 @@ module AvaTax
|
|
188
196
|
#
|
189
197
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
190
198
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
199
|
+
# Swagger Name: AvaTaxClient
|
191
200
|
# @param companyId [Integer] The unique identifier of the company
|
192
201
|
# @return [Object]
|
193
202
|
def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
|
194
|
-
get(path) end
|
203
|
+
get(path, {}, "21.12.0") end
|
195
204
|
|
196
205
|
# Check the funding configuration of a company
|
197
206
|
#
|
@@ -204,11 +213,12 @@ module AvaTax
|
|
204
213
|
#
|
205
214
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
206
215
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
216
|
+
# Swagger Name: AvaTaxClient
|
207
217
|
# @param companyId [Integer] The unique identifier of the company
|
208
218
|
# @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
|
209
219
|
# @return [FundingConfigurationModel[]]
|
210
220
|
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
211
|
-
get(path, options) end
|
221
|
+
get(path, options, "21.12.0") end
|
212
222
|
|
213
223
|
# Retrieve a single company
|
214
224
|
#
|
@@ -229,11 +239,12 @@ module AvaTax
|
|
229
239
|
# ### Security Policies
|
230
240
|
#
|
231
241
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
242
|
+
# Swagger Name: AvaTaxClient
|
232
243
|
# @param id [Integer] The ID of the company to retrieve.
|
233
244
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
|
234
245
|
# @return [Object]
|
235
246
|
def get_company(id, options={}) path = "/api/v2/companies/#{id}"
|
236
|
-
get(path, options) end
|
247
|
+
get(path, options, "21.12.0") end
|
237
248
|
|
238
249
|
# Get configuration settings for this company
|
239
250
|
#
|
@@ -253,10 +264,11 @@ module AvaTax
|
|
253
264
|
# ### Security Policies
|
254
265
|
#
|
255
266
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
267
|
+
# Swagger Name: AvaTaxClient
|
256
268
|
# @param id [Integer]
|
257
269
|
# @return [CompanyConfigurationModel[]]
|
258
270
|
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
259
|
-
get(path) end
|
271
|
+
get(path, {}, "21.12.0") end
|
260
272
|
|
261
273
|
# Retrieve a single company parameter
|
262
274
|
#
|
@@ -271,11 +283,12 @@ module AvaTax
|
|
271
283
|
# ### Security Policies
|
272
284
|
#
|
273
285
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
286
|
+
# Swagger Name: AvaTaxClient
|
274
287
|
# @param companyId [Integer]
|
275
288
|
# @param id [Integer]
|
276
289
|
# @return [Object]
|
277
290
|
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
278
|
-
get(path) end
|
291
|
+
get(path, {}, "21.12.0") end
|
279
292
|
|
280
293
|
# Get this company's filing status
|
281
294
|
#
|
@@ -297,10 +310,11 @@ module AvaTax
|
|
297
310
|
# ### Security Policies
|
298
311
|
#
|
299
312
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
313
|
+
# Swagger Name: AvaTaxClient
|
300
314
|
# @param id [Integer]
|
301
315
|
# @return [String]
|
302
316
|
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
303
|
-
get(path) end
|
317
|
+
get(path, {}, "21.12.0") end
|
304
318
|
|
305
319
|
# Retrieve parameters for a company
|
306
320
|
#
|
@@ -318,6 +332,7 @@ module AvaTax
|
|
318
332
|
# ### Security Policies
|
319
333
|
#
|
320
334
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
335
|
+
# Swagger Name: AvaTaxClient
|
321
336
|
# @param companyId [Integer] The company id
|
322
337
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* name, unit
|
323
338
|
# @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.
|
@@ -325,7 +340,7 @@ module AvaTax
|
|
325
340
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
326
341
|
# @return [FetchResult]
|
327
342
|
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
328
|
-
get(path, options) end
|
343
|
+
get(path, options, "21.12.0") end
|
329
344
|
|
330
345
|
# Check managed returns funding status for a company
|
331
346
|
#
|
@@ -338,10 +353,11 @@ module AvaTax
|
|
338
353
|
#
|
339
354
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
340
355
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
356
|
+
# Swagger Name: AvaTaxClient
|
341
357
|
# @param id [Integer] The unique identifier of the company
|
342
358
|
# @return [FundingStatusModel[]]
|
343
359
|
def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
|
344
|
-
get(path) end
|
360
|
+
get(path, {}, "21.12.0") end
|
345
361
|
|
346
362
|
# Retrieve a list of MRS Companies with account
|
347
363
|
#
|
@@ -352,9 +368,10 @@ module AvaTax
|
|
352
368
|
# ### Security Policies
|
353
369
|
#
|
354
370
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
371
|
+
# Swagger Name: AvaTaxClient
|
355
372
|
# @return [FetchResult]
|
356
373
|
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
357
|
-
get(path) end
|
374
|
+
get(path, {}, "21.12.0") end
|
358
375
|
|
359
376
|
# Retrieve all companies
|
360
377
|
#
|
@@ -379,6 +396,7 @@ module AvaTax
|
|
379
396
|
# ### Security Policies
|
380
397
|
#
|
381
398
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
399
|
+
# Swagger Name: AvaTaxClient
|
382
400
|
# @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
|
383
401
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
|
384
402
|
# @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.
|
@@ -386,7 +404,7 @@ module AvaTax
|
|
386
404
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
387
405
|
# @return [FetchResult]
|
388
406
|
def query_companies(options={}) path = "/api/v2/companies"
|
389
|
-
get(path, options) end
|
407
|
+
get(path, options, "21.12.0") end
|
390
408
|
|
391
409
|
# Change configuration settings for this company
|
392
410
|
#
|
@@ -406,11 +424,12 @@ module AvaTax
|
|
406
424
|
# ### Security Policies
|
407
425
|
#
|
408
426
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
427
|
+
# Swagger Name: AvaTaxClient
|
409
428
|
# @param id [Integer]
|
410
429
|
# @param model [CompanyConfigurationModel[]]
|
411
430
|
# @return [CompanyConfigurationModel[]]
|
412
431
|
def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
|
413
|
-
post(path, model) end
|
432
|
+
post(path, model, {}, "21.12.0") end
|
414
433
|
|
415
434
|
# Update a single company
|
416
435
|
#
|
@@ -429,11 +448,12 @@ module AvaTax
|
|
429
448
|
# ### Security Policies
|
430
449
|
#
|
431
450
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
451
|
+
# Swagger Name: AvaTaxClient
|
432
452
|
# @param id [Integer] The ID of the company you wish to update.
|
433
453
|
# @param model [Object] The company object you wish to update.
|
434
454
|
# @return [Object]
|
435
455
|
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
436
|
-
put(path, model) end
|
456
|
+
put(path, model, {}, "21.12.0") end
|
437
457
|
|
438
458
|
# Update a company parameter
|
439
459
|
#
|
@@ -448,12 +468,13 @@ module AvaTax
|
|
448
468
|
# ### Security Policies
|
449
469
|
#
|
450
470
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
471
|
+
# Swagger Name: AvaTaxClient
|
451
472
|
# @param companyId [Integer] The company id.
|
452
473
|
# @param id [Integer] The company parameter id
|
453
474
|
# @param model [Object] The company parameter object you wish to update.
|
454
475
|
# @return [Object]
|
455
476
|
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
456
|
-
put(path, model) end
|
477
|
+
put(path, model, {}, "21.12.0") end
|
457
478
|
end
|
458
479
|
end
|
459
480
|
end
|
@@ -1,16 +1,27 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Compliance
|
4
|
-
|
5
|
-
|
6
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Compliance
|
4
|
+
|
5
|
+
|
6
|
+
# Retrieve jurisdiction rate information for tax authority
|
7
|
+
#
|
8
|
+
# This API is available by invitation only.
|
7
9
|
#
|
8
|
-
#
|
9
|
-
#
|
10
|
-
#
|
11
|
-
#
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
10
|
+
# ### Security Policies
|
11
|
+
#
|
12
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
13
|
+
# Swagger Name: AvaTaxClient
|
14
|
+
# @param taxAuthorityId [Integer] Used to limit the jurisdictions returned.
|
15
|
+
# @param effectiveDate [DateTime] Used to limit the jurisdictions returned.
|
16
|
+
# @param endDate [DateTime] Used to limit the jurisdictions returned.
|
17
|
+
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
|
18
|
+
# @param include [String] A comma separated list of objects to fetch underneath this jurisdiction.
|
19
|
+
# @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.
|
20
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
21
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
22
|
+
# @return [Object]
|
23
|
+
def query_tax_authority_jurisdiction_rates(options={}) path = "/api/v2/compliance/taxauthorityjurisdictionrates"
|
24
|
+
get(path, options, "21.12.0") end
|
25
|
+
end
|
26
|
+
end
|
16
27
|
end
|
@@ -12,11 +12,12 @@ module AvaTax
|
|
12
12
|
# ### Security Policies
|
13
13
|
#
|
14
14
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
15
|
+
# Swagger Name: AvaTaxClient
|
15
16
|
# @param companyId [Integer] The ID of the company that owns this contact.
|
16
17
|
# @param model [ContactModel[]] The contacts you wish to create.
|
17
18
|
# @return [ContactModel[]]
|
18
19
|
def create_contacts(companyId, model) path = "/api/v2/companies/#{companyId}/contacts"
|
19
|
-
post(path, model) end
|
20
|
+
post(path, model, {}, "21.12.0") end
|
20
21
|
|
21
22
|
# Delete a single contact
|
22
23
|
#
|
@@ -25,11 +26,12 @@ module AvaTax
|
|
25
26
|
# ### Security Policies
|
26
27
|
#
|
27
28
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
29
|
+
# Swagger Name: AvaTaxClient
|
28
30
|
# @param companyId [Integer] The ID of the company that owns this contact.
|
29
31
|
# @param id [Integer] The ID of the contact you wish to delete.
|
30
32
|
# @return [ErrorDetail[]]
|
31
33
|
def delete_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
32
|
-
delete(path) end
|
34
|
+
delete(path, {}, "21.12.0") end
|
33
35
|
|
34
36
|
# Retrieve a single contact
|
35
37
|
#
|
@@ -40,11 +42,12 @@ module AvaTax
|
|
40
42
|
# ### Security Policies
|
41
43
|
#
|
42
44
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
45
|
+
# Swagger Name: AvaTaxClient
|
43
46
|
# @param companyId [Integer] The ID of the company for this contact
|
44
47
|
# @param id [Integer] The primary key of this contact
|
45
48
|
# @return [Object]
|
46
49
|
def get_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
47
|
-
get(path) end
|
50
|
+
get(path, {}, "21.12.0") end
|
48
51
|
|
49
52
|
# Retrieve contacts for this company
|
50
53
|
#
|
@@ -56,6 +59,7 @@ module AvaTax
|
|
56
59
|
# ### Security Policies
|
57
60
|
#
|
58
61
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
62
|
+
# Swagger Name: AvaTaxClient
|
59
63
|
# @param companyId [Integer] The ID of the company that owns these contacts
|
60
64
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
|
61
65
|
# @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.
|
@@ -63,7 +67,7 @@ module AvaTax
|
|
63
67
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
64
68
|
# @return [FetchResult]
|
65
69
|
def list_contacts_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/contacts"
|
66
|
-
get(path, options) end
|
70
|
+
get(path, options, "21.12.0") end
|
67
71
|
|
68
72
|
# Retrieve all contacts
|
69
73
|
#
|
@@ -77,13 +81,14 @@ module AvaTax
|
|
77
81
|
# ### Security Policies
|
78
82
|
#
|
79
83
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
84
|
+
# Swagger Name: AvaTaxClient
|
80
85
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
|
81
86
|
# @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.
|
82
87
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
83
88
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
84
89
|
# @return [FetchResult]
|
85
90
|
def query_contacts(options={}) path = "/api/v2/contacts"
|
86
|
-
get(path, options) end
|
91
|
+
get(path, options, "21.12.0") end
|
87
92
|
|
88
93
|
# Update a single contact
|
89
94
|
#
|
@@ -96,12 +101,13 @@ module AvaTax
|
|
96
101
|
# ### Security Policies
|
97
102
|
#
|
98
103
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
104
|
+
# Swagger Name: AvaTaxClient
|
99
105
|
# @param companyId [Integer] The ID of the company that this contact belongs to.
|
100
106
|
# @param id [Integer] The ID of the contact you wish to update
|
101
107
|
# @param model [Object] The contact you wish to update.
|
102
108
|
# @return [Object]
|
103
109
|
def update_contact(companyId, id, model) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
104
|
-
put(path, model) end
|
110
|
+
put(path, model, {}, "21.12.0") end
|
105
111
|
end
|
106
112
|
end
|
107
113
|
end
|