avatax 20.5.0 → 20.6.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 +116 -83
- data/lib/avatax/client/addresses.rb +26 -20
- data/lib/avatax/client/advancedrules.rb +56 -41
- data/lib/avatax/client/avafileforms.rb +56 -41
- data/lib/avatax/client/batches.rb +125 -48
- data/lib/avatax/client/certexpressinvites.rb +36 -27
- data/lib/avatax/client/certificates.rb +156 -111
- data/lib/avatax/client/companies.rb +166 -118
- data/lib/avatax/client/compliance.rb +16 -13
- data/lib/avatax/client/contacts.rb +66 -48
- data/lib/avatax/client/customers.rb +136 -97
- data/lib/avatax/client/datasources.rb +66 -48
- data/lib/avatax/client/definitions.rb +596 -419
- data/lib/avatax/client/distancethresholds.rb +66 -48
- data/lib/avatax/client/filingcalendars.rb +16 -13
- data/lib/avatax/client/filings.rb +16 -13
- data/lib/avatax/client/firmclientlinkages.rb +96 -69
- data/lib/avatax/client/free.rb +36 -27
- data/lib/avatax/client/fundingrequests.rb +26 -20
- data/lib/avatax/client/items.rb +196 -139
- data/lib/avatax/client/jurisdictionoverrides.rb +66 -48
- data/lib/avatax/client/locations.rb +76 -55
- data/lib/avatax/client/multidocument.rb +106 -76
- data/lib/avatax/client/nexus.rb +82 -183
- data/lib/avatax/client/notifications.rb +36 -27
- data/lib/avatax/client/provisioning.rb +26 -20
- data/lib/avatax/client/registrar.rb +106 -76
- data/lib/avatax/client/reports.rb +46 -34
- data/lib/avatax/client/settings.rb +66 -48
- data/lib/avatax/client/subscriptions.rb +36 -27
- data/lib/avatax/client/taxcodes.rb +66 -48
- data/lib/avatax/client/taxcontent.rb +36 -27
- data/lib/avatax/client/taxrules.rb +66 -48
- data/lib/avatax/client/transactions.rb +216 -153
- data/lib/avatax/client/upcs.rb +66 -48
- data/lib/avatax/client/users.rb +86 -62
- data/lib/avatax/client/utilities.rb +36 -27
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Certificates
|
4
|
-
|
5
|
-
|
6
|
-
# Create certificates for this company
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Certificates
|
4
|
+
|
5
|
+
|
6
|
+
# Create certificates for this company
|
7
|
+
#
|
8
8
|
# Record one or more certificates document for this company.
|
9
9
|
#
|
10
10
|
# A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
|
@@ -30,16 +30,19 @@ module AvaTax
|
|
30
30
|
# ### Security Policies
|
31
31
|
#
|
32
32
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
33
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
33
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
34
34
|
# @param companyId [Integer] The ID number of the company recording this certificate
|
35
35
|
# @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
|
36
36
|
# @param model [CertificateModel[]] Certificates to be created
|
37
|
-
# @return [CertificateModel[]]
|
38
|
-
def create_certificates(companyId, model, options={})
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
37
|
+
# @return [CertificateModel[]]
|
38
|
+
def create_certificates(companyId, model, options={})
|
39
|
+
path = "/api/v2/companies/#{companyId}/certificates"
|
40
|
+
post(path, model, options)
|
41
|
+
end
|
42
|
+
|
43
|
+
|
44
|
+
# Revoke and delete a certificate
|
45
|
+
#
|
43
46
|
# Revoke the certificate identified by this URL, then delete it.
|
44
47
|
#
|
45
48
|
# A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
|
@@ -57,15 +60,18 @@ module AvaTax
|
|
57
60
|
# ### Security Policies
|
58
61
|
#
|
59
62
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
60
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
63
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
61
64
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
62
65
|
# @param id [Integer] The unique ID number of this certificate
|
63
|
-
# @return [ErrorDetail[]]
|
64
|
-
def delete_certificate(companyId, id)
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
66
|
+
# @return [ErrorDetail[]]
|
67
|
+
def delete_certificate(companyId, id)
|
68
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
69
|
+
delete(path)
|
70
|
+
end
|
71
|
+
|
72
|
+
|
73
|
+
# Download an image for this certificate
|
74
|
+
#
|
69
75
|
# Download an image or PDF file for this certificate.
|
70
76
|
#
|
71
77
|
# This API can be used to download either a single-page preview of the certificate or a full PDF document.
|
@@ -84,17 +90,20 @@ module AvaTax
|
|
84
90
|
# ### Security Policies
|
85
91
|
#
|
86
92
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
87
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
93
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
88
94
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
89
95
|
# @param id [Integer] The unique ID number of this certificate
|
90
96
|
# @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
|
91
97
|
# @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
|
92
|
-
# @return [Object]
|
93
|
-
def download_certificate_image(companyId, id, options={})
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
+
# @return [Object]
|
99
|
+
def download_certificate_image(companyId, id, options={})
|
100
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
|
101
|
+
get(path, options)
|
102
|
+
end
|
103
|
+
|
104
|
+
|
105
|
+
# Retrieve a single certificate
|
106
|
+
#
|
98
107
|
# Get the current certificate identified by this URL.
|
99
108
|
#
|
100
109
|
# A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
|
@@ -116,16 +125,19 @@ module AvaTax
|
|
116
125
|
# ### Security Policies
|
117
126
|
#
|
118
127
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
119
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
128
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
120
129
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
121
130
|
# @param id [Integer] The unique ID number of this certificate
|
122
131
|
# @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
|
-
# @return [Object]
|
124
|
-
def get_certificate(companyId, id, options={})
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
132
|
+
# @return [Object]
|
133
|
+
def get_certificate(companyId, id, options={})
|
134
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
135
|
+
get(path, options)
|
136
|
+
end
|
137
|
+
|
138
|
+
|
139
|
+
# Check a company's exemption certificate status.
|
140
|
+
#
|
129
141
|
# Checks whether this company is configured to use exemption certificates in AvaTax.
|
130
142
|
#
|
131
143
|
# Exemption certificates are tracked through a different auditable data store than the one that
|
@@ -137,14 +149,17 @@ module AvaTax
|
|
137
149
|
# ### Security Policies
|
138
150
|
#
|
139
151
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
140
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
152
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
141
153
|
# @param companyId [Integer] The company ID to check
|
142
|
-
# @return [Object]
|
143
|
-
def get_certificate_setup(companyId)
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
154
|
+
# @return [Object]
|
155
|
+
def get_certificate_setup(companyId)
|
156
|
+
path = "/api/v2/companies/#{companyId}/certificates/setup"
|
157
|
+
get(path)
|
158
|
+
end
|
159
|
+
|
160
|
+
|
161
|
+
# Link attributes to a certificate
|
162
|
+
#
|
148
163
|
# Link one or many attributes to a certificate.
|
149
164
|
#
|
150
165
|
# A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
|
@@ -163,16 +178,19 @@ module AvaTax
|
|
163
178
|
# ### Security Policies
|
164
179
|
#
|
165
180
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
166
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
181
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
167
182
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
168
183
|
# @param id [Integer] The unique ID number of this certificate
|
169
184
|
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
|
170
|
-
# @return [FetchResult]
|
171
|
-
def link_attributes_to_certificate(companyId, id, model)
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
185
|
+
# @return [FetchResult]
|
186
|
+
def link_attributes_to_certificate(companyId, id, model)
|
187
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
|
188
|
+
post(path, model)
|
189
|
+
end
|
190
|
+
|
191
|
+
|
192
|
+
# Link customers to a certificate
|
193
|
+
#
|
176
194
|
# Link one or more customers to an existing certificate.
|
177
195
|
#
|
178
196
|
# Customers and certificates must be linked before a customer can make use of a certificate to obtain
|
@@ -192,16 +210,19 @@ module AvaTax
|
|
192
210
|
# ### Security Policies
|
193
211
|
#
|
194
212
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
195
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
213
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
196
214
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
197
215
|
# @param id [Integer] The unique ID number of this certificate
|
198
216
|
# @param model [Object] The list of customers needed be added to the Certificate for exemption
|
199
|
-
# @return [FetchResult]
|
200
|
-
def link_customers_to_certificate(companyId, id, model)
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
217
|
+
# @return [FetchResult]
|
218
|
+
def link_customers_to_certificate(companyId, id, model)
|
219
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
|
220
|
+
post(path, model)
|
221
|
+
end
|
222
|
+
|
223
|
+
|
224
|
+
# List all attributes applied to this certificate
|
225
|
+
#
|
205
226
|
# Retrieve the list of attributes that are linked to this certificate.
|
206
227
|
#
|
207
228
|
# A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
|
@@ -220,15 +241,18 @@ module AvaTax
|
|
220
241
|
# ### Security Policies
|
221
242
|
#
|
222
243
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
223
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
244
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
224
245
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
225
246
|
# @param id [Integer] The unique ID number of this certificate
|
226
|
-
# @return [FetchResult]
|
227
|
-
def list_attributes_for_certificate(companyId, id)
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
247
|
+
# @return [FetchResult]
|
248
|
+
def list_attributes_for_certificate(companyId, id)
|
249
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
|
250
|
+
get(path)
|
251
|
+
end
|
252
|
+
|
253
|
+
|
254
|
+
# List customers linked to this certificate
|
255
|
+
#
|
232
256
|
# List all customers linked to this certificate.
|
233
257
|
#
|
234
258
|
# Customers must be linked to a certificate in order to make use of its tax exemption features. You
|
@@ -247,16 +271,19 @@ module AvaTax
|
|
247
271
|
# ### Security Policies
|
248
272
|
#
|
249
273
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
250
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
274
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
251
275
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
252
276
|
# @param id [Integer] The unique ID number of this certificate
|
253
277
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
|
254
|
-
# @return [FetchResult]
|
255
|
-
def list_customers_for_certificate(companyId, id, options={})
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
278
|
+
# @return [FetchResult]
|
279
|
+
def list_customers_for_certificate(companyId, id, options={})
|
280
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
|
281
|
+
get(path, options)
|
282
|
+
end
|
283
|
+
|
284
|
+
|
285
|
+
# List all certificates for a company
|
286
|
+
#
|
260
287
|
# List all certificates recorded by a company
|
261
288
|
#
|
262
289
|
# A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
|
@@ -278,19 +305,22 @@ module AvaTax
|
|
278
305
|
# ### Security Policies
|
279
306
|
#
|
280
307
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
281
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
308
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
282
309
|
# @param companyId [Integer] The ID number of the company to search
|
283
310
|
# @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
311
|
# @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
|
285
312
|
# @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.
|
286
313
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
287
314
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
288
|
-
# @return [FetchResult]
|
289
|
-
def query_certificates(companyId, options={})
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
315
|
+
# @return [FetchResult]
|
316
|
+
def query_certificates(companyId, options={})
|
317
|
+
path = "/api/v2/companies/#{companyId}/certificates"
|
318
|
+
get(path, options)
|
319
|
+
end
|
320
|
+
|
321
|
+
|
322
|
+
# Request setup of exemption certificates for this company.
|
323
|
+
#
|
294
324
|
# Requests the setup of exemption certificates for this company.
|
295
325
|
#
|
296
326
|
# Exemption certificates are tracked through a different auditable data store than the one that
|
@@ -304,14 +334,17 @@ module AvaTax
|
|
304
334
|
# ### Security Policies
|
305
335
|
#
|
306
336
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
307
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
337
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
308
338
|
# @param companyId [Integer]
|
309
|
-
# @return [Object]
|
310
|
-
def request_certificate_setup(companyId)
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
339
|
+
# @return [Object]
|
340
|
+
def request_certificate_setup(companyId)
|
341
|
+
path = "/api/v2/companies/#{companyId}/certificates/setup"
|
342
|
+
post(path)
|
343
|
+
end
|
344
|
+
|
345
|
+
|
346
|
+
# Unlink attributes from a certificate
|
347
|
+
#
|
315
348
|
# Unlink one or many attributes from a certificate.
|
316
349
|
#
|
317
350
|
# A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
|
@@ -330,16 +363,19 @@ module AvaTax
|
|
330
363
|
# ### Security Policies
|
331
364
|
#
|
332
365
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
333
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
366
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
334
367
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
335
368
|
# @param id [Integer] The unique ID number of this certificate
|
336
369
|
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
|
337
|
-
# @return [FetchResult]
|
338
|
-
def unlink_attributes_from_certificate(companyId, id, model)
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
370
|
+
# @return [FetchResult]
|
371
|
+
def unlink_attributes_from_certificate(companyId, id, model)
|
372
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
|
373
|
+
post(path, model)
|
374
|
+
end
|
375
|
+
|
376
|
+
|
377
|
+
# Unlink customers from a certificate
|
378
|
+
#
|
343
379
|
# Unlinks one or more customers from a certificate.
|
344
380
|
#
|
345
381
|
# Unlinking a certificate from a customer will prevent the certificate from being used to generate
|
@@ -360,16 +396,19 @@ module AvaTax
|
|
360
396
|
# ### Security Policies
|
361
397
|
#
|
362
398
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
363
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
399
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
364
400
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
365
401
|
# @param id [Integer] The unique ID number of this certificate
|
366
402
|
# @param model [Object] The list of customers to unlink from this certificate
|
367
|
-
# @return [FetchResult]
|
368
|
-
def unlink_customers_from_certificate(companyId, id, model)
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
403
|
+
# @return [FetchResult]
|
404
|
+
def unlink_customers_from_certificate(companyId, id, model)
|
405
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
|
406
|
+
post(path, model)
|
407
|
+
end
|
408
|
+
|
409
|
+
|
410
|
+
# Update a single certificate
|
411
|
+
#
|
373
412
|
# Replace the certificate identified by this URL with a new one.
|
374
413
|
#
|
375
414
|
# A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
|
@@ -385,16 +424,19 @@ module AvaTax
|
|
385
424
|
# ### Security Policies
|
386
425
|
#
|
387
426
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
388
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
427
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
389
428
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
390
429
|
# @param id [Integer] The unique ID number of this certificate
|
391
430
|
# @param model [Object] The new certificate object that will replace the existing one
|
392
|
-
# @return [Object]
|
393
|
-
def update_certificate(companyId, id, model)
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
431
|
+
# @return [Object]
|
432
|
+
def update_certificate(companyId, id, model)
|
433
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
434
|
+
put(path, model)
|
435
|
+
end
|
436
|
+
|
437
|
+
|
438
|
+
# Upload an image or PDF attachment for this certificate
|
439
|
+
#
|
398
440
|
# Upload an image or PDF attachment for this certificate.
|
399
441
|
#
|
400
442
|
# Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please
|
@@ -413,13 +455,16 @@ module AvaTax
|
|
413
455
|
# ### Security Policies
|
414
456
|
#
|
415
457
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
416
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
458
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
417
459
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
418
460
|
# @param id [Integer] The unique ID number of this certificate
|
419
461
|
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
|
420
|
-
# @return [String]
|
421
|
-
def upload_certificate_image(companyId, id)
|
422
|
-
|
423
|
-
|
424
|
-
|
462
|
+
# @return [String]
|
463
|
+
def upload_certificate_image(companyId, id)
|
464
|
+
path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
|
465
|
+
post(path)
|
466
|
+
end
|
467
|
+
|
468
|
+
end
|
469
|
+
end
|
425
470
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Companies
|
4
|
-
|
5
|
-
|
6
|
-
# Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Companies
|
4
|
+
|
5
|
+
|
6
|
+
# Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
|
7
|
+
#
|
8
8
|
# Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations.
|
9
9
|
# For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the
|
10
10
|
# written integrations for a company are sufficient enough to be delivered to the respective customers to start using it.
|
@@ -31,14 +31,17 @@ module AvaTax
|
|
31
31
|
#
|
32
32
|
# ### Security Policies
|
33
33
|
#
|
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.
|
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
35
|
# @param id [Integer] The ID of the company to check if its integration is certified.
|
36
|
-
# @return [String]
|
37
|
-
def certify_integration(id)
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
36
|
+
# @return [String]
|
37
|
+
def certify_integration(id)
|
38
|
+
path = "/api/v2/companies/#{id}/certify"
|
39
|
+
get(path)
|
40
|
+
end
|
41
|
+
|
42
|
+
|
43
|
+
# Change the filing status of this company
|
44
|
+
#
|
42
45
|
# Changes the current filing status of this company.
|
43
46
|
#
|
44
47
|
# For customers using Avalara's Managed Returns Service, each company within their account can request
|
@@ -55,15 +58,18 @@ module AvaTax
|
|
55
58
|
#
|
56
59
|
# ### Security Policies
|
57
60
|
#
|
58
|
-
# * 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.
|
61
|
+
# * 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.
|
59
62
|
# @param id [Integer]
|
60
63
|
# @param model [Object]
|
61
|
-
# @return [String]
|
62
|
-
def change_filing_status(id, model)
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
64
|
+
# @return [String]
|
65
|
+
def change_filing_status(id, model)
|
66
|
+
path = "/api/v2/companies/#{id}/filingstatus"
|
67
|
+
post(path, model)
|
68
|
+
end
|
69
|
+
|
70
|
+
|
71
|
+
# Quick setup for a company with a single physical address
|
72
|
+
#
|
67
73
|
# Shortcut to quickly setup a single-physical-location company with critical information and activate it.
|
68
74
|
# This API provides quick and simple company setup functionality and does the following things:
|
69
75
|
#
|
@@ -79,14 +85,17 @@ module AvaTax
|
|
79
85
|
#
|
80
86
|
# ### Security Policies
|
81
87
|
#
|
82
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
88
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
83
89
|
# @param model [Object] Information about the company you wish to create.
|
84
|
-
# @return [Object]
|
85
|
-
def company_initialize(model)
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
+
# @return [Object]
|
91
|
+
def company_initialize(model)
|
92
|
+
path = "/api/v2/companies/initialize"
|
93
|
+
post(path, model)
|
94
|
+
end
|
95
|
+
|
96
|
+
|
97
|
+
# Create new companies
|
98
|
+
#
|
90
99
|
# Create one or more new company objects.
|
91
100
|
# A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
|
92
101
|
# You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
|
@@ -95,14 +104,17 @@ module AvaTax
|
|
95
104
|
#
|
96
105
|
# ### Security Policies
|
97
106
|
#
|
98
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
107
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
99
108
|
# @param model [CompanyModel[]] Either a single company object or an array of companies to create
|
100
|
-
# @return [CompanyModel[]]
|
101
|
-
def create_companies(model)
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
109
|
+
# @return [CompanyModel[]]
|
110
|
+
def create_companies(model)
|
111
|
+
path = "/api/v2/companies"
|
112
|
+
post(path, model)
|
113
|
+
end
|
114
|
+
|
115
|
+
|
116
|
+
# Request managed returns funding setup for a company
|
117
|
+
#
|
106
118
|
# This API is available by invitation only.
|
107
119
|
# Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
|
108
120
|
# required to setup their funding configuration before Avalara can begin filing tax returns on their
|
@@ -117,27 +129,33 @@ module AvaTax
|
|
117
129
|
# ### Security Policies
|
118
130
|
#
|
119
131
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
120
|
-
# * 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.
|
132
|
+
# * 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.
|
121
133
|
# @param id [Integer] The unique identifier of the company
|
122
134
|
# @param model [Object] The funding initialization request
|
123
|
-
# @return [Object]
|
124
|
-
def create_funding_request(id, model)
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
135
|
+
# @return [Object]
|
136
|
+
def create_funding_request(id, model)
|
137
|
+
path = "/api/v2/companies/#{id}/funding/setup"
|
138
|
+
post(path, model)
|
139
|
+
end
|
140
|
+
|
141
|
+
|
142
|
+
# Delete a single company
|
143
|
+
#
|
129
144
|
# Deleting a company will delete all child companies, and all users attached to this company.
|
130
145
|
#
|
131
146
|
# ### Security Policies
|
132
147
|
#
|
133
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
148
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
134
149
|
# @param id [Integer] The ID of the company you wish to delete.
|
135
|
-
# @return [ErrorDetail[]]
|
136
|
-
def delete_company(id)
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
150
|
+
# @return [ErrorDetail[]]
|
151
|
+
def delete_company(id)
|
152
|
+
path = "/api/v2/companies/#{id}"
|
153
|
+
delete(path)
|
154
|
+
end
|
155
|
+
|
156
|
+
|
157
|
+
# Check the funding configuration of a company
|
158
|
+
#
|
141
159
|
# This API is available by invitation only.
|
142
160
|
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
143
161
|
# Returns the funding configuration of the requested company.
|
@@ -146,14 +164,17 @@ module AvaTax
|
|
146
164
|
# ### Security Policies
|
147
165
|
#
|
148
166
|
# * 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
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
167
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
150
168
|
# @param companyId [Integer] The unique identifier of the company
|
151
|
-
# @return [Object]
|
152
|
-
def funding_configuration_by_company(companyId)
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
169
|
+
# @return [Object]
|
170
|
+
def funding_configuration_by_company(companyId)
|
171
|
+
path = "/api/v2/companies/#{companyId}/funding/configuration"
|
172
|
+
get(path)
|
173
|
+
end
|
174
|
+
|
175
|
+
|
176
|
+
# Check the funding configuration of a company
|
177
|
+
#
|
157
178
|
# This API is available by invitation only.
|
158
179
|
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
159
180
|
# Returns the funding configuration of the requested company.
|
@@ -162,15 +183,18 @@ module AvaTax
|
|
162
183
|
# ### Security Policies
|
163
184
|
#
|
164
185
|
# * 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.
|
165
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
186
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
166
187
|
# @param companyId [Integer] The unique identifier of the company
|
167
188
|
# @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
|
168
|
-
# @return [FundingConfigurationModel[]]
|
169
|
-
def funding_configurations_by_company_and_currency(companyId, options={})
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
189
|
+
# @return [FundingConfigurationModel[]]
|
190
|
+
def funding_configurations_by_company_and_currency(companyId, options={})
|
191
|
+
path = "/api/v2/companies/#{companyId}/funding/configurations"
|
192
|
+
get(path, options)
|
193
|
+
end
|
194
|
+
|
195
|
+
|
196
|
+
# Retrieve a single company
|
197
|
+
#
|
174
198
|
# Get the company object identified by this URL.
|
175
199
|
# A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
|
176
200
|
# You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
|
@@ -187,15 +211,18 @@ module AvaTax
|
|
187
211
|
#
|
188
212
|
# ### Security Policies
|
189
213
|
#
|
190
|
-
# * 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.
|
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.
|
191
215
|
# @param id [Integer] The ID of the company to retrieve.
|
192
216
|
# @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.
|
193
|
-
# @return [Object]
|
194
|
-
def get_company(id, options={})
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
217
|
+
# @return [Object]
|
218
|
+
def get_company(id, options={})
|
219
|
+
path = "/api/v2/companies/#{id}"
|
220
|
+
get(path, options)
|
221
|
+
end
|
222
|
+
|
223
|
+
|
224
|
+
# Get configuration settings for this company
|
225
|
+
#
|
199
226
|
# Retrieve a list of all configuration settings tied to this company.
|
200
227
|
#
|
201
228
|
# Configuration settings provide you with the ability to control features of your account and of your
|
@@ -211,14 +238,17 @@ module AvaTax
|
|
211
238
|
#
|
212
239
|
# ### Security Policies
|
213
240
|
#
|
214
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
241
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
215
242
|
# @param id [Integer]
|
216
|
-
# @return [CompanyConfigurationModel[]]
|
217
|
-
def get_company_configuration(id)
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
243
|
+
# @return [CompanyConfigurationModel[]]
|
244
|
+
def get_company_configuration(id)
|
245
|
+
path = "/api/v2/companies/#{id}/configuration"
|
246
|
+
get(path)
|
247
|
+
end
|
248
|
+
|
249
|
+
|
250
|
+
# Get this company's filing status
|
251
|
+
#
|
222
252
|
# Retrieve the current filing status of this company.
|
223
253
|
#
|
224
254
|
# For customers using Avalara's Managed Returns Service, each company within their account can request
|
@@ -235,14 +265,17 @@ module AvaTax
|
|
235
265
|
#
|
236
266
|
# ### Security Policies
|
237
267
|
#
|
238
|
-
# * 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.
|
268
|
+
# * 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.
|
239
269
|
# @param id [Integer]
|
240
|
-
# @return [String]
|
241
|
-
def get_filing_status(id)
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
270
|
+
# @return [String]
|
271
|
+
def get_filing_status(id)
|
272
|
+
path = "/api/v2/companies/#{id}/filingstatus"
|
273
|
+
get(path)
|
274
|
+
end
|
275
|
+
|
276
|
+
|
277
|
+
# Check managed returns funding status for a company
|
278
|
+
#
|
246
279
|
# This API is available by invitation only.
|
247
280
|
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
248
281
|
# Returns a list of funding setup requests and their current status.
|
@@ -251,27 +284,33 @@ module AvaTax
|
|
251
284
|
# ### Security Policies
|
252
285
|
#
|
253
286
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
254
|
-
# * 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.
|
287
|
+
# * 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.
|
255
288
|
# @param id [Integer] The unique identifier of the company
|
256
|
-
# @return [FundingStatusModel[]]
|
257
|
-
def list_funding_requests_by_company(id)
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
289
|
+
# @return [FundingStatusModel[]]
|
290
|
+
def list_funding_requests_by_company(id)
|
291
|
+
path = "/api/v2/companies/#{id}/funding"
|
292
|
+
get(path)
|
293
|
+
end
|
294
|
+
|
295
|
+
|
296
|
+
# Retrieve a list of MRS Companies with account
|
297
|
+
#
|
262
298
|
# This API is available by invitation only.
|
263
299
|
#
|
264
300
|
# Get a list of companies with an active MRS service.
|
265
301
|
#
|
266
302
|
# ### Security Policies
|
267
303
|
#
|
268
|
-
# * 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.
|
269
|
-
# @return [FetchResult]
|
270
|
-
def list_mrs_companies()
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
304
|
+
# * 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.
|
305
|
+
# @return [FetchResult]
|
306
|
+
def list_mrs_companies()
|
307
|
+
path = "/api/v2/companies/mrs"
|
308
|
+
get(path)
|
309
|
+
end
|
310
|
+
|
311
|
+
|
312
|
+
# Retrieve all companies
|
313
|
+
#
|
275
314
|
# Get multiple company objects.
|
276
315
|
#
|
277
316
|
# A `company` represents a single corporation or individual that is registered to handle transactional taxes.
|
@@ -292,18 +331,21 @@ module AvaTax
|
|
292
331
|
#
|
293
332
|
# ### Security Policies
|
294
333
|
#
|
295
|
-
# * 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.
|
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.
|
296
335
|
# @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.
|
297
336
|
# @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
|
298
337
|
# @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.
|
299
338
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
300
339
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
301
|
-
# @return [FetchResult]
|
302
|
-
def query_companies(options={})
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
340
|
+
# @return [FetchResult]
|
341
|
+
def query_companies(options={})
|
342
|
+
path = "/api/v2/companies"
|
343
|
+
get(path, options)
|
344
|
+
end
|
345
|
+
|
346
|
+
|
347
|
+
# Change configuration settings for this company
|
348
|
+
#
|
307
349
|
# Update configuration settings tied to this company.
|
308
350
|
#
|
309
351
|
# Configuration settings provide you with the ability to control features of your account and of your
|
@@ -319,15 +361,18 @@ module AvaTax
|
|
319
361
|
#
|
320
362
|
# ### Security Policies
|
321
363
|
#
|
322
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
364
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
323
365
|
# @param id [Integer]
|
324
366
|
# @param model [CompanyConfigurationModel[]]
|
325
|
-
# @return [CompanyConfigurationModel[]]
|
326
|
-
def set_company_configuration(id, model)
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
367
|
+
# @return [CompanyConfigurationModel[]]
|
368
|
+
def set_company_configuration(id, model)
|
369
|
+
path = "/api/v2/companies/#{id}/configuration"
|
370
|
+
post(path, model)
|
371
|
+
end
|
372
|
+
|
373
|
+
|
374
|
+
# Update a single company
|
375
|
+
#
|
331
376
|
# Replace the existing company object at this URL with an updated object.
|
332
377
|
#
|
333
378
|
# A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes.
|
@@ -342,12 +387,15 @@ module AvaTax
|
|
342
387
|
#
|
343
388
|
# ### Security Policies
|
344
389
|
#
|
345
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
390
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
346
391
|
# @param id [Integer] The ID of the company you wish to update.
|
347
392
|
# @param model [Object] The company object you wish to update.
|
348
|
-
# @return [Object]
|
349
|
-
def update_company(id, model)
|
350
|
-
|
351
|
-
|
352
|
-
|
393
|
+
# @return [Object]
|
394
|
+
def update_company(id, model)
|
395
|
+
path = "/api/v2/companies/#{id}"
|
396
|
+
put(path, model)
|
397
|
+
end
|
398
|
+
|
399
|
+
end
|
400
|
+
end
|
353
401
|
end
|