avatax 20.5.0 → 20.6.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 +116 -83
- data/lib/avatax/client/addresses.rb +26 -20
- data/lib/avatax/client/advancedrules.rb +56 -41
- data/lib/avatax/client/avafileforms.rb +56 -41
- data/lib/avatax/client/batches.rb +125 -48
- data/lib/avatax/client/certexpressinvites.rb +36 -27
- data/lib/avatax/client/certificates.rb +156 -111
- data/lib/avatax/client/companies.rb +166 -118
- data/lib/avatax/client/compliance.rb +16 -13
- data/lib/avatax/client/contacts.rb +66 -48
- data/lib/avatax/client/customers.rb +136 -97
- data/lib/avatax/client/datasources.rb +66 -48
- data/lib/avatax/client/definitions.rb +596 -419
- data/lib/avatax/client/distancethresholds.rb +66 -48
- data/lib/avatax/client/filingcalendars.rb +16 -13
- data/lib/avatax/client/filings.rb +16 -13
- data/lib/avatax/client/firmclientlinkages.rb +96 -69
- data/lib/avatax/client/free.rb +36 -27
- data/lib/avatax/client/fundingrequests.rb +26 -20
- data/lib/avatax/client/items.rb +196 -139
- data/lib/avatax/client/jurisdictionoverrides.rb +66 -48
- data/lib/avatax/client/locations.rb +76 -55
- data/lib/avatax/client/multidocument.rb +106 -76
- data/lib/avatax/client/nexus.rb +82 -183
- data/lib/avatax/client/notifications.rb +36 -27
- data/lib/avatax/client/provisioning.rb +26 -20
- data/lib/avatax/client/registrar.rb +106 -76
- data/lib/avatax/client/reports.rb +46 -34
- data/lib/avatax/client/settings.rb +66 -48
- data/lib/avatax/client/subscriptions.rb +36 -27
- data/lib/avatax/client/taxcodes.rb +66 -48
- data/lib/avatax/client/taxcontent.rb +36 -27
- data/lib/avatax/client/taxrules.rb +66 -48
- data/lib/avatax/client/transactions.rb +216 -153
- data/lib/avatax/client/upcs.rb +66 -48
- data/lib/avatax/client/users.rb +86 -62
- data/lib/avatax/client/utilities.rb +36 -27
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
data/lib/avatax/client/nexus.rb
CHANGED
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Nexus
|
4
|
-
|
5
|
-
|
6
|
-
# Create a new nexus
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Nexus
|
4
|
+
|
5
|
+
|
6
|
+
# Create a new nexus
|
7
|
+
#
|
8
8
|
# Creates one or more new nexus declarations attached to this company.
|
9
9
|
#
|
10
10
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -27,38 +27,18 @@ 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, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
31
31
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
32
32
|
# @param model [NexusModel[]] The nexus you wish to create.
|
33
|
-
# @return [NexusModel[]]
|
34
|
-
def create_nexus(companyId, model)
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
#
|
41
|
-
#
|
42
|
-
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
43
|
-
#
|
44
|
-
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
33
|
+
# @return [NexusModel[]]
|
34
|
+
def create_nexus(companyId, model)
|
35
|
+
path = "/api/v2/companies/#{companyId}/nexus"
|
36
|
+
post(path, model)
|
37
|
+
end
|
38
|
+
|
39
|
+
|
40
|
+
# Creates nexus for a list of addresses.
|
45
41
|
#
|
46
|
-
# To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus`
|
47
|
-
#
|
48
|
-
# Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
|
49
|
-
#
|
50
|
-
# ### Security Policies
|
51
|
-
#
|
52
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
53
|
-
# @param companyId [Integer] The ID of the company that owns this nexus parameter.
|
54
|
-
# @param nexusId [Integer] The nexus id.
|
55
|
-
# @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
|
56
|
-
# @return [NexusParameterDetailModel[]]
|
57
|
-
def create_nexus_parameters(companyId, nexusId, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
58
|
-
post(path, model) end
|
59
|
-
|
60
|
-
# Creates nexus for a list of addresses.
|
61
|
-
#
|
62
42
|
# This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
|
63
43
|
# API declares nexus for this company, for the list of addresses provided,
|
64
44
|
# for the date range provided. You may also use this API to extend effective date on an already-declared nexus.
|
@@ -77,15 +57,18 @@ module AvaTax
|
|
77
57
|
#
|
78
58
|
# ### Security Policies
|
79
59
|
#
|
80
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
60
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
81
61
|
# @param companyId [Integer] The ID of the company that will own this nexus.
|
82
62
|
# @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
|
83
|
-
# @return [NexusByAddressModel[]]
|
84
|
-
def declare_nexus_by_address(companyId, model)
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
63
|
+
# @return [NexusByAddressModel[]]
|
64
|
+
def declare_nexus_by_address(companyId, model)
|
65
|
+
path = "/api/v2/companies/#{companyId}/nexus/byaddress"
|
66
|
+
post(path, model)
|
67
|
+
end
|
68
|
+
|
69
|
+
|
70
|
+
# Delete a single nexus
|
71
|
+
#
|
89
72
|
# Marks the existing nexus object at this URL as deleted.
|
90
73
|
#
|
91
74
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -97,53 +80,19 @@ module AvaTax
|
|
97
80
|
#
|
98
81
|
# ### Security Policies
|
99
82
|
#
|
100
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
83
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
101
84
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
102
85
|
# @param id [Integer] The ID of the nexus you wish to delete.
|
103
86
|
# @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
|
104
|
-
# @return [ErrorDetail[]]
|
105
|
-
def delete_nexus(companyId, id, options={})
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
#
|
112
|
-
#
|
113
|
-
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
87
|
+
# @return [ErrorDetail[]]
|
88
|
+
def delete_nexus(companyId, id, options={})
|
89
|
+
path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
90
|
+
delete(path, options)
|
91
|
+
end
|
92
|
+
|
93
|
+
|
94
|
+
# Retrieve a single nexus
|
114
95
|
#
|
115
|
-
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
116
|
-
#
|
117
|
-
# ### Security Policies
|
118
|
-
#
|
119
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
120
|
-
# @param companyId [Integer] The company id
|
121
|
-
# @param nexusId [Integer] The nexus id
|
122
|
-
# @param id [Integer] The parameter id
|
123
|
-
# @return [ErrorDetail[]]
|
124
|
-
def delete_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
125
|
-
delete(path) end
|
126
|
-
|
127
|
-
# Delete all parameters for an nexus
|
128
|
-
#
|
129
|
-
# Delete all the parameters for a given nexus.
|
130
|
-
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
131
|
-
#
|
132
|
-
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
133
|
-
#
|
134
|
-
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
135
|
-
#
|
136
|
-
# ### Security Policies
|
137
|
-
#
|
138
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
139
|
-
# @param companyId [Integer] The ID of the company that owns this nexus.
|
140
|
-
# @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
|
141
|
-
# @return [ErrorDetail[]]
|
142
|
-
def delete_nexus_parameters(companyId, nexusId) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
143
|
-
delete(path) end
|
144
|
-
|
145
|
-
# Retrieve a single nexus
|
146
|
-
#
|
147
96
|
# Get the nexus object identified by this URL.
|
148
97
|
#
|
149
98
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -155,16 +104,19 @@ module AvaTax
|
|
155
104
|
#
|
156
105
|
# ### Security Policies
|
157
106
|
#
|
158
|
-
# * 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.
|
107
|
+
# * 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.
|
159
108
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
160
109
|
# @param id [Integer] The primary key of this nexus
|
161
110
|
# @param include [String]
|
162
|
-
# @return [Object]
|
163
|
-
def get_nexus(companyId, id, options={})
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
111
|
+
# @return [Object]
|
112
|
+
def get_nexus(companyId, id, options={})
|
113
|
+
path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
114
|
+
get(path, options)
|
115
|
+
end
|
116
|
+
|
117
|
+
|
118
|
+
# List company nexus related to a tax form
|
119
|
+
#
|
168
120
|
# Retrieves a list of nexus related to a tax form.
|
169
121
|
#
|
170
122
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -180,35 +132,19 @@ module AvaTax
|
|
180
132
|
#
|
181
133
|
# ### Security Policies
|
182
134
|
#
|
183
|
-
# * 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.
|
135
|
+
# * 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.
|
184
136
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
185
137
|
# @param formCode [String] The form code that we are looking up the nexus for
|
186
138
|
# @param include [String]
|
187
|
-
# @return [Object]
|
188
|
-
def get_nexus_by_form_code(companyId, formCode, options={})
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
#
|
195
|
-
#
|
196
|
-
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
197
|
-
#
|
198
|
-
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
139
|
+
# @return [Object]
|
140
|
+
def get_nexus_by_form_code(companyId, formCode, options={})
|
141
|
+
path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
142
|
+
get(path, options)
|
143
|
+
end
|
144
|
+
|
145
|
+
|
146
|
+
# Retrieve nexus for this company
|
199
147
|
#
|
200
|
-
# ### Security Policies
|
201
|
-
#
|
202
|
-
# * 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.
|
203
|
-
# @param companyId [Integer] The company id
|
204
|
-
# @param nexusId [Integer] The nexus id
|
205
|
-
# @param id [Integer] The parameter id
|
206
|
-
# @return [Object]
|
207
|
-
def get_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
208
|
-
get(path) end
|
209
|
-
|
210
|
-
# Retrieve nexus for this company
|
211
|
-
#
|
212
148
|
# List all nexus objects defined for this company.
|
213
149
|
#
|
214
150
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -223,44 +159,22 @@ module AvaTax
|
|
223
159
|
#
|
224
160
|
# ### Security Policies
|
225
161
|
#
|
226
|
-
# * 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.
|
162
|
+
# * 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.
|
227
163
|
# @param companyId [Integer] The ID of the company that owns these nexus objects
|
228
164
|
# @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, taxAuthorityId, taxName, parameters
|
229
165
|
# @param include [String] A comma separated list of additional data to retrieve.
|
230
166
|
# @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.
|
231
167
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
232
168
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
233
|
-
# @return [FetchResult]
|
234
|
-
def list_nexus_by_company(companyId, options={})
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
#
|
241
|
-
#
|
242
|
-
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
243
|
-
#
|
244
|
-
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
245
|
-
#
|
246
|
-
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
247
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
169
|
+
# @return [FetchResult]
|
170
|
+
def list_nexus_by_company(companyId, options={})
|
171
|
+
path = "/api/v2/companies/#{companyId}/nexus"
|
172
|
+
get(path, options)
|
173
|
+
end
|
174
|
+
|
175
|
+
|
176
|
+
# Retrieve all nexus
|
248
177
|
#
|
249
|
-
# ### Security Policies
|
250
|
-
#
|
251
|
-
# * 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.
|
252
|
-
# @param companyId [Integer] The company id
|
253
|
-
# @param nexusId [Integer] The nexus id
|
254
|
-
# @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
|
255
|
-
# @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.
|
256
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
257
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
258
|
-
# @return [FetchResult]
|
259
|
-
def list_nexus_parameters(companyId, nexusId, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
260
|
-
get(path, options) end
|
261
|
-
|
262
|
-
# Retrieve all nexus
|
263
|
-
#
|
264
178
|
# Get multiple nexus objects across all companies.
|
265
179
|
#
|
266
180
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -275,18 +189,21 @@ module AvaTax
|
|
275
189
|
#
|
276
190
|
# ### Security Policies
|
277
191
|
#
|
278
|
-
# * 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.
|
192
|
+
# * 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.
|
279
193
|
# @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, taxAuthorityId, taxName, parameters
|
280
194
|
# @param include [String] A comma separated list of additional data to retrieve.
|
281
195
|
# @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.
|
282
196
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
283
197
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
284
|
-
# @return [FetchResult]
|
285
|
-
def query_nexus(options={})
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
198
|
+
# @return [FetchResult]
|
199
|
+
def query_nexus(options={})
|
200
|
+
path = "/api/v2/nexus"
|
201
|
+
get(path, options)
|
202
|
+
end
|
203
|
+
|
204
|
+
|
205
|
+
# Update a single nexus
|
206
|
+
#
|
290
207
|
# Replace the existing nexus declaration object at this URL with an updated object.
|
291
208
|
#
|
292
209
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -309,34 +226,16 @@ module AvaTax
|
|
309
226
|
#
|
310
227
|
# ### Security Policies
|
311
228
|
#
|
312
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
229
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
313
230
|
# @param companyId [Integer] The ID of the company that this nexus belongs to.
|
314
231
|
# @param id [Integer] The ID of the nexus you wish to update
|
315
232
|
# @param model [Object] The nexus object you wish to update.
|
316
|
-
# @return [Object]
|
317
|
-
def update_nexus(companyId, id, model)
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
325
|
-
#
|
326
|
-
# A parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added.
|
327
|
-
#
|
328
|
-
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this?
|
329
|
-
#
|
330
|
-
# ### Security Policies
|
331
|
-
#
|
332
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
333
|
-
# @param companyId [Integer] The company id.
|
334
|
-
# @param nexusId [Integer] The nexus id
|
335
|
-
# @param id [Integer] The nexus parameter id
|
336
|
-
# @param model [Object] The nexus object you wish to update.
|
337
|
-
# @return [Object]
|
338
|
-
def update_nexus_parameter(companyId, nexusId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
339
|
-
put(path, model) end
|
340
|
-
end
|
341
|
-
end
|
233
|
+
# @return [Object]
|
234
|
+
def update_nexus(companyId, id, model)
|
235
|
+
path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
236
|
+
put(path, model)
|
237
|
+
end
|
238
|
+
|
239
|
+
end
|
240
|
+
end
|
342
241
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Notifications
|
4
|
-
|
5
|
-
|
6
|
-
# Mark a single notification as dismissed.
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Notifications
|
4
|
+
|
5
|
+
|
6
|
+
# Mark a single notification as dismissed.
|
7
|
+
#
|
8
8
|
# Marks the notification identified by this URL as dismissed.
|
9
9
|
#
|
10
10
|
# A notification is a message from Avalara that may have relevance to your business. You may want
|
@@ -22,14 +22,17 @@ module AvaTax
|
|
22
22
|
#
|
23
23
|
# ### Security Policies
|
24
24
|
#
|
25
|
-
# * 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.
|
25
|
+
# * 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.
|
26
26
|
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
27
|
-
# @return [Object]
|
28
|
-
def dismiss_notification(id)
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
27
|
+
# @return [Object]
|
28
|
+
def dismiss_notification(id)
|
29
|
+
path = "/api/v2/notifications/#{id}/dismiss"
|
30
|
+
put(path)
|
31
|
+
end
|
32
|
+
|
33
|
+
|
34
|
+
# Retrieve a single notification.
|
35
|
+
#
|
33
36
|
# Retrieve a single notification by its unique ID number.
|
34
37
|
#
|
35
38
|
# A notification is a message from Avalara that may have relevance to your business. You may want
|
@@ -41,14 +44,17 @@ module AvaTax
|
|
41
44
|
#
|
42
45
|
# ### Security Policies
|
43
46
|
#
|
44
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
47
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
45
48
|
# @param id [Integer] The id of the notification to retrieve.
|
46
|
-
# @return [Object]
|
47
|
-
def get_notification(id)
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
49
|
+
# @return [Object]
|
50
|
+
def get_notification(id)
|
51
|
+
path = "/api/v2/notifications/#{id}"
|
52
|
+
get(path)
|
53
|
+
end
|
54
|
+
|
55
|
+
|
56
|
+
# List all notifications.
|
57
|
+
#
|
52
58
|
# List all notifications.
|
53
59
|
#
|
54
60
|
# A notification is a message from Avalara that may have relevance to your business. You may want
|
@@ -63,14 +69,17 @@ module AvaTax
|
|
63
69
|
#
|
64
70
|
# ### Security Policies
|
65
71
|
#
|
66
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
72
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
67
73
|
# @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/).
|
68
74
|
# @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.
|
69
75
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
70
76
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
71
|
-
# @return [FetchResult]
|
72
|
-
def list_notifications(options={})
|
73
|
-
|
74
|
-
|
75
|
-
|
77
|
+
# @return [FetchResult]
|
78
|
+
def list_notifications(options={})
|
79
|
+
path = "/api/v2/notifications"
|
80
|
+
get(path, options)
|
81
|
+
end
|
82
|
+
|
83
|
+
end
|
84
|
+
end
|
76
85
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Provisioning
|
4
|
-
|
5
|
-
|
6
|
-
# Request a new Avalara account
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Provisioning
|
4
|
+
|
5
|
+
|
6
|
+
# Request a new Avalara account
|
7
|
+
#
|
8
8
|
# This API is for use by partner provisioning services customers only.
|
9
9
|
#
|
10
10
|
# Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
|
@@ -24,14 +24,17 @@ module AvaTax
|
|
24
24
|
#
|
25
25
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
26
|
# * This API is available by invitation only.
|
27
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
27
|
+
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
28
28
|
# @param model [Object] Information about the account you wish to create and the selected product offerings.
|
29
|
-
# @return [Object]
|
30
|
-
def request_new_account(model)
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
29
|
+
# @return [Object]
|
30
|
+
def request_new_account(model)
|
31
|
+
path = "/api/v2/accounts/request"
|
32
|
+
post(path, model)
|
33
|
+
end
|
34
|
+
|
35
|
+
|
36
|
+
# Request a new entitilement to an existing customer
|
37
|
+
#
|
35
38
|
# This API is for use by partner provisioning services customers only. This will allow the partners to allow
|
36
39
|
# the add new entitlement to an existing customer
|
37
40
|
#
|
@@ -39,12 +42,15 @@ module AvaTax
|
|
39
42
|
#
|
40
43
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
44
|
# * This API is available by invitation only.
|
42
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
45
|
+
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
43
46
|
# @param id [Integer] The avatax account id of the customer
|
44
47
|
# @param offer [String] The offer to be added to an already existing customer
|
45
|
-
# @return [Object]
|
46
|
-
def request_new_entitlement(id, offer)
|
47
|
-
|
48
|
-
|
49
|
-
|
48
|
+
# @return [Object]
|
49
|
+
def request_new_entitlement(id, offer)
|
50
|
+
path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
|
51
|
+
post(path)
|
52
|
+
end
|
53
|
+
|
54
|
+
end
|
55
|
+
end
|
50
56
|
end
|