avatax 20.7.1 → 21.3.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -27,7 +27,7 @@ module AvaTax
27
27
  # ### Security Policies
28
28
  #
29
29
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
30
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
30
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
31
31
  # @param code [String] The transaction code for this MultiDocument transaction
32
32
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
33
33
  # @param include [String] Specifies objects to include in this fetch call
@@ -64,7 +64,7 @@ module AvaTax
64
64
  # ### Security Policies
65
65
  #
66
66
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
67
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
67
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
68
68
  # @param code [String] The transaction code for this MultiDocument transaction
69
69
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
70
70
  # @return [Object]
@@ -93,7 +93,7 @@ module AvaTax
93
93
  # ### Security Policies
94
94
  #
95
95
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
96
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
96
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
97
97
  # @param model [Object] The commit request you wish to execute
98
98
  # @return [Object]
99
99
  def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
@@ -145,7 +145,7 @@ module AvaTax
145
145
  # ### Security Policies
146
146
  #
147
147
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
148
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
148
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
149
149
  # @param include [String] Specifies objects to include in the response after transaction is created
150
150
  # @param model [Object] the multi document transaction model
151
151
  # @return [Object]
@@ -178,9 +178,9 @@ module AvaTax
178
178
  # ### Security Policies
179
179
  #
180
180
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
181
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
182
- # @param code [String]
183
- # @param type [String] (See DocumentType::* for a list of allowable values)
181
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
182
+ # @param code [String] The multidocument code to retrieve
183
+ # @param type [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
184
184
  # @param include [String] Specifies objects to include in the response after transaction is created
185
185
  # @return [Object]
186
186
  def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
@@ -221,7 +221,7 @@ module AvaTax
221
221
  # ### Security Policies
222
222
  #
223
223
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
224
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
224
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
225
225
  # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
226
226
  # @param include [String] Specifies objects to include in the response after transaction is created
227
227
  # @return [Object]
@@ -261,7 +261,7 @@ module AvaTax
261
261
  # ### Security Policies
262
262
  #
263
263
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
264
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
264
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
265
265
  # @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
266
266
  # @param include [String] Specifies objects to include in the response after transaction is created
267
267
  # @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.
@@ -321,7 +321,7 @@ module AvaTax
321
321
  # ### Security Policies
322
322
  #
323
323
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
324
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
324
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
325
325
  # @param code [String] The code of this MultiDocument transaction
326
326
  # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
327
327
  # @param include [String] Specifies objects to include in the response after transaction is created
@@ -350,7 +350,7 @@ module AvaTax
350
350
  # ### Security Policies
351
351
  #
352
352
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
353
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
353
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
354
354
  # @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
355
355
  # @return [Object]
356
356
  def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
@@ -379,7 +379,7 @@ module AvaTax
379
379
  # ### Security Policies
380
380
  #
381
381
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
382
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
382
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
383
383
  # @param code [String] The transaction code for this MultiDocument transaction
384
384
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
385
385
  # @param model [Object] The void request you wish to execute
@@ -34,6 +34,29 @@ module AvaTax
34
34
  def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
35
35
  post(path, model) end
36
36
 
37
+ # Add parameters to a nexus.
38
+ #
39
+ # Add parameters to the nexus.
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
+ #
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.
45
+ #
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
+
37
60
  # Creates nexus for a list of addresses.
38
61
  #
39
62
  # This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
@@ -82,6 +105,43 @@ module AvaTax
82
105
  def delete_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
83
106
  delete(path, options) end
84
107
 
108
+ # Delete a single nexus parameter
109
+ #
110
+ # Delete a single nexus parameter.
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
+ #
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.
114
+ #
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
+
85
145
  # Retrieve a single nexus
86
146
  #
87
147
  # Get the nexus object identified by this URL.
@@ -128,6 +188,25 @@ module AvaTax
128
188
  def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
129
189
  get(path, options) end
130
190
 
191
+ # Retrieve a single nexus parameter
192
+ #
193
+ # Retrieve a single nexus parameter.
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
+ #
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.
199
+ #
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
+
131
210
  # Retrieve nexus for this company
132
211
  #
133
212
  # List all nexus objects defined for this company.
@@ -146,7 +225,7 @@ module AvaTax
146
225
  #
147
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.
148
227
  # @param companyId [Integer] The ID of the company that owns these nexus objects
149
- # @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
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, taxableNexus
150
229
  # @param include [String] A comma separated list of additional data to retrieve.
151
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.
152
231
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -155,6 +234,31 @@ module AvaTax
155
234
  def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
156
235
  get(path, options) end
157
236
 
237
+ # Retrieve parameters for a nexus
238
+ #
239
+ # List parameters for a nexus.
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
+ #
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.
248
+ #
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
+
158
262
  # Retrieve all nexus
159
263
  #
160
264
  # Get multiple nexus objects across all companies.
@@ -172,7 +276,7 @@ module AvaTax
172
276
  # ### Security Policies
173
277
  #
174
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.
175
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
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, taxableNexus
176
280
  # @param include [String] A comma separated list of additional data to retrieve.
177
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.
178
282
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -212,6 +316,27 @@ module AvaTax
212
316
  # @return [Object]
213
317
  def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
214
318
  put(path, model) end
319
+
320
+ # Update an nexus parameter
321
+ #
322
+ # Update an nexus parameter.
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
215
340
  end
216
341
  end
217
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 = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
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 = "/api/v2/companies/#{companyId}/notices"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
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 = "/api/v2/companies/#{companyId}/notices/#{id}"
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 = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
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 = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
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 = "/api/v2/companies/#{companyId}/notices/files/#{id}/attachment"
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 = "/api/v2/companies/#{companyId}/notices/#{id}"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
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 = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
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 = "/api/v2/companies/#{companyId}/notices"
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 = "/api/v2/notices"
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 = "/api/v2/notices/query"
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 = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
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 = "/api/v2/companies/#{companyId}/notices/#{id}"
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 = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
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 = "/api/v2/companies/#{companyId}/notices/files/attachment"
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