avatax 21.10.0 → 21.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +22 -11
- data/lib/avatax/client/addresses.rb +4 -2
- data/lib/avatax/client/advancedrules.rb +10 -5
- data/lib/avatax/client/ageverification.rb +29 -0
- data/lib/avatax/client/avafileforms.rb +10 -5
- data/lib/avatax/client/batches.rb +16 -8
- data/lib/avatax/client/certexpressinvites.rb +6 -3
- data/lib/avatax/client/certificates.rb +30 -15
- data/lib/avatax/client/companies.rb +42 -21
- data/lib/avatax/client/compliance.rb +25 -14
- data/lib/avatax/client/contacts.rb +12 -6
- data/lib/avatax/client/customers.rb +26 -13
- data/lib/avatax/client/datasources.rb +12 -6
- data/lib/avatax/client/definitions.rb +140 -70
- data/lib/avatax/client/distancethresholds.rb +12 -6
- data/lib/avatax/client/ecommercetoken.rb +4 -2
- data/lib/avatax/client/filingcalendars.rb +7 -4
- data/lib/avatax/client/filings.rb +4 -2
- data/lib/avatax/client/firmclientlinkages.rb +18 -9
- data/lib/avatax/client/free.rb +2 -1
- data/lib/avatax/client/fundingrequests.rb +4 -2
- data/lib/avatax/client/items.rb +50 -25
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -6
- data/lib/avatax/client/locations.rb +24 -12
- data/lib/avatax/client/multidocument.rb +20 -10
- data/lib/avatax/client/nexus.rb +30 -15
- data/lib/avatax/client/notices.rb +8 -4
- data/lib/avatax/client/notifications.rb +6 -3
- data/lib/avatax/client/provisioning.rb +4 -2
- data/lib/avatax/client/registrar.rb +22 -11
- data/lib/avatax/client/reports.rb +8 -4
- data/lib/avatax/client/settings.rb +12 -6
- data/lib/avatax/client/shippingverification.rb +66 -0
- data/lib/avatax/client/subscriptions.rb +6 -3
- data/lib/avatax/client/taxcodes.rb +12 -6
- data/lib/avatax/client/taxcontent.rb +10 -5
- data/lib/avatax/client/taxrules.rb +12 -6
- data/lib/avatax/client/transactions.rb +42 -21
- data/lib/avatax/client/upcs.rb +12 -6
- data/lib/avatax/client/userdefinedfields.rb +52 -0
- data/lib/avatax/client/users.rb +16 -8
- data/lib/avatax/client/utilities.rb +6 -3
- data/lib/avatax/client.rb +2 -0
- data/lib/avatax/connection.rb +1 -1
- data/lib/avatax/request.rb +10 -9
- data/lib/avatax/version.rb +1 -1
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 62f49d825bf6bd825870f7df87c606ec1e9d4afb2a93aa207c7214292ca9b424
|
4
|
+
data.tar.gz: 8aacca31d349cf2ad9220e9d224a6845808427a928270cbf9dfcd02fcad5ab30
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ca88a41a374b5d9263fe643685b6f50e5804a56bbdc31683ade0a852da6917cb437b902beb348f87a71d374d4663f5bdd30f6167db14640b018529f381f3a9cc
|
7
|
+
data.tar.gz: df4b23a289e54ab84dc6fb9ee8828f4854ac31c9497c438c622e999d89e1b89f2a11aa6f734be6c8d0acd1660213d919a645c7a7660700d7bf49ca06a448c59f
|
@@ -23,11 +23,12 @@ module AvaTax
|
|
23
23
|
# ### Security Policies
|
24
24
|
#
|
25
25
|
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
|
+
# Swagger Name: AvaTaxClient
|
26
27
|
# @param id [Integer] The ID of the account you wish to update.
|
27
28
|
# @param model [Object] A request confirming that you wish to reset the license key of this account.
|
28
29
|
# @return [Object]
|
29
30
|
def account_reset_license_key(id, model) path = "/api/v2/accounts/#{id}/resetlicensekey"
|
30
|
-
post(path, model) end
|
31
|
+
post(path, model, {}, "21.12.0") end
|
31
32
|
|
32
33
|
# Activate an account by accepting terms and conditions
|
33
34
|
#
|
@@ -45,11 +46,12 @@ module AvaTax
|
|
45
46
|
# ### Security Policies
|
46
47
|
#
|
47
48
|
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
49
|
+
# Swagger Name: AvaTaxClient
|
48
50
|
# @param id [Integer] The ID of the account to activate
|
49
51
|
# @param model [Object] The activation request
|
50
52
|
# @return [Object]
|
51
53
|
def activate_account(id, model) path = "/api/v2/accounts/#{id}/activate"
|
52
|
-
post(path, model) end
|
54
|
+
post(path, model, {}, "21.12.0") end
|
53
55
|
|
54
56
|
# Retrieve audit history for an account.
|
55
57
|
#
|
@@ -71,6 +73,7 @@ module AvaTax
|
|
71
73
|
# ### Security Policies
|
72
74
|
#
|
73
75
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
76
|
+
# Swagger Name: AvaTaxClient
|
74
77
|
# @param id [Integer] The ID of the account you wish to audit.
|
75
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.
|
76
79
|
# @param end [DateTime] The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
|
@@ -78,7 +81,7 @@ module AvaTax
|
|
78
81
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
79
82
|
# @return [FetchResult]
|
80
83
|
def audit_account(id, options={}) path = "/api/v2/accounts/#{id}/audit"
|
81
|
-
get(path, options) end
|
84
|
+
get(path, options, "21.12.0") end
|
82
85
|
|
83
86
|
# Create license key for this account
|
84
87
|
#
|
@@ -96,11 +99,12 @@ module AvaTax
|
|
96
99
|
# ### Security Policies
|
97
100
|
#
|
98
101
|
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
102
|
+
# Swagger Name: AvaTaxClient
|
99
103
|
# @param id [Integer] The ID of the account you wish to update.
|
100
104
|
# @param model [Object]
|
101
105
|
# @return [Object]
|
102
106
|
def create_license_key(id, model) path = "/api/v2/accounts/#{id}/licensekey"
|
103
|
-
post(path, model) end
|
107
|
+
post(path, model, {}, "21.12.0") end
|
104
108
|
|
105
109
|
# Delete license key for this account by license key name
|
106
110
|
#
|
@@ -113,11 +117,12 @@ module AvaTax
|
|
113
117
|
# ### Security Policies
|
114
118
|
#
|
115
119
|
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
120
|
+
# Swagger Name: AvaTaxClient
|
116
121
|
# @param id [Integer] The ID of the account you wish to update.
|
117
122
|
# @param licensekeyname [String] The license key name you wish to update.
|
118
123
|
# @return [ErrorDetail[]]
|
119
124
|
def delete_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
|
120
|
-
delete(path) end
|
125
|
+
delete(path, {}, "21.12.0") end
|
121
126
|
|
122
127
|
# Retrieve a single account
|
123
128
|
#
|
@@ -130,11 +135,12 @@ module AvaTax
|
|
130
135
|
# ### Security Policies
|
131
136
|
#
|
132
137
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
138
|
+
# Swagger Name: AvaTaxClient
|
133
139
|
# @param id [Integer] The ID of the account to retrieve
|
134
140
|
# @param include [String] A comma separated list of special fetch options
|
135
141
|
# @return [Object]
|
136
142
|
def get_account(id, options={}) path = "/api/v2/accounts/#{id}"
|
137
|
-
get(path, options) end
|
143
|
+
get(path, options, "21.12.0") end
|
138
144
|
|
139
145
|
# Get configuration settings for this account
|
140
146
|
#
|
@@ -154,21 +160,23 @@ module AvaTax
|
|
154
160
|
# ### Security Policies
|
155
161
|
#
|
156
162
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
163
|
+
# Swagger Name: AvaTaxClient
|
157
164
|
# @param id [Integer]
|
158
165
|
# @return [AccountConfigurationModel[]]
|
159
166
|
def get_account_configuration(id) path = "/api/v2/accounts/#{id}/configuration"
|
160
|
-
get(path) end
|
167
|
+
get(path, {}, "21.12.0") end
|
161
168
|
|
162
169
|
# Retrieve license key by license key name
|
163
170
|
#
|
164
171
|
# ### Security Policies
|
165
172
|
#
|
166
173
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
174
|
+
# Swagger Name: AvaTaxClient
|
167
175
|
# @param id [Integer] The ID of the account to retrieve
|
168
176
|
# @param licensekeyname [String] The ID of the account to retrieve
|
169
177
|
# @return [Object]
|
170
178
|
def get_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
|
171
|
-
get(path) end
|
179
|
+
get(path, {}, "21.12.0") end
|
172
180
|
|
173
181
|
# Retrieve all license keys for this account
|
174
182
|
#
|
@@ -177,10 +185,11 @@ module AvaTax
|
|
177
185
|
# ### Security Policies
|
178
186
|
#
|
179
187
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
188
|
+
# Swagger Name: AvaTaxClient
|
180
189
|
# @param id [Integer] The ID of the account to retrieve
|
181
190
|
# @return [AccountLicenseKeyModel[]]
|
182
191
|
def get_license_keys(id) path = "/api/v2/accounts/#{id}/licensekeys"
|
183
|
-
get(path) end
|
192
|
+
get(path, {}, "21.12.0") end
|
184
193
|
|
185
194
|
# Retrieve all accounts
|
186
195
|
#
|
@@ -200,6 +209,7 @@ module AvaTax
|
|
200
209
|
# ### Security Policies
|
201
210
|
#
|
202
211
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
212
|
+
# Swagger Name: AvaTaxClient
|
203
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.
|
204
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
|
205
215
|
# @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.
|
@@ -207,7 +217,7 @@ module AvaTax
|
|
207
217
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
208
218
|
# @return [FetchResult]
|
209
219
|
def query_accounts(options={}) path = "/api/v2/accounts"
|
210
|
-
get(path, options) end
|
220
|
+
get(path, options, "21.12.0") end
|
211
221
|
|
212
222
|
# Change configuration settings for this account
|
213
223
|
#
|
@@ -227,11 +237,12 @@ module AvaTax
|
|
227
237
|
# ### Security Policies
|
228
238
|
#
|
229
239
|
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
240
|
+
# Swagger Name: AvaTaxClient
|
230
241
|
# @param id [Integer]
|
231
242
|
# @param model [AccountConfigurationModel[]]
|
232
243
|
# @return [AccountConfigurationModel[]]
|
233
244
|
def set_account_configuration(id, model) path = "/api/v2/accounts/#{id}/configuration"
|
234
|
-
post(path, model) end
|
245
|
+
post(path, model, {}, "21.12.0") end
|
235
246
|
end
|
236
247
|
end
|
237
248
|
end
|
@@ -21,6 +21,7 @@ module AvaTax
|
|
21
21
|
#
|
22
22
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
23
23
|
# * This API depends on the following active services:*Required* (all): AutoAddress.
|
24
|
+
# Swagger Name: AvaTaxClient
|
24
25
|
# @param line1 [String] Line 1
|
25
26
|
# @param line2 [String] Line 2
|
26
27
|
# @param line3 [String] Line 3
|
@@ -31,7 +32,7 @@ module AvaTax
|
|
31
32
|
# @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
|
32
33
|
# @return [Object]
|
33
34
|
def resolve_address(options={}) path = "/api/v2/addresses/resolve"
|
34
|
-
get(path, options) end
|
35
|
+
get(path, options, "21.12.0") end
|
35
36
|
|
36
37
|
# Retrieve geolocation information for a specified address
|
37
38
|
#
|
@@ -46,10 +47,11 @@ module AvaTax
|
|
46
47
|
#
|
47
48
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
48
49
|
# * This API depends on the following active services:*Required* (all): AutoAddress.
|
50
|
+
# Swagger Name: AvaTaxClient
|
49
51
|
# @param model [Object] The address to resolve
|
50
52
|
# @return [Object]
|
51
53
|
def resolve_address_post(model) path = "/api/v2/addresses/resolve"
|
52
|
-
post(path, model) end
|
54
|
+
post(path, model, {}, "21.12.0") end
|
53
55
|
end
|
54
56
|
end
|
55
57
|
end
|
@@ -6,49 +6,54 @@ module AvaTax
|
|
6
6
|
# Create a lookup file for a company
|
7
7
|
#
|
8
8
|
#
|
9
|
+
# Swagger Name: AvaTaxClient
|
9
10
|
# @param accountId [Integer] The ID of the account for the company
|
10
11
|
# @param companyId [Integer] The ID of the company for which the lookup file is to be created
|
11
12
|
# @param model [Object] The lookup file you wish to create
|
12
13
|
# @return [Object]
|
13
14
|
def create_company_lookup_file(accountId, companyId, model) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
|
14
|
-
post(path, model) end
|
15
|
+
post(path, model, {}, "21.12.0") end
|
15
16
|
|
16
17
|
# Delete a lookup file
|
17
18
|
#
|
18
19
|
#
|
20
|
+
# Swagger Name: AvaTaxClient
|
19
21
|
# @param accountId [Integer] The ID of the account for the company the lookup file is for
|
20
22
|
# @param id [String] The unique ID/GUID for the company lookup file to be deleted
|
21
23
|
# @return [ErrorDetail[]]
|
22
24
|
def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
23
|
-
delete(path) end
|
25
|
+
delete(path, {}, "21.12.0") end
|
24
26
|
|
25
27
|
# Get the lookup files for a company
|
26
28
|
#
|
27
29
|
#
|
30
|
+
# Swagger Name: AvaTaxClient
|
28
31
|
# @param accountId [Integer] The account ID for the company
|
29
32
|
# @param companyId [Integer] The ID of the company for which to retrieve lookup files
|
30
33
|
# @return [FetchResult]
|
31
34
|
def get_company_lookup_files(accountId, companyId) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
|
32
|
-
get(path) end
|
35
|
+
get(path, {}, "21.12.0") end
|
33
36
|
|
34
37
|
# Get a lookup file for an accountId and companyLookupFileId
|
35
38
|
#
|
36
39
|
#
|
40
|
+
# Swagger Name: AvaTaxClient
|
37
41
|
# @param accountId [Integer] The ID of the account for the lookup file
|
38
42
|
# @param id [String] The unique ID/GUID of the company lookup file to return
|
39
43
|
# @return [Object]
|
40
44
|
def get_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
41
|
-
get(path) end
|
45
|
+
get(path, {}, "21.12.0") end
|
42
46
|
|
43
47
|
# Update a lookup file
|
44
48
|
#
|
45
49
|
#
|
50
|
+
# Swagger Name: AvaTaxClient
|
46
51
|
# @param accountId [Integer] The ID of the account for the company the lookup file is for
|
47
52
|
# @param id [String] The unique ID/GUID of the company lookup file to be updated
|
48
53
|
# @param model [Object] The new values to update the lookup file
|
49
54
|
# @return [Object]
|
50
55
|
def update_lookup_file(accountId, id, model) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
51
|
-
put(path, model) end
|
56
|
+
put(path, model, {}, "21.12.0") end
|
52
57
|
end
|
53
58
|
end
|
54
59
|
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module AgeVerification
|
4
|
+
|
5
|
+
|
6
|
+
# Determines whether an individual meets or exceeds the minimum legal drinking age.
|
7
|
+
#
|
8
|
+
# The request must meet the following criteria in order to be evaluated:
|
9
|
+
# * *firstName*, *lastName*, and *address* are required fields.
|
10
|
+
# * One of the following sets of attributes are required for the *address*:
|
11
|
+
# * *line1, city, region*
|
12
|
+
# * *line1, postalCode*
|
13
|
+
#
|
14
|
+
# Optionally, the transaction and its lines may use the following parameters:
|
15
|
+
# * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21).
|
16
|
+
# * Beyond the required *address* fields above, a *country* field is permitted
|
17
|
+
# * The valid values for this attribute are [*US, USA*]
|
18
|
+
#
|
19
|
+
# **Security Policies**
|
20
|
+
# This API depends on the active subscription *AgeVerification*
|
21
|
+
# Swagger Name: AvaTaxBeverageClient
|
22
|
+
# @param simulatedFailureCode [String] (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.
|
23
|
+
# @param model [Object] Information about the individual whose age is being verified.
|
24
|
+
# @return [Object]
|
25
|
+
def verify_age(model, options={}) path = "/api/v2/ageverification/verify"
|
26
|
+
post(path, model, options, "") end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -12,10 +12,11 @@ module AvaTax
|
|
12
12
|
#
|
13
13
|
# * This API requires the user role Compliance Root User.
|
14
14
|
# * 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.
|
15
|
+
# Swagger Name: AvaTaxClient
|
15
16
|
# @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
|
16
17
|
# @return [AvaFileFormModel[]]
|
17
18
|
def create_ava_file_forms(model) path = "/api/v2/avafileforms"
|
18
|
-
post(path, model) end
|
19
|
+
post(path, model, {}, "21.12.0") end
|
19
20
|
|
20
21
|
# Delete a single AvaFileForm
|
21
22
|
#
|
@@ -25,10 +26,11 @@ module AvaTax
|
|
25
26
|
#
|
26
27
|
# * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
|
27
28
|
# * 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.
|
29
|
+
# Swagger Name: AvaTaxClient
|
28
30
|
# @param id [Integer] The ID of the AvaFileForm you wish to delete.
|
29
31
|
# @return [ErrorDetail[]]
|
30
32
|
def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
31
|
-
delete(path) end
|
33
|
+
delete(path, {}, "21.12.0") end
|
32
34
|
|
33
35
|
# Retrieve a single AvaFileForm
|
34
36
|
#
|
@@ -38,10 +40,11 @@ module AvaTax
|
|
38
40
|
#
|
39
41
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
|
40
42
|
# * 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.
|
43
|
+
# Swagger Name: AvaTaxClient
|
41
44
|
# @param id [Integer] The primary key of this AvaFileForm
|
42
45
|
# @return [Object]
|
43
46
|
def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
44
|
-
get(path) end
|
47
|
+
get(path, {}, "21.12.0") end
|
45
48
|
|
46
49
|
# Retrieve all AvaFileForms
|
47
50
|
#
|
@@ -52,13 +55,14 @@ module AvaTax
|
|
52
55
|
#
|
53
56
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
|
54
57
|
# * 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.
|
58
|
+
# Swagger Name: AvaTaxClient
|
55
59
|
# @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:* outletTypeId
|
56
60
|
# @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.
|
57
61
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
58
62
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
59
63
|
# @return [FetchResult]
|
60
64
|
def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
|
61
|
-
get(path, options) end
|
65
|
+
get(path, options, "21.12.0") end
|
62
66
|
|
63
67
|
# Update a AvaFileForm
|
64
68
|
#
|
@@ -69,11 +73,12 @@ module AvaTax
|
|
69
73
|
#
|
70
74
|
# * This API requires the user role Compliance Root User.
|
71
75
|
# * 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.
|
76
|
+
# Swagger Name: AvaTaxClient
|
72
77
|
# @param id [Integer] The ID of the AvaFileForm you wish to update
|
73
78
|
# @param model [Object] The AvaFileForm model you wish to update.
|
74
79
|
# @return [Object]
|
75
80
|
def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
|
76
|
-
put(path, model) end
|
81
|
+
put(path, model, {}, "21.12.0") end
|
77
82
|
end
|
78
83
|
end
|
79
84
|
end
|
@@ -21,11 +21,12 @@ module AvaTax
|
|
21
21
|
# ### Security Policies
|
22
22
|
#
|
23
23
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
24
|
+
# Swagger Name: AvaTaxClient
|
24
25
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
25
26
|
# @param id [Integer] The ID of the batch to cancel.
|
26
27
|
# @return [Object]
|
27
28
|
def cancel_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
|
28
|
-
post(path) end
|
29
|
+
post(path, {}, "21.12.0") end
|
29
30
|
|
30
31
|
# Create a new batch
|
31
32
|
#
|
@@ -52,11 +53,12 @@ module AvaTax
|
|
52
53
|
# ### Security Policies
|
53
54
|
#
|
54
55
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
56
|
+
# Swagger Name: AvaTaxClient
|
55
57
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
56
58
|
# @param model [BatchModel[]] The batch you wish to create.
|
57
59
|
# @return [BatchModel[]]
|
58
60
|
def create_batches(companyId, model) path = "/api/v2/companies/#{companyId}/batches"
|
59
|
-
post(path, model) end
|
61
|
+
post(path, model, {}, "21.12.0") end
|
60
62
|
|
61
63
|
# Create a new transaction batch
|
62
64
|
#
|
@@ -81,11 +83,12 @@ module AvaTax
|
|
81
83
|
# ### Security Policies
|
82
84
|
#
|
83
85
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
86
|
+
# Swagger Name: AvaTaxClient
|
84
87
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
85
88
|
# @param model [Object] The transaction batch you wish to create.
|
86
89
|
# @return [Object]
|
87
90
|
def create_transaction_batch(companyId, model) path = "/api/v2/companies/#{companyId}/batches/transactions"
|
88
|
-
post(path, model) end
|
91
|
+
post(path, model, {}, "21.12.0") end
|
89
92
|
|
90
93
|
# Delete a single batch
|
91
94
|
#
|
@@ -103,11 +106,12 @@ module AvaTax
|
|
103
106
|
# ### Security Policies
|
104
107
|
#
|
105
108
|
# * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
109
|
+
# Swagger Name: AvaTaxClient
|
106
110
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
107
111
|
# @param id [Integer] The ID of the batch to delete.
|
108
112
|
# @return [ErrorDetail[]]
|
109
113
|
def delete_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
110
|
-
delete(path) end
|
114
|
+
delete(path, {}, "21.12.0") end
|
111
115
|
|
112
116
|
# Download a single batch file
|
113
117
|
#
|
@@ -116,12 +120,13 @@ module AvaTax
|
|
116
120
|
# ### Security Policies
|
117
121
|
#
|
118
122
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
123
|
+
# Swagger Name: AvaTaxClient
|
119
124
|
# @param companyId [Integer] The ID of the company that owns this batch
|
120
125
|
# @param batchId [Integer] The ID of the batch object
|
121
126
|
# @param id [Integer] The primary key of this batch file object
|
122
127
|
# @return [Object]
|
123
128
|
def download_batch(companyId, batchId, id) path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
|
124
|
-
get(path) end
|
129
|
+
get(path, {}, "21.12.0") end
|
125
130
|
|
126
131
|
# Retrieve a single batch
|
127
132
|
#
|
@@ -144,11 +149,12 @@ module AvaTax
|
|
144
149
|
# ### Security Policies
|
145
150
|
#
|
146
151
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
152
|
+
# Swagger Name: AvaTaxClient
|
147
153
|
# @param companyId [Integer] The ID of the company that owns this batch
|
148
154
|
# @param id [Integer] The primary key of this batch
|
149
155
|
# @return [Object]
|
150
156
|
def get_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
151
|
-
get(path) end
|
157
|
+
get(path, {}, "21.12.0") end
|
152
158
|
|
153
159
|
# Retrieve all batches for this company
|
154
160
|
#
|
@@ -177,6 +183,7 @@ module AvaTax
|
|
177
183
|
# ### Security Policies
|
178
184
|
#
|
179
185
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
186
|
+
# Swagger Name: AvaTaxClient
|
180
187
|
# @param companyId [Integer] The ID of the company that owns these batches
|
181
188
|
# @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:* files
|
182
189
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -185,7 +192,7 @@ module AvaTax
|
|
185
192
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
186
193
|
# @return [FetchResult]
|
187
194
|
def list_batches_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/batches"
|
188
|
-
get(path, options) end
|
195
|
+
get(path, options, "21.12.0") end
|
189
196
|
|
190
197
|
# Retrieve all batches
|
191
198
|
#
|
@@ -211,6 +218,7 @@ module AvaTax
|
|
211
218
|
# ### Security Policies
|
212
219
|
#
|
213
220
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
221
|
+
# Swagger Name: AvaTaxClient
|
214
222
|
# @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:* files
|
215
223
|
# @param include [String] A comma separated list of additional data to retrieve.
|
216
224
|
# @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.
|
@@ -218,7 +226,7 @@ module AvaTax
|
|
218
226
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
219
227
|
# @return [FetchResult]
|
220
228
|
def query_batches(options={}) path = "/api/v2/batches"
|
221
|
-
get(path, options) end
|
229
|
+
get(path, options, "21.12.0") end
|
222
230
|
end
|
223
231
|
end
|
224
232
|
end
|
@@ -25,12 +25,13 @@ module AvaTax
|
|
25
25
|
#
|
26
26
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
27
27
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
28
|
+
# Swagger Name: AvaTaxClient
|
28
29
|
# @param companyId [Integer] The unique ID number of the company that will record certificates
|
29
30
|
# @param customerCode [String] The number of the customer where the request is sent to
|
30
31
|
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
|
31
32
|
# @return [CertExpressInvitationStatusModel[]]
|
32
33
|
def create_cert_express_invitation(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
|
33
|
-
post(path, model) end
|
34
|
+
post(path, model, {}, "21.12.0") end
|
34
35
|
|
35
36
|
# Retrieve a single CertExpress invitation
|
36
37
|
#
|
@@ -54,13 +55,14 @@ module AvaTax
|
|
54
55
|
#
|
55
56
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
56
57
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
58
|
+
# Swagger Name: AvaTaxClient
|
57
59
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
58
60
|
# @param customerCode [String] The number of the customer where the request is sent to
|
59
61
|
# @param id [Integer] The unique ID number of this CertExpress invitation
|
60
62
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
61
63
|
# @return [Object]
|
62
64
|
def get_cert_express_invitation(companyId, customerCode, id, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
|
63
|
-
get(path, options) end
|
65
|
+
get(path, options, "21.12.0") end
|
64
66
|
|
65
67
|
# List CertExpress invitations
|
66
68
|
#
|
@@ -84,6 +86,7 @@ module AvaTax
|
|
84
86
|
#
|
85
87
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
86
88
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
89
|
+
# Swagger Name: AvaTaxClient
|
87
90
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
88
91
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
89
92
|
# @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink
|
@@ -92,7 +95,7 @@ module AvaTax
|
|
92
95
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
93
96
|
# @return [FetchResult]
|
94
97
|
def list_cert_express_invitations(companyId, options={}) path = "/api/v2/companies/#{companyId}/certexpressinvites"
|
95
|
-
get(path, options) end
|
98
|
+
get(path, options, "21.12.0") end
|
96
99
|
end
|
97
100
|
end
|
98
101
|
end
|