avatax 20.5.0 → 20.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.vs/slnx.sqlite +0 -0
- data/avatax.gemspec +0 -1
- data/lib/avatax/client/accounts.rb +83 -83
- data/lib/avatax/client/addresses.rb +21 -21
- data/lib/avatax/client/advancedrules.rb +51 -41
- data/lib/avatax/client/avafileforms.rb +41 -41
- data/lib/avatax/client/batches.rb +101 -48
- data/lib/avatax/client/certexpressinvites.rb +39 -39
- data/lib/avatax/client/certificates.rb +163 -163
- data/lib/avatax/client/companies.rb +226 -121
- data/lib/avatax/client/compliance.rb +13 -13
- data/lib/avatax/client/contacts.rb +48 -48
- data/lib/avatax/client/customers.rb +145 -145
- data/lib/avatax/client/datasources.rb +48 -48
- data/lib/avatax/client/definitions.rb +422 -420
- data/lib/avatax/client/distancethresholds.rb +48 -48
- data/lib/avatax/client/ecms.rb +26 -31
- data/lib/avatax/client/ecommercetoken.rb +37 -0
- data/lib/avatax/client/errortransactions.rb +27 -15
- data/lib/avatax/client/filingcalendars.rb +28 -13
- data/lib/avatax/client/filings.rb +25 -14
- data/lib/avatax/client/firmclientlinkages.rb +69 -69
- data/lib/avatax/client/free.rb +27 -27
- data/lib/avatax/client/fundingrequests.rb +20 -20
- data/lib/avatax/client/items.rb +139 -139
- data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
- data/lib/avatax/client/locations.rb +168 -57
- data/lib/avatax/client/multidocument.rb +98 -78
- data/lib/avatax/client/nexus.rb +104 -104
- data/lib/avatax/client/notices.rb +47 -139
- data/lib/avatax/client/notifications.rb +27 -27
- data/lib/avatax/client/provisioning.rb +20 -20
- data/lib/avatax/client/registrar.rb +76 -76
- data/lib/avatax/client/reports.rb +34 -34
- data/lib/avatax/client/settings.rb +48 -48
- data/lib/avatax/client/subscriptions.rb +27 -27
- data/lib/avatax/client/taxcodes.rb +48 -48
- data/lib/avatax/client/taxcontent.rb +27 -27
- data/lib/avatax/client/taxprofiles.rb +14 -10
- data/lib/avatax/client/taxrules.rb +48 -48
- data/lib/avatax/client/transactions.rb +185 -155
- data/lib/avatax/client/upcs.rb +48 -48
- data/lib/avatax/client/users.rb +62 -62
- data/lib/avatax/client/utilities.rb +27 -27
- data/lib/avatax/connection.rb +2 -2
- data/lib/avatax/version.rb +1 -1
- metadata +3 -16
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,15 +27,15 @@ 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) path = "/api/v2/companies/#{companyId}/nexus"
|
35
|
-
post(path, model) end
|
36
|
-
|
37
|
-
# Add parameters to a nexus.
|
38
|
-
#
|
33
|
+
# @return [NexusModel[]]
|
34
|
+
def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
|
35
|
+
post(path, model) end
|
36
|
+
|
37
|
+
# Add parameters to a nexus.
|
38
|
+
#
|
39
39
|
# Add parameters to the nexus.
|
40
40
|
# 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".
|
41
41
|
#
|
@@ -49,16 +49,16 @@ module AvaTax
|
|
49
49
|
#
|
50
50
|
# ### Security Policies
|
51
51
|
#
|
52
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
52
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
53
53
|
# @param companyId [Integer] The ID of the company that owns this nexus parameter.
|
54
54
|
# @param nexusId [Integer] The nexus id.
|
55
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
|
-
#
|
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
62
|
# This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
|
63
63
|
# API declares nexus for this company, for the list of addresses provided,
|
64
64
|
# for the date range provided. You may also use this API to extend effective date on an already-declared nexus.
|
@@ -77,15 +77,15 @@ module AvaTax
|
|
77
77
|
#
|
78
78
|
# ### Security Policies
|
79
79
|
#
|
80
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
80
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
81
81
|
# @param companyId [Integer] The ID of the company that will own this nexus.
|
82
82
|
# @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
|
83
|
-
# @return [NexusByAddressModel[]]
|
84
|
-
def declare_nexus_by_address(companyId, model) path = "/api/v2/companies/#{companyId}/nexus/byaddress"
|
85
|
-
post(path, model) end
|
86
|
-
|
87
|
-
# Delete a single nexus
|
88
|
-
#
|
83
|
+
# @return [NexusByAddressModel[]]
|
84
|
+
def declare_nexus_by_address(companyId, model) path = "/api/v2/companies/#{companyId}/nexus/byaddress"
|
85
|
+
post(path, model) end
|
86
|
+
|
87
|
+
# Delete a single nexus
|
88
|
+
#
|
89
89
|
# Marks the existing nexus object at this URL as deleted.
|
90
90
|
#
|
91
91
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -97,16 +97,16 @@ module AvaTax
|
|
97
97
|
#
|
98
98
|
# ### Security Policies
|
99
99
|
#
|
100
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
100
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
101
101
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
102
102
|
# @param id [Integer] The ID of the nexus you wish to delete.
|
103
103
|
# @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={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
106
|
-
delete(path, options) end
|
107
|
-
|
108
|
-
# Delete a single nexus parameter
|
109
|
-
#
|
104
|
+
# @return [ErrorDetail[]]
|
105
|
+
def delete_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
106
|
+
delete(path, options) end
|
107
|
+
|
108
|
+
# Delete a single nexus parameter
|
109
|
+
#
|
110
110
|
# Delete a single nexus parameter.
|
111
111
|
# 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".
|
112
112
|
#
|
@@ -116,16 +116,16 @@ module AvaTax
|
|
116
116
|
#
|
117
117
|
# ### Security Policies
|
118
118
|
#
|
119
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
119
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
120
120
|
# @param companyId [Integer] The company id
|
121
121
|
# @param nexusId [Integer] The nexus id
|
122
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
|
-
#
|
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
129
|
# Delete all the parameters for a given nexus.
|
130
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
131
|
#
|
@@ -135,15 +135,15 @@ module AvaTax
|
|
135
135
|
#
|
136
136
|
# ### Security Policies
|
137
137
|
#
|
138
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
138
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
139
139
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
140
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
|
-
#
|
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
147
|
# Get the nexus object identified by this URL.
|
148
148
|
#
|
149
149
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -155,16 +155,16 @@ module AvaTax
|
|
155
155
|
#
|
156
156
|
# ### Security Policies
|
157
157
|
#
|
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.
|
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.
|
159
159
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
160
160
|
# @param id [Integer] The primary key of this nexus
|
161
161
|
# @param include [String]
|
162
|
-
# @return [Object]
|
163
|
-
def get_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
164
|
-
get(path, options) end
|
165
|
-
|
166
|
-
# List company nexus related to a tax form
|
167
|
-
#
|
162
|
+
# @return [Object]
|
163
|
+
def get_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
164
|
+
get(path, options) end
|
165
|
+
|
166
|
+
# List company nexus related to a tax form
|
167
|
+
#
|
168
168
|
# Retrieves a list of nexus related to a tax form.
|
169
169
|
#
|
170
170
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -180,16 +180,16 @@ module AvaTax
|
|
180
180
|
#
|
181
181
|
# ### Security Policies
|
182
182
|
#
|
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.
|
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.
|
184
184
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
185
185
|
# @param formCode [String] The form code that we are looking up the nexus for
|
186
186
|
# @param include [String]
|
187
|
-
# @return [Object]
|
188
|
-
def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
189
|
-
get(path, options) end
|
190
|
-
|
191
|
-
# Retrieve a single nexus parameter
|
192
|
-
#
|
187
|
+
# @return [Object]
|
188
|
+
def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
189
|
+
get(path, options) end
|
190
|
+
|
191
|
+
# Retrieve a single nexus parameter
|
192
|
+
#
|
193
193
|
# Retrieve a single nexus parameter.
|
194
194
|
# 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".
|
195
195
|
#
|
@@ -199,16 +199,16 @@ module AvaTax
|
|
199
199
|
#
|
200
200
|
# ### Security Policies
|
201
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.
|
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
203
|
# @param companyId [Integer] The company id
|
204
204
|
# @param nexusId [Integer] The nexus id
|
205
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
|
-
#
|
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
212
|
# List all nexus objects defined for this company.
|
213
213
|
#
|
214
214
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -223,19 +223,19 @@ module AvaTax
|
|
223
223
|
#
|
224
224
|
# ### Security Policies
|
225
225
|
#
|
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.
|
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.
|
227
227
|
# @param companyId [Integer] The ID of the company that owns these nexus objects
|
228
228
|
# @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
229
|
# @param include [String] A comma separated list of additional data to retrieve.
|
230
230
|
# @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
231
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
232
232
|
# @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={}) path = "/api/v2/companies/#{companyId}/nexus"
|
235
|
-
get(path, options) end
|
236
|
-
|
237
|
-
# Retrieve parameters for a nexus
|
238
|
-
#
|
233
|
+
# @return [FetchResult]
|
234
|
+
def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
|
235
|
+
get(path, options) end
|
236
|
+
|
237
|
+
# Retrieve parameters for a nexus
|
238
|
+
#
|
239
239
|
# List parameters for a nexus.
|
240
240
|
# 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".
|
241
241
|
#
|
@@ -248,19 +248,19 @@ module AvaTax
|
|
248
248
|
#
|
249
249
|
# ### Security Policies
|
250
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.
|
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
252
|
# @param companyId [Integer] The company id
|
253
253
|
# @param nexusId [Integer] The nexus id
|
254
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
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
256
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
257
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
|
-
#
|
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
264
|
# Get multiple nexus objects across all companies.
|
265
265
|
#
|
266
266
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -275,18 +275,18 @@ module AvaTax
|
|
275
275
|
#
|
276
276
|
# ### Security Policies
|
277
277
|
#
|
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.
|
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.
|
279
279
|
# @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
280
|
# @param include [String] A comma separated list of additional data to retrieve.
|
281
281
|
# @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
282
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
283
283
|
# @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={}) path = "/api/v2/nexus"
|
286
|
-
get(path, options) end
|
287
|
-
|
288
|
-
# Update a single nexus
|
289
|
-
#
|
284
|
+
# @return [FetchResult]
|
285
|
+
def query_nexus(options={}) path = "/api/v2/nexus"
|
286
|
+
get(path, options) end
|
287
|
+
|
288
|
+
# Update a single nexus
|
289
|
+
#
|
290
290
|
# Replace the existing nexus declaration object at this URL with an updated object.
|
291
291
|
#
|
292
292
|
# The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
|
@@ -309,16 +309,16 @@ module AvaTax
|
|
309
309
|
#
|
310
310
|
# ### Security Policies
|
311
311
|
#
|
312
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
312
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
313
313
|
# @param companyId [Integer] The ID of the company that this nexus belongs to.
|
314
314
|
# @param id [Integer] The ID of the nexus you wish to update
|
315
315
|
# @param model [Object] The nexus object you wish to update.
|
316
|
-
# @return [Object]
|
317
|
-
def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
318
|
-
put(path, model) end
|
319
|
-
|
320
|
-
# Update an nexus parameter
|
321
|
-
#
|
316
|
+
# @return [Object]
|
317
|
+
def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
318
|
+
put(path, model) end
|
319
|
+
|
320
|
+
# Update an nexus parameter
|
321
|
+
#
|
322
322
|
# Update an nexus parameter.
|
323
323
|
#
|
324
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".
|
@@ -329,14 +329,14 @@ module AvaTax
|
|
329
329
|
#
|
330
330
|
# ### Security Policies
|
331
331
|
#
|
332
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
332
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
333
333
|
# @param companyId [Integer] The company id.
|
334
334
|
# @param nexusId [Integer] The nexus id
|
335
335
|
# @param id [Integer] The nexus parameter id
|
336
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
|
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
|
342
342
|
end
|
@@ -14,16 +14,12 @@ module AvaTax
|
|
14
14
|
#
|
15
15
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
16
16
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
17
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
18
17
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
19
18
|
# @param id [Integer] The ID of the tax notice we are adding the comment for.
|
20
19
|
# @param model [NoticeCommentModel[]] The notice comments you wish to create.
|
21
20
|
# @return [NoticeCommentModel[]]
|
22
|
-
def create_notice_comment(companyId, id, model)
|
23
|
-
path
|
24
|
-
post(path, model)
|
25
|
-
end
|
26
|
-
|
21
|
+
def create_notice_comment(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
|
22
|
+
post(path, model) end
|
27
23
|
|
28
24
|
# Create a new notice finance details.
|
29
25
|
#
|
@@ -37,16 +33,12 @@ module AvaTax
|
|
37
33
|
#
|
38
34
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
39
35
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
40
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
41
36
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
42
37
|
# @param id [Integer] The ID of the notice added to the finance details.
|
43
38
|
# @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
|
44
39
|
# @return [NoticeFinanceModel[]]
|
45
|
-
def create_notice_finance_details(companyId, id, model)
|
46
|
-
path
|
47
|
-
post(path, model)
|
48
|
-
end
|
49
|
-
|
40
|
+
def create_notice_finance_details(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
|
41
|
+
post(path, model) end
|
50
42
|
|
51
43
|
# Create a new notice responsibility.
|
52
44
|
#
|
@@ -59,16 +51,12 @@ module AvaTax
|
|
59
51
|
#
|
60
52
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
61
53
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
62
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
63
54
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
64
55
|
# @param id [Integer] The ID of the tax notice we are adding the responsibility for.
|
65
56
|
# @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
|
66
57
|
# @return [NoticeResponsibilityDetailModel[]]
|
67
|
-
def create_notice_responsibilities(companyId, id, model)
|
68
|
-
path
|
69
|
-
post(path, model)
|
70
|
-
end
|
71
|
-
|
58
|
+
def create_notice_responsibilities(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
|
59
|
+
post(path, model) end
|
72
60
|
|
73
61
|
# Create a new notice root cause.
|
74
62
|
#
|
@@ -81,16 +69,12 @@ module AvaTax
|
|
81
69
|
#
|
82
70
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
83
71
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
84
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
85
72
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
86
73
|
# @param id [Integer] The ID of the tax notice we are adding the responsibility for.
|
87
74
|
# @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
|
88
75
|
# @return [NoticeRootCauseDetailModel[]]
|
89
|
-
def create_notice_root_causes(companyId, id, model)
|
90
|
-
path
|
91
|
-
post(path, model)
|
92
|
-
end
|
93
|
-
|
76
|
+
def create_notice_root_causes(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
|
77
|
+
post(path, model) end
|
94
78
|
|
95
79
|
# Create a new notice.
|
96
80
|
#
|
@@ -103,15 +87,11 @@ module AvaTax
|
|
103
87
|
#
|
104
88
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
105
89
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
106
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
107
90
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
108
91
|
# @param model [NoticeModel[]] The notice object you wish to create.
|
109
92
|
# @return [NoticeModel[]]
|
110
|
-
def create_notices(companyId, model)
|
111
|
-
path
|
112
|
-
post(path, model)
|
113
|
-
end
|
114
|
-
|
93
|
+
def create_notices(companyId, model) path = "/api/v2/companies/#{companyId}/notices"
|
94
|
+
post(path, model) end
|
115
95
|
|
116
96
|
# Delete a single notice.
|
117
97
|
#
|
@@ -124,16 +104,12 @@ module AvaTax
|
|
124
104
|
#
|
125
105
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
126
106
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
127
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
128
107
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
129
108
|
# @param id [Integer] The ID of the notice you wish to delete the finance detail from.
|
130
109
|
# @param commentDetailsId [Integer] The ID of the comment you wish to delete.
|
131
110
|
# @return [ErrorDetail[]]
|
132
|
-
def delete_comment_details(companyId, id, commentDetailsId)
|
133
|
-
path
|
134
|
-
delete(path)
|
135
|
-
end
|
136
|
-
|
111
|
+
def delete_comment_details(companyId, id, commentDetailsId) path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
|
112
|
+
delete(path) end
|
137
113
|
|
138
114
|
# Delete a single notice.
|
139
115
|
#
|
@@ -147,16 +123,12 @@ module AvaTax
|
|
147
123
|
#
|
148
124
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
149
125
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
150
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
151
126
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
152
127
|
# @param id [Integer] The ID of the notice you wish to delete the finance detail from.
|
153
128
|
# @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
|
154
129
|
# @return [ErrorDetail[]]
|
155
|
-
def delete_finance_details(companyId, id, financeDetailsId)
|
156
|
-
path
|
157
|
-
delete(path)
|
158
|
-
end
|
159
|
-
|
130
|
+
def delete_finance_details(companyId, id, financeDetailsId) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
|
131
|
+
delete(path) end
|
160
132
|
|
161
133
|
# Delete a single notice.
|
162
134
|
#
|
@@ -169,15 +141,11 @@ module AvaTax
|
|
169
141
|
#
|
170
142
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
171
143
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
172
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
173
144
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
174
145
|
# @param id [Integer] The ID of the notice you wish to delete.
|
175
146
|
# @return [ErrorDetail[]]
|
176
|
-
def delete_notice(companyId, id)
|
177
|
-
path
|
178
|
-
delete(path)
|
179
|
-
end
|
180
|
-
|
147
|
+
def delete_notice(companyId, id) path = "/api/v2/companies/#{companyId}/notices/#{id}"
|
148
|
+
delete(path) end
|
181
149
|
|
182
150
|
# Delete a single responsibility
|
183
151
|
#
|
@@ -190,16 +158,12 @@ module AvaTax
|
|
190
158
|
#
|
191
159
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
192
160
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
193
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
194
161
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
195
162
|
# @param noticeId [Integer] The ID of the notice you wish to delete.
|
196
163
|
# @param id [Integer] The ID of the responsibility you wish to delete.
|
197
164
|
# @return [ErrorDetail[]]
|
198
|
-
def delete_responsibilities(companyId, noticeId, id)
|
199
|
-
path
|
200
|
-
delete(path)
|
201
|
-
end
|
202
|
-
|
165
|
+
def delete_responsibilities(companyId, noticeId, id) path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
|
166
|
+
delete(path) end
|
203
167
|
|
204
168
|
# Delete a single root cause.
|
205
169
|
#
|
@@ -212,16 +176,12 @@ module AvaTax
|
|
212
176
|
#
|
213
177
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
214
178
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
215
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
216
179
|
# @param companyId [Integer] The ID of the company that owns this notice.
|
217
180
|
# @param noticeId [Integer] The ID of the notice you wish to delete.
|
218
181
|
# @param id [Integer] The ID of the root cause you wish to delete.
|
219
182
|
# @return [ErrorDetail[]]
|
220
|
-
def delete_root_causes(companyId, noticeId, id)
|
221
|
-
path
|
222
|
-
delete(path)
|
223
|
-
end
|
224
|
-
|
183
|
+
def delete_root_causes(companyId, noticeId, id) path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
|
184
|
+
delete(path) end
|
225
185
|
|
226
186
|
# Retrieve a single attachment
|
227
187
|
#
|
@@ -232,15 +192,11 @@ module AvaTax
|
|
232
192
|
#
|
233
193
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
234
194
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
235
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
236
195
|
# @param companyId [Integer] The ID of the company for this attachment.
|
237
196
|
# @param id [Integer] The ResourceFileId of the attachment to download.
|
238
197
|
# @return [Object]
|
239
|
-
def download_notice_attachment(companyId, id)
|
240
|
-
path
|
241
|
-
get(path)
|
242
|
-
end
|
243
|
-
|
198
|
+
def download_notice_attachment(companyId, id) path = "/api/v2/companies/#{companyId}/notices/files/#{id}/attachment"
|
199
|
+
get(path) end
|
244
200
|
|
245
201
|
# Retrieve a single notice.
|
246
202
|
#
|
@@ -253,15 +209,11 @@ module AvaTax
|
|
253
209
|
#
|
254
210
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
255
211
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
256
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
257
212
|
# @param companyId [Integer] The ID of the company for this notice.
|
258
213
|
# @param id [Integer] The ID of this notice.
|
259
214
|
# @return [Object]
|
260
|
-
def get_notice(companyId, id)
|
261
|
-
path
|
262
|
-
get(path)
|
263
|
-
end
|
264
|
-
|
215
|
+
def get_notice(companyId, id) path = "/api/v2/companies/#{companyId}/notices/#{id}"
|
216
|
+
get(path) end
|
265
217
|
|
266
218
|
# Retrieve notice comments for a specific notice.
|
267
219
|
#
|
@@ -274,15 +226,11 @@ module AvaTax
|
|
274
226
|
#
|
275
227
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
276
228
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
277
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
278
229
|
# @param id [Integer] The ID of the notice.
|
279
230
|
# @param companyId [Integer] The ID of the company that owns these notices.
|
280
231
|
# @return [FetchResult]
|
281
|
-
def get_notice_comments(id, companyId)
|
282
|
-
path
|
283
|
-
get(path)
|
284
|
-
end
|
285
|
-
|
232
|
+
def get_notice_comments(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
|
233
|
+
get(path) end
|
286
234
|
|
287
235
|
# Retrieve notice finance details for a specific notice.
|
288
236
|
#
|
@@ -296,15 +244,11 @@ module AvaTax
|
|
296
244
|
#
|
297
245
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
298
246
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
299
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
300
247
|
# @param id [Integer] The ID of the company that owns these notices.
|
301
248
|
# @param companyId [Integer] The ID of the company that owns these notices.
|
302
249
|
# @return [FetchResult]
|
303
|
-
def get_notice_finance_details(id, companyId)
|
304
|
-
path
|
305
|
-
get(path)
|
306
|
-
end
|
307
|
-
|
250
|
+
def get_notice_finance_details(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
|
251
|
+
get(path) end
|
308
252
|
|
309
253
|
# Retrieve notice responsibilities for a specific notice.
|
310
254
|
#
|
@@ -317,15 +261,11 @@ module AvaTax
|
|
317
261
|
#
|
318
262
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
319
263
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
320
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
321
264
|
# @param id [Integer] The ID of the notice.
|
322
265
|
# @param companyId [Integer] The ID of the company that owns these notices.
|
323
266
|
# @return [FetchResult]
|
324
|
-
def get_notice_responsibilities(id, companyId)
|
325
|
-
path
|
326
|
-
get(path)
|
327
|
-
end
|
328
|
-
|
267
|
+
def get_notice_responsibilities(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
|
268
|
+
get(path) end
|
329
269
|
|
330
270
|
# Retrieve notice root causes for a specific notice.
|
331
271
|
#
|
@@ -338,15 +278,11 @@ module AvaTax
|
|
338
278
|
#
|
339
279
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
340
280
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
341
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
342
281
|
# @param id [Integer] The ID of the notice.
|
343
282
|
# @param companyId [Integer] The ID of the company that owns these notices.
|
344
283
|
# @return [FetchResult]
|
345
|
-
def get_notice_root_causes(id, companyId)
|
346
|
-
path
|
347
|
-
get(path)
|
348
|
-
end
|
349
|
-
|
284
|
+
def get_notice_root_causes(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
|
285
|
+
get(path) end
|
350
286
|
|
351
287
|
# Retrieve notices for a company.
|
352
288
|
#
|
@@ -362,7 +298,6 @@ module AvaTax
|
|
362
298
|
#
|
363
299
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
364
300
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
365
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
366
301
|
# @param companyId [Integer] The ID of the company that owns these notices.
|
367
302
|
# @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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
|
368
303
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -370,11 +305,8 @@ module AvaTax
|
|
370
305
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
371
306
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
372
307
|
# @return [FetchResult]
|
373
|
-
def list_notices_by_company(companyId, options={})
|
374
|
-
path
|
375
|
-
get(path, options)
|
376
|
-
end
|
377
|
-
|
308
|
+
def list_notices_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/notices"
|
309
|
+
get(path, options) end
|
378
310
|
|
379
311
|
# Retrieve all notices.
|
380
312
|
#
|
@@ -393,18 +325,14 @@ module AvaTax
|
|
393
325
|
#
|
394
326
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
395
327
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
396
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
397
328
|
# @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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
|
398
329
|
# @param include [String] A comma separated list of additional data to retrieve.
|
399
330
|
# @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.
|
400
331
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
401
332
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
402
333
|
# @return [FetchResult]
|
403
|
-
def query_notices(options={})
|
404
|
-
path
|
405
|
-
get(path, options)
|
406
|
-
end
|
407
|
-
|
334
|
+
def query_notices(options={}) path = "/api/v2/notices"
|
335
|
+
get(path, options) end
|
408
336
|
|
409
337
|
# Retrieve all notices.
|
410
338
|
#
|
@@ -417,14 +345,10 @@ module AvaTax
|
|
417
345
|
#
|
418
346
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
419
347
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
420
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
421
348
|
# @param model [Object] Query object to filter, sort and paginate the filing calendars.
|
422
349
|
# @return [FetchResult]
|
423
|
-
def query_notices_post(model)
|
424
|
-
path
|
425
|
-
post(path, model)
|
426
|
-
end
|
427
|
-
|
350
|
+
def query_notices_post(model) path = "/api/v2/notices/query"
|
351
|
+
post(path, model) end
|
428
352
|
|
429
353
|
# Update a single notice finance detail.
|
430
354
|
#
|
@@ -436,17 +360,13 @@ module AvaTax
|
|
436
360
|
#
|
437
361
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
438
362
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
439
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
440
363
|
# @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
|
441
364
|
# @param noticeid [Integer] The ID of the notice finance detail you wish to update.
|
442
365
|
# @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
|
443
366
|
# @param model [Object] The notice finance detail object you wish to update.
|
444
367
|
# @return [Object]
|
445
|
-
def update_finance_details(companyId, noticeid, financeDetailsId, model)
|
446
|
-
path
|
447
|
-
put(path, model)
|
448
|
-
end
|
449
|
-
|
368
|
+
def update_finance_details(companyId, noticeid, financeDetailsId, model) path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
|
369
|
+
put(path, model) end
|
450
370
|
|
451
371
|
# Update a single notice.
|
452
372
|
#
|
@@ -461,16 +381,12 @@ module AvaTax
|
|
461
381
|
#
|
462
382
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
463
383
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
464
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
465
384
|
# @param companyId [Integer] The ID of the company that this notice belongs to.
|
466
385
|
# @param id [Integer] The ID of the notice you wish to update.
|
467
386
|
# @param model [Object] The notice object you wish to update.
|
468
387
|
# @return [Object]
|
469
|
-
def update_notice(companyId, id, model)
|
470
|
-
path
|
471
|
-
put(path, model)
|
472
|
-
end
|
473
|
-
|
388
|
+
def update_notice(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}"
|
389
|
+
put(path, model) end
|
474
390
|
|
475
391
|
# Update a single notice comment.
|
476
392
|
#
|
@@ -482,19 +398,15 @@ module AvaTax
|
|
482
398
|
#
|
483
399
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
484
400
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
485
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
486
401
|
# @param companyId [Integer] The ID of the company that this notice comment belongs to.
|
487
402
|
# @param noticeid [Integer] The ID of the notice you wish to update.
|
488
403
|
# @param commentDetailsId [Integer] The ID of the comment you wish to update.
|
489
404
|
# @param model [Object] The notice comment object you wish to update.
|
490
405
|
# @return [Object]
|
491
|
-
def update_notice_comments(companyId, noticeid, commentDetailsId, model)
|
492
|
-
path
|
493
|
-
put(path, model)
|
494
|
-
end
|
406
|
+
def update_notice_comments(companyId, noticeid, commentDetailsId, model) path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
|
407
|
+
put(path, model) end
|
495
408
|
|
496
|
-
|
497
|
-
# Retrieve a single attachment
|
409
|
+
# Upload a new notice attachment.
|
498
410
|
#
|
499
411
|
# This API is available by invitation only.
|
500
412
|
#
|
@@ -504,15 +416,11 @@ module AvaTax
|
|
504
416
|
#
|
505
417
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
506
418
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
507
|
-
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
508
419
|
# @param companyId [Integer] The ID of the company for this attachment.
|
509
420
|
# @param model [Object] The upload request.
|
510
421
|
# @return [Object]
|
511
|
-
def upload_attachment(companyId, model)
|
512
|
-
path
|
513
|
-
post(path, model)
|
514
|
-
end
|
515
|
-
|
422
|
+
def upload_attachment(companyId, model) path = "/api/v2/companies/#{companyId}/notices/files/attachment"
|
423
|
+
post(path, model) end
|
516
424
|
end
|
517
425
|
end
|
518
426
|
end
|