avatax 22.3.0 → 22.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/gem-push.yml +31 -0
- data/.gitignore +55 -55
- data/.rspec +1 -1
- data/.vs/VSWorkspaceState.json +5 -5
- data/.yardopts +4 -4
- data/Gemfile +2 -2
- data/LICENSE +201 -201
- data/README.md +98 -98
- data/Rakefile +9 -9
- data/avatax.gemspec +38 -38
- data/example/avatax.rb +47 -47
- data/example/credentials.example.yaml +5 -5
- data/lib/avatax/api.rb +27 -27
- data/lib/avatax/client/accounts.rb +22 -22
- data/lib/avatax/client/addresses.rb +4 -4
- data/lib/avatax/client/advancedrules.rb +5 -5
- data/lib/avatax/client/avafileforms.rb +7 -7
- data/lib/avatax/client/batches.rb +16 -16
- data/lib/avatax/client/certexpressinvites.rb +6 -6
- data/lib/avatax/client/certificates.rb +30 -30
- data/lib/avatax/client/companies.rb +47 -45
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/contacts.rb +12 -12
- data/lib/avatax/client/customers.rb +26 -26
- data/lib/avatax/client/datasources.rb +12 -12
- data/lib/avatax/client/definitions.rb +90 -75
- data/lib/avatax/client/distancethresholds.rb +12 -12
- data/lib/avatax/client/ecms.rb +73 -73
- data/lib/avatax/client/ecommercetoken.rb +4 -4
- data/lib/avatax/client/errortransactions.rb +61 -61
- data/lib/avatax/client/firmclientlinkages.rb +17 -17
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +10 -6
- data/lib/avatax/client/items.rb +86 -62
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -12
- data/lib/avatax/client/locations.rb +24 -24
- data/lib/avatax/client/multidocument.rb +20 -20
- data/lib/avatax/client/nexus.rb +30 -30
- data/lib/avatax/client/notices.rb +8 -8
- data/lib/avatax/client/notifications.rb +6 -6
- data/lib/avatax/client/onboarding.rb +55 -55
- data/lib/avatax/client/pointofsale.rb +21 -21
- data/lib/avatax/client/provisioning.rb +4 -4
- data/lib/avatax/client/registrar.rb +20 -20
- data/lib/avatax/client/reports.rb +7 -7
- data/lib/avatax/client/settings.rb +12 -12
- data/lib/avatax/client/subscriptions.rb +6 -6
- data/lib/avatax/client/taxcodes.rb +12 -12
- data/lib/avatax/client/taxcontent.rb +8 -8
- data/lib/avatax/client/taxprofiles.rb +42 -42
- data/lib/avatax/client/taxrules.rb +12 -12
- data/lib/avatax/client/transactions.rb +41 -41
- data/lib/avatax/client/upcs.rb +12 -12
- data/lib/avatax/client/userdefinedfields.rb +6 -6
- data/lib/avatax/client/users.rb +16 -16
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/client.rb +37 -37
- data/lib/avatax/configuration.rb +76 -76
- data/lib/avatax/connection.rb +53 -49
- data/lib/avatax/request.rb +51 -51
- data/lib/avatax/version.rb +3 -3
- data/lib/avatax.rb +26 -26
- data/spec/avatax/client/accounts_spec.rb +13 -13
- data/spec/avatax/client/transactions_spec.rb +80 -80
- data/spec/avatax/request_spec.rb +25 -25
- data/spec/avatax_spec.rb +45 -45
- data/spec/credentials.yaml.example +4 -4
- data/spec/fixtures/accounts.json +15 -15
- data/spec/spec_helper.rb +27 -27
- metadata +6 -6
- data/.travis.yml +0 -19
@@ -19,14 +19,14 @@ module AvaTax
|
|
19
19
|
#
|
20
20
|
# ### Security Policies
|
21
21
|
#
|
22
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
22
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
23
23
|
# Swagger Name: AvaTaxClient
|
24
24
|
# @param companyId [Integer] The ID of the company that owns this location parameter.
|
25
25
|
# @param locationId [Integer] The location id.
|
26
26
|
# @param model [LocationParameterModel[]] The location parameters you wish to create.
|
27
27
|
# @return [LocationParameterModel[]]
|
28
28
|
def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
29
|
-
post(path, model, {}, "22.
|
29
|
+
post(path, model, {}, "22.7.0") end
|
30
30
|
|
31
31
|
# Create a new location
|
32
32
|
#
|
@@ -34,13 +34,13 @@ module AvaTax
|
|
34
34
|
#
|
35
35
|
# ### Security Policies
|
36
36
|
#
|
37
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
37
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
38
38
|
# Swagger Name: AvaTaxClient
|
39
39
|
# @param companyId [Integer] The ID of the company that owns this location.
|
40
40
|
# @param model [LocationModel[]] The location you wish to create.
|
41
41
|
# @return [LocationModel[]]
|
42
42
|
def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
|
43
|
-
post(path, model, {}, "22.
|
43
|
+
post(path, model, {}, "22.7.0") end
|
44
44
|
|
45
45
|
# Delete a single location
|
46
46
|
#
|
@@ -48,13 +48,13 @@ module AvaTax
|
|
48
48
|
#
|
49
49
|
# ### Security Policies
|
50
50
|
#
|
51
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
51
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
52
52
|
# Swagger Name: AvaTaxClient
|
53
53
|
# @param companyId [Integer] The ID of the company that owns this location.
|
54
54
|
# @param id [Integer] The ID of the location you wish to delete.
|
55
55
|
# @return [ErrorDetail[]]
|
56
56
|
def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
57
|
-
delete(path, {}, "22.
|
57
|
+
delete(path, {}, "22.7.0") end
|
58
58
|
|
59
59
|
# Delete a single location parameter
|
60
60
|
#
|
@@ -68,14 +68,14 @@ module AvaTax
|
|
68
68
|
#
|
69
69
|
# ### Security Policies
|
70
70
|
#
|
71
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
71
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
72
72
|
# Swagger Name: AvaTaxClient
|
73
73
|
# @param companyId [Integer] The company id
|
74
74
|
# @param locationId [Integer] The location id
|
75
75
|
# @param id [Integer] The parameter id
|
76
76
|
# @return [ErrorDetail[]]
|
77
77
|
def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
78
|
-
delete(path, {}, "22.
|
78
|
+
delete(path, {}, "22.7.0") end
|
79
79
|
|
80
80
|
# Retrieve a single location
|
81
81
|
#
|
@@ -92,14 +92,14 @@ module AvaTax
|
|
92
92
|
#
|
93
93
|
# ### Security Policies
|
94
94
|
#
|
95
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
95
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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
|
99
99
|
# @param include [String] A comma separated list of additional data to retrieve.
|
100
100
|
# @return [Object]
|
101
101
|
def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
102
|
-
get(path, options, "22.
|
102
|
+
get(path, options, "22.7.0") end
|
103
103
|
|
104
104
|
# Retrieve a single company location parameter
|
105
105
|
#
|
@@ -113,14 +113,14 @@ module AvaTax
|
|
113
113
|
#
|
114
114
|
# ### Security Policies
|
115
115
|
#
|
116
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
116
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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
|
120
120
|
# @param id [Integer] The parameter id
|
121
121
|
# @return [Object]
|
122
122
|
def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
123
|
-
get(path, {}, "22.
|
123
|
+
get(path, {}, "22.7.0") end
|
124
124
|
|
125
125
|
# Retrieve parameters for a location
|
126
126
|
#
|
@@ -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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
140
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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
|
@@ -147,7 +147,7 @@ module AvaTax
|
|
147
147
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
148
148
|
# @return [FetchResult]
|
149
149
|
def list_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
150
|
-
get(path, options, "22.
|
150
|
+
get(path, options, "22.7.0") end
|
151
151
|
|
152
152
|
# Retrieve locations for this company
|
153
153
|
#
|
@@ -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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
169
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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
|
@@ -176,7 +176,7 @@ module AvaTax
|
|
176
176
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
177
177
|
# @return [FetchResult]
|
178
178
|
def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
|
179
|
-
get(path, options, "22.
|
179
|
+
get(path, options, "22.7.0") end
|
180
180
|
|
181
181
|
# Retrieve all locations
|
182
182
|
#
|
@@ -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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
199
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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.
|
@@ -205,7 +205,7 @@ module AvaTax
|
|
205
205
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
206
206
|
# @return [FetchResult]
|
207
207
|
def query_locations(options={}) path = "/api/v2/locations"
|
208
|
-
get(path, options, "22.
|
208
|
+
get(path, options, "22.7.0") end
|
209
209
|
|
210
210
|
# Update a single location
|
211
211
|
#
|
@@ -215,14 +215,14 @@ module AvaTax
|
|
215
215
|
#
|
216
216
|
# ### Security Policies
|
217
217
|
#
|
218
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
218
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
219
219
|
# Swagger Name: AvaTaxClient
|
220
220
|
# @param companyId [Integer] The ID of the company that this location belongs to.
|
221
221
|
# @param id [Integer] The ID of the location you wish to update
|
222
222
|
# @param model [Object] The location you wish to update.
|
223
223
|
# @return [Object]
|
224
224
|
def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
225
|
-
put(path, model, {}, "22.
|
225
|
+
put(path, model, {}, "22.7.0") end
|
226
226
|
|
227
227
|
# Update a location parameter
|
228
228
|
#
|
@@ -236,7 +236,7 @@ module AvaTax
|
|
236
236
|
#
|
237
237
|
# ### Security Policies
|
238
238
|
#
|
239
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
239
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
240
240
|
# Swagger Name: AvaTaxClient
|
241
241
|
# @param companyId [Integer] The company id.
|
242
242
|
# @param locationId [Integer] The location id
|
@@ -244,7 +244,7 @@ module AvaTax
|
|
244
244
|
# @param model [Object] The location parameter object you wish to update.
|
245
245
|
# @return [Object]
|
246
246
|
def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
247
|
-
put(path, model, {}, "22.
|
247
|
+
put(path, model, {}, "22.7.0") end
|
248
248
|
|
249
249
|
# Validate the location against local requirements
|
250
250
|
#
|
@@ -254,13 +254,13 @@ module AvaTax
|
|
254
254
|
#
|
255
255
|
# ### Security Policies
|
256
256
|
#
|
257
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
257
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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
|
261
261
|
# @return [Object]
|
262
262
|
def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
|
263
|
-
get(path, {}, "22.
|
263
|
+
get(path, {}, "22.7.0") end
|
264
264
|
end
|
265
265
|
end
|
266
266
|
end
|
@@ -26,7 +26,7 @@ module AvaTax
|
|
26
26
|
#
|
27
27
|
# ### Security Policies
|
28
28
|
#
|
29
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
29
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
30
30
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
31
31
|
# Swagger Name: AvaTaxClient
|
32
32
|
# @param code [String] The transaction code for this MultiDocument transaction
|
@@ -35,7 +35,7 @@ module AvaTax
|
|
35
35
|
# @param model [Object] The adjust request you wish to execute
|
36
36
|
# @return [Object]
|
37
37
|
def adjust_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
|
38
|
-
post(path, model, options, "22.
|
38
|
+
post(path, model, options, "22.7.0") end
|
39
39
|
|
40
40
|
# Get audit information about a MultiDocument transaction
|
41
41
|
#
|
@@ -64,14 +64,14 @@ module AvaTax
|
|
64
64
|
#
|
65
65
|
# ### Security Policies
|
66
66
|
#
|
67
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
67
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
68
68
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
69
69
|
# Swagger Name: AvaTaxClient
|
70
70
|
# @param code [String] The transaction code for this MultiDocument transaction
|
71
71
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
72
72
|
# @return [Object]
|
73
73
|
def audit_multi_document_transaction(code, type) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
|
74
|
-
get(path, {}, "22.
|
74
|
+
get(path, {}, "22.7.0") end
|
75
75
|
|
76
76
|
# Commit a MultiDocument transaction
|
77
77
|
#
|
@@ -94,13 +94,13 @@ module AvaTax
|
|
94
94
|
#
|
95
95
|
# ### Security Policies
|
96
96
|
#
|
97
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
97
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
98
98
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
99
99
|
# Swagger Name: AvaTaxClient
|
100
100
|
# @param model [Object] The commit request you wish to execute
|
101
101
|
# @return [Object]
|
102
102
|
def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
|
103
|
-
post(path, model, {}, "22.
|
103
|
+
post(path, model, {}, "22.7.0") end
|
104
104
|
|
105
105
|
# Create a new MultiDocument transaction
|
106
106
|
#
|
@@ -147,14 +147,14 @@ module AvaTax
|
|
147
147
|
#
|
148
148
|
# ### Security Policies
|
149
149
|
#
|
150
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
150
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
151
151
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
152
152
|
# Swagger Name: AvaTaxClient
|
153
153
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
154
154
|
# @param model [Object] the multi document transaction model
|
155
155
|
# @return [Object]
|
156
156
|
def create_multi_document_transaction(model, options={}) path = "/api/v2/transactions/multidocument"
|
157
|
-
post(path, model, options, "22.
|
157
|
+
post(path, model, options, "22.7.0") end
|
158
158
|
|
159
159
|
# Retrieve a MultiDocument transaction
|
160
160
|
#
|
@@ -181,7 +181,7 @@ module AvaTax
|
|
181
181
|
#
|
182
182
|
# ### Security Policies
|
183
183
|
#
|
184
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
184
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
185
185
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
186
186
|
# Swagger Name: AvaTaxClient
|
187
187
|
# @param code [String] The multidocument code to retrieve
|
@@ -189,7 +189,7 @@ module AvaTax
|
|
189
189
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
190
190
|
# @return [Object]
|
191
191
|
def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
|
192
|
-
get(path, options, "22.
|
192
|
+
get(path, options, "22.7.0") end
|
193
193
|
|
194
194
|
# Retrieve a MultiDocument transaction by ID
|
195
195
|
#
|
@@ -225,14 +225,14 @@ module AvaTax
|
|
225
225
|
#
|
226
226
|
# ### Security Policies
|
227
227
|
#
|
228
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
228
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
229
229
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
230
230
|
# Swagger Name: AvaTaxClient
|
231
231
|
# @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
|
232
232
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
233
233
|
# @return [Object]
|
234
234
|
def get_multi_document_transaction_by_id(id, options={}) path = "/api/v2/transactions/multidocument/#{id}"
|
235
|
-
get(path, options, "22.
|
235
|
+
get(path, options, "22.7.0") end
|
236
236
|
|
237
237
|
# Retrieve all MultiDocument transactions
|
238
238
|
#
|
@@ -266,7 +266,7 @@ module AvaTax
|
|
266
266
|
#
|
267
267
|
# ### Security Policies
|
268
268
|
#
|
269
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
269
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
270
270
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
271
271
|
# Swagger Name: AvaTaxClient
|
272
272
|
# @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:* documents
|
@@ -276,7 +276,7 @@ module AvaTax
|
|
276
276
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
277
277
|
# @return [FetchResult]
|
278
278
|
def list_multi_document_transactions(options={}) path = "/api/v2/transactions/multidocument"
|
279
|
-
get(path, options, "22.
|
279
|
+
get(path, options, "22.7.0") end
|
280
280
|
|
281
281
|
# Create a refund for a MultiDocument transaction
|
282
282
|
#
|
@@ -327,7 +327,7 @@ module AvaTax
|
|
327
327
|
#
|
328
328
|
# ### Security Policies
|
329
329
|
#
|
330
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
330
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
331
331
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
332
332
|
# Swagger Name: AvaTaxClient
|
333
333
|
# @param code [String] The code of this MultiDocument transaction
|
@@ -336,7 +336,7 @@ module AvaTax
|
|
336
336
|
# @param model [Object] Information about the refund to create
|
337
337
|
# @return [Object]
|
338
338
|
def refund_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
|
339
|
-
post(path, model, options, "22.
|
339
|
+
post(path, model, options, "22.7.0") end
|
340
340
|
|
341
341
|
# Verify a MultiDocument transaction
|
342
342
|
#
|
@@ -357,13 +357,13 @@ module AvaTax
|
|
357
357
|
#
|
358
358
|
# ### Security Policies
|
359
359
|
#
|
360
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
360
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
361
361
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
362
362
|
# Swagger Name: AvaTaxClient
|
363
363
|
# @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
|
364
364
|
# @return [Object]
|
365
365
|
def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
|
366
|
-
post(path, model, {}, "22.
|
366
|
+
post(path, model, {}, "22.7.0") end
|
367
367
|
|
368
368
|
# Void a MultiDocument transaction
|
369
369
|
#
|
@@ -387,7 +387,7 @@ module AvaTax
|
|
387
387
|
#
|
388
388
|
# ### Security Policies
|
389
389
|
#
|
390
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
390
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
391
391
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
392
392
|
# Swagger Name: AvaTaxClient
|
393
393
|
# @param code [String] The transaction code for this MultiDocument transaction
|
@@ -395,7 +395,7 @@ module AvaTax
|
|
395
395
|
# @param model [Object] The void request you wish to execute
|
396
396
|
# @return [Object]
|
397
397
|
def void_multi_document_transaction(code, type, model) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
|
398
|
-
post(path, model, {}, "22.
|
398
|
+
post(path, model, {}, "22.7.0") end
|
399
399
|
end
|
400
400
|
end
|
401
401
|
end
|
data/lib/avatax/client/nexus.rb
CHANGED
@@ -27,13 +27,13 @@ module AvaTax
|
|
27
27
|
#
|
28
28
|
# ### Security Policies
|
29
29
|
#
|
30
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
31
31
|
# Swagger Name: AvaTaxClient
|
32
32
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
33
33
|
# @param model [NexusModel[]] The nexus you wish to create.
|
34
34
|
# @return [NexusModel[]]
|
35
35
|
def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
|
36
|
-
post(path, model, {}, "22.
|
36
|
+
post(path, model, {}, "22.7.0") end
|
37
37
|
|
38
38
|
# Add parameters to a nexus.
|
39
39
|
#
|
@@ -50,14 +50,14 @@ module AvaTax
|
|
50
50
|
#
|
51
51
|
# ### Security Policies
|
52
52
|
#
|
53
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
53
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
54
54
|
# Swagger Name: AvaTaxClient
|
55
55
|
# @param companyId [Integer] The ID of the company that owns this nexus parameter.
|
56
56
|
# @param nexusId [Integer] The nexus id.
|
57
57
|
# @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
|
58
58
|
# @return [NexusParameterDetailModel[]]
|
59
59
|
def create_nexus_parameters(companyId, nexusId, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
60
|
-
post(path, model, {}, "22.
|
60
|
+
post(path, model, {}, "22.7.0") end
|
61
61
|
|
62
62
|
# Creates nexus for a list of addresses.
|
63
63
|
#
|
@@ -79,13 +79,13 @@ module AvaTax
|
|
79
79
|
#
|
80
80
|
# ### Security Policies
|
81
81
|
#
|
82
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
82
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
83
83
|
# Swagger Name: AvaTaxClient
|
84
84
|
# @param companyId [Integer] The ID of the company that will own this nexus.
|
85
85
|
# @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
|
86
86
|
# @return [NexusByAddressModel[]]
|
87
87
|
def declare_nexus_by_address(companyId, model) path = "/api/v2/companies/#{companyId}/nexus/byaddress"
|
88
|
-
post(path, model, {}, "22.
|
88
|
+
post(path, model, {}, "22.7.0") end
|
89
89
|
|
90
90
|
# Delete a single nexus
|
91
91
|
#
|
@@ -100,14 +100,14 @@ module AvaTax
|
|
100
100
|
#
|
101
101
|
# ### Security Policies
|
102
102
|
#
|
103
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
103
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
104
104
|
# Swagger Name: AvaTaxClient
|
105
105
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
106
106
|
# @param id [Integer] The ID of the nexus you wish to delete.
|
107
107
|
# @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
|
108
108
|
# @return [ErrorDetail[]]
|
109
109
|
def delete_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
110
|
-
delete(path, options, "22.
|
110
|
+
delete(path, options, "22.7.0") end
|
111
111
|
|
112
112
|
# Delete a single nexus parameter
|
113
113
|
#
|
@@ -120,14 +120,14 @@ module AvaTax
|
|
120
120
|
#
|
121
121
|
# ### Security Policies
|
122
122
|
#
|
123
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
123
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
124
124
|
# Swagger Name: AvaTaxClient
|
125
125
|
# @param companyId [Integer] The company id
|
126
126
|
# @param nexusId [Integer] The nexus id
|
127
127
|
# @param id [Integer] The parameter id
|
128
128
|
# @return [ErrorDetail[]]
|
129
129
|
def delete_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
130
|
-
delete(path, {}, "22.
|
130
|
+
delete(path, {}, "22.7.0") end
|
131
131
|
|
132
132
|
# Delete all parameters for an nexus
|
133
133
|
#
|
@@ -140,13 +140,13 @@ module AvaTax
|
|
140
140
|
#
|
141
141
|
# ### Security Policies
|
142
142
|
#
|
143
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
143
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
144
144
|
# Swagger Name: AvaTaxClient
|
145
145
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
146
146
|
# @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
|
147
147
|
# @return [ErrorDetail[]]
|
148
148
|
def delete_nexus_parameters(companyId, nexusId) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
149
|
-
delete(path, {}, "22.
|
149
|
+
delete(path, {}, "22.7.0") end
|
150
150
|
|
151
151
|
# Retrieve a single nexus
|
152
152
|
#
|
@@ -161,14 +161,14 @@ module AvaTax
|
|
161
161
|
#
|
162
162
|
# ### Security Policies
|
163
163
|
#
|
164
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
164
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
165
165
|
# Swagger Name: AvaTaxClient
|
166
166
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
167
167
|
# @param id [Integer] The primary key of this nexus
|
168
168
|
# @param include [String]
|
169
169
|
# @return [Object]
|
170
170
|
def get_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
171
|
-
get(path, options, "22.
|
171
|
+
get(path, options, "22.7.0") end
|
172
172
|
|
173
173
|
# List company nexus related to a tax form
|
174
174
|
#
|
@@ -187,14 +187,14 @@ module AvaTax
|
|
187
187
|
#
|
188
188
|
# ### Security Policies
|
189
189
|
#
|
190
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
190
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
191
191
|
# Swagger Name: AvaTaxClient
|
192
192
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
193
193
|
# @param formCode [String] The form code that we are looking up the nexus for
|
194
194
|
# @param include [String]
|
195
195
|
# @return [Object]
|
196
196
|
def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
197
|
-
get(path, options, "22.
|
197
|
+
get(path, options, "22.7.0") end
|
198
198
|
|
199
199
|
# Retrieve a single nexus parameter
|
200
200
|
#
|
@@ -207,14 +207,14 @@ module AvaTax
|
|
207
207
|
#
|
208
208
|
# ### Security Policies
|
209
209
|
#
|
210
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
210
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
211
211
|
# Swagger Name: AvaTaxClient
|
212
212
|
# @param companyId [Integer] The company id
|
213
213
|
# @param nexusId [Integer] The nexus id
|
214
214
|
# @param id [Integer] The parameter id
|
215
215
|
# @return [Object]
|
216
216
|
def get_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
217
|
-
get(path, {}, "22.
|
217
|
+
get(path, {}, "22.7.0") end
|
218
218
|
|
219
219
|
# Retrieve nexus for this company
|
220
220
|
#
|
@@ -232,7 +232,7 @@ module AvaTax
|
|
232
232
|
#
|
233
233
|
# ### Security Policies
|
234
234
|
#
|
235
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
235
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
236
236
|
# Swagger Name: AvaTaxClient
|
237
237
|
# @param companyId [Integer] The ID of the company that owns these nexus objects
|
238
238
|
# @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
|
@@ -242,7 +242,7 @@ module AvaTax
|
|
242
242
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
243
243
|
# @return [FetchResult]
|
244
244
|
def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
|
245
|
-
get(path, options, "22.
|
245
|
+
get(path, options, "22.7.0") end
|
246
246
|
|
247
247
|
# Retrieve nexus for this company By TaxTypeGroup
|
248
248
|
#
|
@@ -260,7 +260,7 @@ module AvaTax
|
|
260
260
|
#
|
261
261
|
# ### Security Policies
|
262
262
|
#
|
263
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
263
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
264
264
|
# Swagger Name: AvaTaxClient
|
265
265
|
# @param companyId [Integer] The ID of the company that owns these nexus objects
|
266
266
|
# @param taxTypeGroup [String] Name of TaxTypeGroup to filter by
|
@@ -271,7 +271,7 @@ module AvaTax
|
|
271
271
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
272
272
|
# @return [FetchResult]
|
273
273
|
def list_nexus_by_company_and_tax_type_group(companyId, taxTypeGroup, options={}) path = "/api/v2/companies/#{companyId}/nexus/byTaxTypeGroup/#{taxTypeGroup}"
|
274
|
-
get(path, options, "22.
|
274
|
+
get(path, options, "22.7.0") end
|
275
275
|
|
276
276
|
# Retrieve parameters for a nexus
|
277
277
|
#
|
@@ -287,7 +287,7 @@ module AvaTax
|
|
287
287
|
#
|
288
288
|
# ### Security Policies
|
289
289
|
#
|
290
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
290
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
291
291
|
# Swagger Name: AvaTaxClient
|
292
292
|
# @param companyId [Integer] The company id
|
293
293
|
# @param nexusId [Integer] The nexus id
|
@@ -297,7 +297,7 @@ module AvaTax
|
|
297
297
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
298
298
|
# @return [FetchResult]
|
299
299
|
def list_nexus_parameters(companyId, nexusId, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
300
|
-
get(path, options, "22.
|
300
|
+
get(path, options, "22.7.0") end
|
301
301
|
|
302
302
|
# Retrieve all nexus
|
303
303
|
#
|
@@ -315,7 +315,7 @@ module AvaTax
|
|
315
315
|
#
|
316
316
|
# ### Security Policies
|
317
317
|
#
|
318
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
318
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
319
319
|
# Swagger Name: AvaTaxClient
|
320
320
|
# @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
|
321
321
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -324,7 +324,7 @@ module AvaTax
|
|
324
324
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
325
325
|
# @return [FetchResult]
|
326
326
|
def query_nexus(options={}) path = "/api/v2/nexus"
|
327
|
-
get(path, options, "22.
|
327
|
+
get(path, options, "22.7.0") end
|
328
328
|
|
329
329
|
# Update a single nexus
|
330
330
|
#
|
@@ -350,14 +350,14 @@ module AvaTax
|
|
350
350
|
#
|
351
351
|
# ### Security Policies
|
352
352
|
#
|
353
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
353
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
354
354
|
# Swagger Name: AvaTaxClient
|
355
355
|
# @param companyId [Integer] The ID of the company that this nexus belongs to.
|
356
356
|
# @param id [Integer] The ID of the nexus you wish to update
|
357
357
|
# @param model [Object] The nexus object you wish to update.
|
358
358
|
# @return [Object]
|
359
359
|
def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
360
|
-
put(path, model, {}, "22.
|
360
|
+
put(path, model, {}, "22.7.0") end
|
361
361
|
|
362
362
|
# Update an nexus parameter
|
363
363
|
#
|
@@ -371,7 +371,7 @@ module AvaTax
|
|
371
371
|
#
|
372
372
|
# ### Security Policies
|
373
373
|
#
|
374
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
374
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
375
375
|
# Swagger Name: AvaTaxClient
|
376
376
|
# @param companyId [Integer] The company id.
|
377
377
|
# @param nexusId [Integer] The nexus id
|
@@ -379,7 +379,7 @@ module AvaTax
|
|
379
379
|
# @param model [Object] The nexus object you wish to update.
|
380
380
|
# @return [Object]
|
381
381
|
def update_nexus_parameter(companyId, nexusId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
382
|
-
put(path, model, {}, "22.
|
382
|
+
put(path, model, {}, "22.7.0") end
|
383
383
|
end
|
384
384
|
end
|
385
385
|
end
|