avatax 23.3.0 → 23.4.1
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 +6 -6
- data/lib/avatax/client/companies.rb +14 -14
- data/lib/avatax/client/datasources.rb +3 -3
- data/lib/avatax/client/definitions.rb +16 -3
- data/lib/avatax/client/ecommercetoken.rb +2 -2
- data/lib/avatax/client/firmclientlinkages.rb +2 -2
- data/lib/avatax/client/fundingrequests.rb +1 -1
- data/lib/avatax/client/locations.rb +6 -6
- data/lib/avatax/client/notifications.rb +3 -3
- data/lib/avatax/client/registrar.rb +1 -1
- data/lib/avatax/client/settings.rb +3 -3
- data/lib/avatax/client/taxcodes.rb +3 -3
- data/lib/avatax/client/taxcontent.rb +3 -3
- data/lib/avatax/client/userdefinedfields.rb +1 -1
- data/lib/avatax/client/users.rb +4 -4
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1a7b6f6511b3ab49959a399340046d61a121066f136b93f77645b46cb109173f
|
|
4
|
+
data.tar.gz: 88b98f1671e8ab451b9cc3f181db617e3e0158189a4efb7961e99ae59c6233b3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: aead5df9e3dd85139f492a957d3c1877d31ce4ce747c14fdbc5430b91d437ca572ebe901cb815abc932ffbf184193d6cc52f148b657eca946c1c0f1320a8eebe
|
|
7
|
+
data.tar.gz: 32a3ac9b4a97e675c716d0328e47fbee372c2abcf0916bd4e345bf5c6871859c4a77b8f77676144a1e43b7890046553b31224a0828436c3312cc43af59560897
|
|
@@ -72,7 +72,7 @@ module AvaTax
|
|
|
72
72
|
#
|
|
73
73
|
# ### Security Policies
|
|
74
74
|
#
|
|
75
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
75
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
76
76
|
# Swagger Name: AvaTaxClient
|
|
77
77
|
# @param id [Integer] The ID of the account you wish to audit.
|
|
78
78
|
# @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
|
|
@@ -134,7 +134,7 @@ module AvaTax
|
|
|
134
134
|
#
|
|
135
135
|
# ### Security Policies
|
|
136
136
|
#
|
|
137
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
137
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
138
138
|
# Swagger Name: AvaTaxClient
|
|
139
139
|
# @param id [Integer] The ID of the account to retrieve
|
|
140
140
|
# @param include [String] A comma separated list of special fetch options
|
|
@@ -159,7 +159,7 @@ module AvaTax
|
|
|
159
159
|
#
|
|
160
160
|
# ### Security Policies
|
|
161
161
|
#
|
|
162
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
162
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
163
163
|
# Swagger Name: AvaTaxClient
|
|
164
164
|
# @param id [Integer]
|
|
165
165
|
# @return [AccountConfigurationModel[]]
|
|
@@ -170,7 +170,7 @@ module AvaTax
|
|
|
170
170
|
#
|
|
171
171
|
# ### Security Policies
|
|
172
172
|
#
|
|
173
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
173
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
174
174
|
# Swagger Name: AvaTaxClient
|
|
175
175
|
# @param id [Integer] The ID of the account to retrieve
|
|
176
176
|
# @param licensekeyname [String] The ID of the account to retrieve
|
|
@@ -184,7 +184,7 @@ module AvaTax
|
|
|
184
184
|
#
|
|
185
185
|
# ### Security Policies
|
|
186
186
|
#
|
|
187
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
187
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
188
188
|
# Swagger Name: AvaTaxClient
|
|
189
189
|
# @param id [Integer] The ID of the account to retrieve
|
|
190
190
|
# @return [AccountLicenseKeyModel[]]
|
|
@@ -208,7 +208,7 @@ module AvaTax
|
|
|
208
208
|
#
|
|
209
209
|
# ### Security Policies
|
|
210
210
|
#
|
|
211
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
211
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
212
212
|
# Swagger Name: AvaTaxClient
|
|
213
213
|
# @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
|
|
214
214
|
# @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:* subscriptions, users
|
|
@@ -31,7 +31,7 @@ module AvaTax
|
|
|
31
31
|
#
|
|
32
32
|
# ### Security Policies
|
|
33
33
|
#
|
|
34
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
34
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
35
35
|
# Swagger Name: AvaTaxClient
|
|
36
36
|
# @param id [Integer] The ID of the company to check if its integration is certified.
|
|
37
37
|
# @return [String]
|
|
@@ -56,7 +56,7 @@ module AvaTax
|
|
|
56
56
|
#
|
|
57
57
|
# ### Security Policies
|
|
58
58
|
#
|
|
59
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
59
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
60
60
|
# Swagger Name: AvaTaxClient
|
|
61
61
|
# @param id [Integer]
|
|
62
62
|
# @param model [Object]
|
|
@@ -145,7 +145,7 @@ module AvaTax
|
|
|
145
145
|
# ### Security Policies
|
|
146
146
|
#
|
|
147
147
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
148
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
148
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
149
149
|
# Swagger Name: AvaTaxClient
|
|
150
150
|
# @param id [Integer] The unique identifier of the company
|
|
151
151
|
# @param businessUnit [String] The company's business unit (See POABusinessUnit::* for a list of allowable values)
|
|
@@ -196,7 +196,7 @@ module AvaTax
|
|
|
196
196
|
#
|
|
197
197
|
# ### Security Policies
|
|
198
198
|
#
|
|
199
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
199
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
200
200
|
# * 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.
|
|
201
201
|
# Swagger Name: AvaTaxClient
|
|
202
202
|
# @param companyId [Integer] The unique identifier of the company
|
|
@@ -213,7 +213,7 @@ module AvaTax
|
|
|
213
213
|
#
|
|
214
214
|
# ### Security Policies
|
|
215
215
|
#
|
|
216
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
216
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
217
217
|
# * 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.
|
|
218
218
|
# Swagger Name: AvaTaxClient
|
|
219
219
|
# @param companyId [Integer] The unique identifier of the company
|
|
@@ -240,7 +240,7 @@ module AvaTax
|
|
|
240
240
|
#
|
|
241
241
|
# ### Security Policies
|
|
242
242
|
#
|
|
243
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
243
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
244
244
|
# Swagger Name: AvaTaxClient
|
|
245
245
|
# @param id [Integer] The ID of the company to retrieve.
|
|
246
246
|
# @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.
|
|
@@ -265,7 +265,7 @@ module AvaTax
|
|
|
265
265
|
#
|
|
266
266
|
# ### Security Policies
|
|
267
267
|
#
|
|
268
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
268
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
269
269
|
# Swagger Name: AvaTaxClient
|
|
270
270
|
# @param id [Integer]
|
|
271
271
|
# @return [CompanyConfigurationModel[]]
|
|
@@ -284,7 +284,7 @@ module AvaTax
|
|
|
284
284
|
#
|
|
285
285
|
# ### Security Policies
|
|
286
286
|
#
|
|
287
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
287
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
288
288
|
# Swagger Name: AvaTaxClient
|
|
289
289
|
# @param companyId [Integer]
|
|
290
290
|
# @param id [Integer]
|
|
@@ -311,7 +311,7 @@ module AvaTax
|
|
|
311
311
|
#
|
|
312
312
|
# ### Security Policies
|
|
313
313
|
#
|
|
314
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
314
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
315
315
|
# Swagger Name: AvaTaxClient
|
|
316
316
|
# @param id [Integer]
|
|
317
317
|
# @return [String]
|
|
@@ -328,7 +328,7 @@ module AvaTax
|
|
|
328
328
|
# ### Security Policies
|
|
329
329
|
#
|
|
330
330
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
331
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
331
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
332
332
|
# Swagger Name: AvaTaxClient
|
|
333
333
|
# @param id [Integer] The unique identifier of the company
|
|
334
334
|
# @param periodyear [Integer] The period year
|
|
@@ -352,7 +352,7 @@ module AvaTax
|
|
|
352
352
|
#
|
|
353
353
|
# ### Security Policies
|
|
354
354
|
#
|
|
355
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
355
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
356
356
|
# Swagger Name: AvaTaxClient
|
|
357
357
|
# @param companyId [Integer] The company id
|
|
358
358
|
# @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
|
|
@@ -373,7 +373,7 @@ module AvaTax
|
|
|
373
373
|
# ### Security Policies
|
|
374
374
|
#
|
|
375
375
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
376
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
376
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
377
377
|
# Swagger Name: AvaTaxClient
|
|
378
378
|
# @param id [Integer] The unique identifier of the company
|
|
379
379
|
# @return [FundingStatusModel[]]
|
|
@@ -388,7 +388,7 @@ module AvaTax
|
|
|
388
388
|
#
|
|
389
389
|
# ### Security Policies
|
|
390
390
|
#
|
|
391
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
391
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
392
392
|
# Swagger Name: AvaTaxClient
|
|
393
393
|
# @return [FetchResult]
|
|
394
394
|
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
|
@@ -416,7 +416,7 @@ module AvaTax
|
|
|
416
416
|
#
|
|
417
417
|
# ### Security Policies
|
|
418
418
|
#
|
|
419
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
419
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
420
420
|
# Swagger Name: AvaTaxClient
|
|
421
421
|
# @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.
|
|
422
422
|
# @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
|
|
@@ -39,7 +39,7 @@ module AvaTax
|
|
|
39
39
|
#
|
|
40
40
|
# ### Security Policies
|
|
41
41
|
#
|
|
42
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
42
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
43
43
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
|
44
44
|
# Swagger Name: AvaTaxClient
|
|
45
45
|
# @param companyId [Integer]
|
|
@@ -54,7 +54,7 @@ module AvaTax
|
|
|
54
54
|
#
|
|
55
55
|
# ### Security Policies
|
|
56
56
|
#
|
|
57
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
57
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
58
58
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
|
59
59
|
# Swagger Name: AvaTaxClient
|
|
60
60
|
# @param companyId [Integer] The id of the company you wish to retrieve the datasources.
|
|
@@ -75,7 +75,7 @@ module AvaTax
|
|
|
75
75
|
#
|
|
76
76
|
# ### Security Policies
|
|
77
77
|
#
|
|
78
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
78
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
79
79
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
|
80
80
|
# Swagger Name: AvaTaxClient
|
|
81
81
|
# @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:* isEnabled, isSynced, isAuthorized, name, externalState
|
|
@@ -305,7 +305,7 @@ module AvaTax
|
|
|
305
305
|
#
|
|
306
306
|
# The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
|
|
307
307
|
# Swagger Name: AvaTaxClient
|
|
308
|
-
# @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:* rate, salesRate, signatureCode, useRate
|
|
308
|
+
# @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:* rate, salesRate, signatureCode, useRate, isAcm, isSst
|
|
309
309
|
# @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.
|
|
310
310
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
311
311
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -676,6 +676,19 @@ module AvaTax
|
|
|
676
676
|
def list_parameters(options={}) path = "/api/v2/definitions/parameters"
|
|
677
677
|
get(path, options, AvaTax::VERSION) end
|
|
678
678
|
|
|
679
|
+
# Retrieve the list of Avalara-supported parameters based on account subscriptions.
|
|
680
|
+
#
|
|
681
|
+
# Returns the list of Avalara-supported parameters based on account subscriptions.
|
|
682
|
+
# Swagger Name: AvaTaxClient
|
|
683
|
+
# @param accountId [Integer] The ID of the account to retrieve the parameters.
|
|
684
|
+
# @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:* serviceTypes, regularExpression, values
|
|
685
|
+
# @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.
|
|
686
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
687
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
688
|
+
# @return [FetchResult]
|
|
689
|
+
def list_parameters_by_account(accountId, options={}) path = "/api/v2/definitions/accounts/#{accountId}/parameters"
|
|
690
|
+
get(path, options, AvaTax::VERSION) end
|
|
691
|
+
|
|
679
692
|
# Retrieve the parameters by companyCode and itemCode.
|
|
680
693
|
#
|
|
681
694
|
# Returns the list of parameters based on the company's service types and the item code.
|
|
@@ -931,7 +944,7 @@ module AvaTax
|
|
|
931
944
|
# You may always contact Avalara's sales department for information on available products or services.
|
|
932
945
|
# You cannot change your subscriptions directly through the API.
|
|
933
946
|
# Swagger Name: AvaTaxClient
|
|
934
|
-
# @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/)
|
|
947
|
+
# @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:* taxTypeGroupIdSK
|
|
935
948
|
# @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.
|
|
936
949
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
937
950
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -1002,7 +1015,7 @@ module AvaTax
|
|
|
1002
1015
|
#
|
|
1003
1016
|
# ### Security Policies
|
|
1004
1017
|
#
|
|
1005
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
1018
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
1006
1019
|
# Swagger Name: AvaTaxClient
|
|
1007
1020
|
# @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/).
|
|
1008
1021
|
# @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.
|
|
@@ -11,7 +11,7 @@ module AvaTax
|
|
|
11
11
|
#
|
|
12
12
|
# ### Security Policies
|
|
13
13
|
#
|
|
14
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
14
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
15
15
|
# Swagger Name: AvaTaxClient
|
|
16
16
|
# @param companyId [Integer] The company ID that will be issued this certificate.
|
|
17
17
|
# @param model [Object]
|
|
@@ -27,7 +27,7 @@ module AvaTax
|
|
|
27
27
|
#
|
|
28
28
|
# ### Security Policies
|
|
29
29
|
#
|
|
30
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
31
31
|
# Swagger Name: AvaTaxClient
|
|
32
32
|
# @param companyId [Integer] The company ID that the refreshed certificate belongs to.
|
|
33
33
|
# @param model [Object]
|
|
@@ -70,7 +70,7 @@ module AvaTax
|
|
|
70
70
|
#
|
|
71
71
|
# ### Security Policies
|
|
72
72
|
#
|
|
73
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
73
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
74
74
|
# Swagger Name: AvaTaxClient
|
|
75
75
|
# @param id [Integer]
|
|
76
76
|
# @return [Object]
|
|
@@ -83,7 +83,7 @@ module AvaTax
|
|
|
83
83
|
#
|
|
84
84
|
# ### Security Policies
|
|
85
85
|
#
|
|
86
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
86
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
87
87
|
# Swagger Name: AvaTaxClient
|
|
88
88
|
# @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:* firmAccountName, clientAccountName
|
|
89
89
|
# @return [FetchResult]
|
|
@@ -20,7 +20,7 @@ module AvaTax
|
|
|
20
20
|
#
|
|
21
21
|
# ### Security Policies
|
|
22
22
|
#
|
|
23
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
23
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
24
24
|
# * 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.
|
|
25
25
|
# Swagger Name: AvaTaxClient
|
|
26
26
|
# @param id [Integer] The unique ID number of this funding request
|
|
@@ -92,7 +92,7 @@ module AvaTax
|
|
|
92
92
|
#
|
|
93
93
|
# ### Security Policies
|
|
94
94
|
#
|
|
95
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
95
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
96
96
|
# Swagger Name: AvaTaxClient
|
|
97
97
|
# @param companyId [Integer] The ID of the company that owns this location
|
|
98
98
|
# @param id [Integer] The primary key of this location
|
|
@@ -113,7 +113,7 @@ module AvaTax
|
|
|
113
113
|
#
|
|
114
114
|
# ### Security Policies
|
|
115
115
|
#
|
|
116
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
116
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
117
117
|
# Swagger Name: AvaTaxClient
|
|
118
118
|
# @param companyId [Integer] The company id
|
|
119
119
|
# @param locationId [Integer] The location id
|
|
@@ -137,7 +137,7 @@ module AvaTax
|
|
|
137
137
|
#
|
|
138
138
|
# ### Security Policies
|
|
139
139
|
#
|
|
140
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
140
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
141
141
|
# Swagger Name: AvaTaxClient
|
|
142
142
|
# @param companyId [Integer] The company id
|
|
143
143
|
# @param locationId [Integer] The ID of the location
|
|
@@ -166,7 +166,7 @@ module AvaTax
|
|
|
166
166
|
#
|
|
167
167
|
# ### Security Policies
|
|
168
168
|
#
|
|
169
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
169
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
170
170
|
# Swagger Name: AvaTaxClient
|
|
171
171
|
# @param companyId [Integer] The ID of the company that owns these locations
|
|
172
172
|
# @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:* isMarketplaceOutsideUsa, settings, parameters
|
|
@@ -196,7 +196,7 @@ module AvaTax
|
|
|
196
196
|
#
|
|
197
197
|
# ### Security Policies
|
|
198
198
|
#
|
|
199
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
199
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
200
200
|
# Swagger Name: AvaTaxClient
|
|
201
201
|
# @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:* isMarketplaceOutsideUsa, settings, parameters
|
|
202
202
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
|
@@ -254,7 +254,7 @@ module AvaTax
|
|
|
254
254
|
#
|
|
255
255
|
# ### Security Policies
|
|
256
256
|
#
|
|
257
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester,
|
|
257
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
258
258
|
# Swagger Name: AvaTaxClient
|
|
259
259
|
# @param companyId [Integer] The ID of the company that owns this location
|
|
260
260
|
# @param id [Integer] The primary key of this location
|
|
@@ -22,7 +22,7 @@ module AvaTax
|
|
|
22
22
|
#
|
|
23
23
|
# ### Security Policies
|
|
24
24
|
#
|
|
25
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
26
26
|
# Swagger Name: AvaTaxClient
|
|
27
27
|
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
|
28
28
|
# @return [Object]
|
|
@@ -42,7 +42,7 @@ module AvaTax
|
|
|
42
42
|
#
|
|
43
43
|
# ### Security Policies
|
|
44
44
|
#
|
|
45
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
45
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
46
46
|
# Swagger Name: AvaTaxClient
|
|
47
47
|
# @param id [Integer] The id of the notification to retrieve.
|
|
48
48
|
# @return [Object]
|
|
@@ -65,7 +65,7 @@ module AvaTax
|
|
|
65
65
|
#
|
|
66
66
|
# ### Security Policies
|
|
67
67
|
#
|
|
68
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
68
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
69
69
|
# Swagger Name: AvaTaxClient
|
|
70
70
|
# @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/).
|
|
71
71
|
# @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.
|
|
@@ -172,7 +172,7 @@ module AvaTax
|
|
|
172
172
|
#
|
|
173
173
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
174
174
|
# Swagger Name: AvaTaxClient
|
|
175
|
-
# @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/)
|
|
175
|
+
# @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:* taxTypeGroupIdSK
|
|
176
176
|
# @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.
|
|
177
177
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
178
178
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -69,7 +69,7 @@ module AvaTax
|
|
|
69
69
|
#
|
|
70
70
|
# ### Security Policies
|
|
71
71
|
#
|
|
72
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
72
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
73
73
|
# Swagger Name: AvaTaxClient
|
|
74
74
|
# @param companyId [Integer] The ID of the company that owns this setting
|
|
75
75
|
# @param id [Integer] The primary key of this setting
|
|
@@ -95,7 +95,7 @@ module AvaTax
|
|
|
95
95
|
#
|
|
96
96
|
# ### Security Policies
|
|
97
97
|
#
|
|
98
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
98
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
99
99
|
# Swagger Name: AvaTaxClient
|
|
100
100
|
# @param companyId [Integer] The ID of the company that owns these settings
|
|
101
101
|
# @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:* modifiedDate, ModifiedUserId
|
|
@@ -125,7 +125,7 @@ module AvaTax
|
|
|
125
125
|
#
|
|
126
126
|
# ### Security Policies
|
|
127
127
|
#
|
|
128
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
128
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
129
129
|
# Swagger Name: AvaTaxClient
|
|
130
130
|
# @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:* modifiedDate, ModifiedUserId
|
|
131
131
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
@@ -45,7 +45,7 @@ module AvaTax
|
|
|
45
45
|
#
|
|
46
46
|
# ### Security Policies
|
|
47
47
|
#
|
|
48
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
48
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
49
49
|
# Swagger Name: AvaTaxClient
|
|
50
50
|
# @param companyId [Integer] The ID of the company that owns this tax code
|
|
51
51
|
# @param id [Integer] The primary key of this tax code
|
|
@@ -66,7 +66,7 @@ module AvaTax
|
|
|
66
66
|
#
|
|
67
67
|
# ### Security Policies
|
|
68
68
|
#
|
|
69
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
69
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
70
70
|
# Swagger Name: AvaTaxClient
|
|
71
71
|
# @param companyId [Integer] The ID of the company that owns these tax codes
|
|
72
72
|
# @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/).
|
|
@@ -91,7 +91,7 @@ module AvaTax
|
|
|
91
91
|
#
|
|
92
92
|
# ### Security Policies
|
|
93
93
|
#
|
|
94
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
94
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
95
95
|
# Swagger Name: AvaTaxClient
|
|
96
96
|
# @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/).
|
|
97
97
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
@@ -31,7 +31,7 @@ module AvaTax
|
|
|
31
31
|
#
|
|
32
32
|
# ### Security Policies
|
|
33
33
|
#
|
|
34
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
34
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
35
35
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
|
36
36
|
# Swagger Name: AvaTaxClient
|
|
37
37
|
# @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
|
|
@@ -67,7 +67,7 @@ module AvaTax
|
|
|
67
67
|
#
|
|
68
68
|
# ### Security Policies
|
|
69
69
|
#
|
|
70
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
70
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
71
71
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
|
72
72
|
# Swagger Name: AvaTaxClient
|
|
73
73
|
# @param companyId [Integer] The ID number of the company that owns this location.
|
|
@@ -125,7 +125,7 @@ module AvaTax
|
|
|
125
125
|
#
|
|
126
126
|
# ### Security Policies
|
|
127
127
|
#
|
|
128
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
128
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
129
129
|
# Swagger Name: AvaTaxClient
|
|
130
130
|
# @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
|
|
131
131
|
# @param region [String] A two character region code which limits results to a specific region.
|
|
@@ -22,7 +22,7 @@ module AvaTax
|
|
|
22
22
|
#
|
|
23
23
|
# ### Security Policies
|
|
24
24
|
#
|
|
25
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
26
26
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
|
27
27
|
# Swagger Name: AvaTaxClient
|
|
28
28
|
# @param companyId [Integer]
|
data/lib/avatax/client/users.rb
CHANGED
|
@@ -74,7 +74,7 @@ module AvaTax
|
|
|
74
74
|
#
|
|
75
75
|
# ### Security Policies
|
|
76
76
|
#
|
|
77
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
77
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
78
78
|
# Swagger Name: AvaTaxClient
|
|
79
79
|
# @param id [Integer] The ID of the user to retrieve.
|
|
80
80
|
# @param accountId [Integer] The accountID of the user you wish to get.
|
|
@@ -103,7 +103,7 @@ module AvaTax
|
|
|
103
103
|
#
|
|
104
104
|
# ### Security Policies
|
|
105
105
|
#
|
|
106
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
106
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
107
107
|
# Swagger Name: AvaTaxClient
|
|
108
108
|
# @param id [Integer] The ID of the user to retrieve.
|
|
109
109
|
# @param accountId [Integer] The accountID of the user you wish to get.
|
|
@@ -128,7 +128,7 @@ module AvaTax
|
|
|
128
128
|
#
|
|
129
129
|
# ### Security Policies
|
|
130
130
|
#
|
|
131
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
131
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
132
132
|
# Swagger Name: AvaTaxClient
|
|
133
133
|
# @param accountId [Integer] The accountID of the user you wish to list.
|
|
134
134
|
# @param include [String] Optional fetch commands.
|
|
@@ -159,7 +159,7 @@ module AvaTax
|
|
|
159
159
|
#
|
|
160
160
|
# ### Security Policies
|
|
161
161
|
#
|
|
162
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester,
|
|
162
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
163
163
|
# Swagger Name: AvaTaxClient
|
|
164
164
|
# @param include [String] Optional fetch commands.
|
|
165
165
|
# @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:* SuppressNewUserEmail
|
data/lib/avatax/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: avatax
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 23.
|
|
4
|
+
version: 23.4.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Marcus Vorwaller
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
11
|
+
date: 2023-04-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|