avatax 21.3.1 → 21.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +83 -83
- data/lib/avatax/client/addresses.rb +20 -20
- data/lib/avatax/client/advancedrules.rb +41 -41
- data/lib/avatax/client/avafileforms.rb +41 -41
- data/lib/avatax/client/batches.rb +62 -62
- data/lib/avatax/client/certexpressinvites.rb +27 -27
- data/lib/avatax/client/certificates.rb +111 -111
- data/lib/avatax/client/companies.rb +153 -153
- data/lib/avatax/client/contacts.rb +48 -48
- data/lib/avatax/client/customers.rb +97 -97
- data/lib/avatax/client/datasources.rb +48 -48
- data/lib/avatax/client/definitions.rb +591 -422
- data/lib/avatax/client/distancethresholds.rb +48 -48
- data/lib/avatax/client/ecommercetoken.rb +16 -16
- data/lib/avatax/client/filingcalendars.rb +39 -20
- data/lib/avatax/client/filings.rb +20 -20
- data/lib/avatax/client/firmclientlinkages.rb +69 -69
- data/lib/avatax/client/free.rb +13 -13
- data/lib/avatax/client/fundingrequests.rb +20 -20
- data/lib/avatax/client/items.rb +255 -137
- data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
- data/lib/avatax/client/locations.rb +90 -90
- data/lib/avatax/client/multidocument.rb +76 -76
- data/lib/avatax/client/nexus.rb +133 -105
- data/lib/avatax/client/notices.rb +37 -406
- data/lib/avatax/client/notifications.rb +27 -27
- data/lib/avatax/client/provisioning.rb +20 -20
- data/lib/avatax/client/registrar.rb +85 -75
- data/lib/avatax/client/reports.rb +35 -35
- data/lib/avatax/client/settings.rb +55 -50
- data/lib/avatax/client/subscriptions.rb +27 -27
- data/lib/avatax/client/taxcodes.rb +48 -48
- data/lib/avatax/client/taxcontent.rb +41 -41
- data/lib/avatax/client/taxrules.rb +50 -50
- data/lib/avatax/client/transactions.rb +154 -154
- data/lib/avatax/client/upcs.rb +48 -48
- data/lib/avatax/client/users.rb +64 -64
- data/lib/avatax/client/utilities.rb +27 -27
- data/lib/avatax/version.rb +1 -1
- metadata +11 -4
@@ -3,424 +3,55 @@ module AvaTax
|
|
3
3
|
module Notices
|
4
4
|
|
5
5
|
|
6
|
-
#
|
7
|
-
#
|
8
|
-
# This API is available by invitation only.
|
9
|
-
#
|
10
|
-
#
|
11
|
-
#
|
12
|
-
#
|
13
|
-
#
|
14
|
-
#
|
15
|
-
#
|
16
|
-
|
17
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
18
|
-
# @param id [Integer] The ID of the tax notice we are adding the comment for.
|
19
|
-
# @param model [NoticeCommentModel[]] The notice comments you wish to create.
|
20
|
-
# @return [NoticeCommentModel[]]
|
21
|
-
def create_notice_comment(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
|
22
|
-
post(path, model) end
|
23
|
-
|
24
|
-
# Create a new notice finance details.
|
25
|
-
#
|
26
|
-
# This API is available by invitation only.
|
27
|
-
# 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
|
28
|
-
# as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
|
29
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
30
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
31
|
-
#
|
32
|
-
# ### Security Policies
|
33
|
-
#
|
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.
|
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.
|
36
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
37
|
-
# @param id [Integer] The ID of the notice added to the finance details.
|
38
|
-
# @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
|
39
|
-
# @return [NoticeFinanceModel[]]
|
40
|
-
def create_notice_finance_details(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
|
41
|
-
post(path, model) end
|
42
|
-
|
43
|
-
# Create a new notice responsibility.
|
44
|
-
#
|
45
|
-
# This API is available by invitation only.
|
46
|
-
# 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
|
47
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
48
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
49
|
-
#
|
50
|
-
# ### Security Policies
|
51
|
-
#
|
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.
|
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.
|
54
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
55
|
-
# @param id [Integer] The ID of the tax notice we are adding the responsibility for.
|
56
|
-
# @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
|
57
|
-
# @return [NoticeResponsibilityDetailModel[]]
|
58
|
-
def create_notice_responsibilities(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
|
59
|
-
post(path, model) end
|
60
|
-
|
61
|
-
# Create a new notice root cause.
|
62
|
-
#
|
63
|
-
# This API is available by invitation only.
|
64
|
-
# 'Notice root causes' are are those who are responsible for the notice.
|
65
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
66
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
67
|
-
#
|
68
|
-
# ### Security Policies
|
69
|
-
#
|
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.
|
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.
|
72
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
73
|
-
# @param id [Integer] The ID of the tax notice we are adding the responsibility for.
|
74
|
-
# @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
|
75
|
-
# @return [NoticeRootCauseDetailModel[]]
|
76
|
-
def create_notice_root_causes(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
|
6
|
+
# Creates a new tax notice responsibility type.
|
7
|
+
#
|
8
|
+
# This API is available by invitation only and only available for users with Compliance admin access.
|
9
|
+
#
|
10
|
+
# ### Security Policies
|
11
|
+
#
|
12
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
13
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
14
|
+
# @param model [Object] The responsibility type to create
|
15
|
+
# @return [Object]
|
16
|
+
def create_notice_responsibility_type(model) path = "/api/v2/notices/responsibilities"
|
77
17
|
post(path, model) end
|
78
18
|
|
79
|
-
#
|
80
|
-
#
|
81
|
-
# This API is available by invitation only.
|
82
|
-
# Create one or more new notice objects.
|
83
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
84
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
85
|
-
#
|
86
|
-
# ### Security Policies
|
19
|
+
# Creates a new tax notice root cause type.
|
87
20
|
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
|
21
|
+
# This API is available by invitation only and only available for users with Compliance admin access.
|
22
|
+
#
|
23
|
+
# ### Security Policies
|
24
|
+
#
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
26
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
27
|
+
# @param model [Object] The root cause type to create
|
28
|
+
# @return [Object]
|
29
|
+
def create_notice_root_cause_type(model) path = "/api/v2/notices/rootcauses"
|
94
30
|
post(path, model) end
|
95
31
|
|
96
|
-
# Delete a
|
97
|
-
#
|
98
|
-
# This API is available by invitation only.
|
99
|
-
# 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
|
100
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
101
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
32
|
+
# Delete a tax notice responsibility type.
|
102
33
|
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
# @param
|
109
|
-
# @param commentDetailsId [Integer] The ID of the comment you wish to delete.
|
34
|
+
# This API is available by invitation only and only available for users with Compliance admin access.
|
35
|
+
#
|
36
|
+
# ### Security Policies
|
37
|
+
#
|
38
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
39
|
+
# @param responsibilityId [Integer] The unique ID of the responsibility type
|
110
40
|
# @return [ErrorDetail[]]
|
111
|
-
def
|
41
|
+
def delete_notice_responsibility_type(responsibilityId) path = "/api/v2/notices/responsibilities/#{responsibilityId}"
|
112
42
|
delete(path) end
|
113
43
|
|
114
|
-
# Delete a
|
115
|
-
#
|
116
|
-
# This API is available by invitation only.
|
117
|
-
# 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
|
118
|
-
# as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
|
119
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
120
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
44
|
+
# Delete a tax notice root cause type.
|
121
45
|
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
# @param
|
128
|
-
# @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
|
46
|
+
# This API is available by invitation only and only available for users with Compliance admin access.
|
47
|
+
#
|
48
|
+
# ### Security Policies
|
49
|
+
#
|
50
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
51
|
+
# @param rootCauseId [Integer] The unique ID of the root cause type
|
129
52
|
# @return [ErrorDetail[]]
|
130
|
-
def
|
53
|
+
def delete_notice_root_cause_type(rootCauseId) path = "/api/v2/notices/rootcauses/#{rootCauseId}"
|
131
54
|
delete(path) end
|
132
|
-
|
133
|
-
# Delete a single notice.
|
134
|
-
#
|
135
|
-
# This API is available by invitation only.
|
136
|
-
# Mark the existing notice object at this URL as deleted.
|
137
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
138
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
139
|
-
#
|
140
|
-
# ### Security Policies
|
141
|
-
#
|
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.
|
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.
|
144
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
145
|
-
# @param id [Integer] The ID of the notice you wish to delete.
|
146
|
-
# @return [ErrorDetail[]]
|
147
|
-
def delete_notice(companyId, id) path = "/api/v2/companies/#{companyId}/notices/#{id}"
|
148
|
-
delete(path) end
|
149
|
-
|
150
|
-
# Delete a single responsibility
|
151
|
-
#
|
152
|
-
# This API is available by invitation only.
|
153
|
-
# Mark the existing notice object at this URL as deleted.
|
154
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
155
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
156
|
-
#
|
157
|
-
# ### Security Policies
|
158
|
-
#
|
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.
|
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.
|
161
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
162
|
-
# @param noticeId [Integer] The ID of the notice you wish to delete.
|
163
|
-
# @param id [Integer] The ID of the responsibility you wish to delete.
|
164
|
-
# @return [ErrorDetail[]]
|
165
|
-
def delete_responsibilities(companyId, noticeId, id) path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
|
166
|
-
delete(path) end
|
167
|
-
|
168
|
-
# Delete a single root cause.
|
169
|
-
#
|
170
|
-
# This API is available by invitation only.
|
171
|
-
# Mark the existing notice object at this URL as deleted.
|
172
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
173
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
174
|
-
#
|
175
|
-
# ### Security Policies
|
176
|
-
#
|
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.
|
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.
|
179
|
-
# @param companyId [Integer] The ID of the company that owns this notice.
|
180
|
-
# @param noticeId [Integer] The ID of the notice you wish to delete.
|
181
|
-
# @param id [Integer] The ID of the root cause you wish to delete.
|
182
|
-
# @return [ErrorDetail[]]
|
183
|
-
def delete_root_causes(companyId, noticeId, id) path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
|
184
|
-
delete(path) end
|
185
|
-
|
186
|
-
# Retrieve a single attachment
|
187
|
-
#
|
188
|
-
# This API is available by invitation only.
|
189
|
-
# Get the file attachment identified by this URL.
|
190
|
-
#
|
191
|
-
# ### Security Policies
|
192
|
-
#
|
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.
|
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.
|
195
|
-
# @param companyId [Integer] The ID of the company for this attachment.
|
196
|
-
# @param id [Integer] The ResourceFileId of the attachment to download.
|
197
|
-
# @return [Object]
|
198
|
-
def download_notice_attachment(companyId, id) path = "/api/v2/companies/#{companyId}/notices/files/#{id}/attachment"
|
199
|
-
get(path) end
|
200
|
-
|
201
|
-
# Retrieve a single notice.
|
202
|
-
#
|
203
|
-
# This API is available by invitation only.
|
204
|
-
# Get the tax notice object identified by this URL.
|
205
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
206
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
207
|
-
#
|
208
|
-
# ### Security Policies
|
209
|
-
#
|
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.
|
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.
|
212
|
-
# @param companyId [Integer] The ID of the company for this notice.
|
213
|
-
# @param id [Integer] The ID of this notice.
|
214
|
-
# @return [Object]
|
215
|
-
def get_notice(companyId, id) path = "/api/v2/companies/#{companyId}/notices/#{id}"
|
216
|
-
get(path) end
|
217
|
-
|
218
|
-
# Retrieve notice comments for a specific notice.
|
219
|
-
#
|
220
|
-
# This API is available by invitation only.
|
221
|
-
# 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
|
222
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
223
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
224
|
-
#
|
225
|
-
# ### Security Policies
|
226
|
-
#
|
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.
|
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.
|
229
|
-
# @param id [Integer] The ID of the notice.
|
230
|
-
# @param companyId [Integer] The ID of the company that owns these notices.
|
231
|
-
# @return [FetchResult]
|
232
|
-
def get_notice_comments(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
|
233
|
-
get(path) end
|
234
|
-
|
235
|
-
# Retrieve notice finance details for a specific notice.
|
236
|
-
#
|
237
|
-
# This API is available by invitation only.
|
238
|
-
# 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
|
239
|
-
# as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
|
240
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
241
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
242
|
-
#
|
243
|
-
# ### Security Policies
|
244
|
-
#
|
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.
|
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.
|
247
|
-
# @param id [Integer] The ID of the company that owns these notices.
|
248
|
-
# @param companyId [Integer] The ID of the company that owns these notices.
|
249
|
-
# @return [FetchResult]
|
250
|
-
def get_notice_finance_details(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
|
251
|
-
get(path) end
|
252
|
-
|
253
|
-
# Retrieve notice responsibilities for a specific notice.
|
254
|
-
#
|
255
|
-
# This API is available by invitation only.
|
256
|
-
# 'Notice responsibilities' are are those who are responsible for the notice.
|
257
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
258
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
259
|
-
#
|
260
|
-
# ### Security Policies
|
261
|
-
#
|
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.
|
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.
|
264
|
-
# @param id [Integer] The ID of the notice.
|
265
|
-
# @param companyId [Integer] The ID of the company that owns these notices.
|
266
|
-
# @return [FetchResult]
|
267
|
-
def get_notice_responsibilities(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
|
268
|
-
get(path) end
|
269
|
-
|
270
|
-
# Retrieve notice root causes for a specific notice.
|
271
|
-
#
|
272
|
-
# This API is available by invitation only.
|
273
|
-
# 'Notice root causes' are are those who are responsible for the notice.
|
274
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
275
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
276
|
-
#
|
277
|
-
# ### Security Policies
|
278
|
-
#
|
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.
|
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.
|
281
|
-
# @param id [Integer] The ID of the notice.
|
282
|
-
# @param companyId [Integer] The ID of the company that owns these notices.
|
283
|
-
# @return [FetchResult]
|
284
|
-
def get_notice_root_causes(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
|
285
|
-
get(path) end
|
286
|
-
|
287
|
-
# Retrieve notices for a company.
|
288
|
-
#
|
289
|
-
# This API is available by invitation only.
|
290
|
-
# List all tax notice objects assigned to this company.
|
291
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
292
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
293
|
-
#
|
294
|
-
# 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/) .
|
295
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
296
|
-
#
|
297
|
-
# ### Security Policies
|
298
|
-
#
|
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.
|
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.
|
301
|
-
# @param companyId [Integer] The ID of the company that owns these notices.
|
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
|
303
|
-
# @param include [String] A comma separated list of additional data to retrieve.
|
304
|
-
# @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.
|
305
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
306
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
307
|
-
# @return [FetchResult]
|
308
|
-
def list_notices_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/notices"
|
309
|
-
get(path, options) end
|
310
|
-
|
311
|
-
# Retrieve all notices.
|
312
|
-
#
|
313
|
-
# This API is available by invitation only.
|
314
|
-
#
|
315
|
-
# This API is deprecated - please use POST `/api/v2/notices/query` API.
|
316
|
-
#
|
317
|
-
# Get multiple notice objects across all companies.
|
318
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
319
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
320
|
-
#
|
321
|
-
# 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/) .
|
322
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
323
|
-
#
|
324
|
-
# ### Security Policies
|
325
|
-
#
|
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.
|
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.
|
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
|
329
|
-
# @param include [String] A comma separated list of additional data to retrieve.
|
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.
|
331
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
332
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
333
|
-
# @return [FetchResult]
|
334
|
-
def query_notices(options={}) path = "/api/v2/notices"
|
335
|
-
get(path, options) end
|
336
|
-
|
337
|
-
# Retrieve all notices.
|
338
|
-
#
|
339
|
-
# This API is available by invitation only.
|
340
|
-
#
|
341
|
-
# This API is intended to replace the GET `/api/v2/notices` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.
|
342
|
-
# The documentation of the GET API shows how filtering, sorting and pagination works.
|
343
|
-
#
|
344
|
-
# ### Security Policies
|
345
|
-
#
|
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.
|
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.
|
348
|
-
# @param model [Object] Query object to filter, sort and paginate the filing calendars.
|
349
|
-
# @return [FetchResult]
|
350
|
-
def query_notices_post(model) path = "/api/v2/notices/query"
|
351
|
-
post(path, model) end
|
352
|
-
|
353
|
-
# Update a single notice finance detail.
|
354
|
-
#
|
355
|
-
# This API is available by invitation only.
|
356
|
-
# All data from the existing object will be replaced with data in the object you PUT.
|
357
|
-
# To set a field's value to null, you may either set its value to null or omit that field from the object you post.
|
358
|
-
#
|
359
|
-
# ### Security Policies
|
360
|
-
#
|
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.
|
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.
|
363
|
-
# @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
|
364
|
-
# @param noticeid [Integer] The ID of the notice finance detail you wish to update.
|
365
|
-
# @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
|
366
|
-
# @param model [Object] The notice finance detail object you wish to update.
|
367
|
-
# @return [Object]
|
368
|
-
def update_finance_details(companyId, noticeid, financeDetailsId, model) path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
|
369
|
-
put(path, model) end
|
370
|
-
|
371
|
-
# Update a single notice.
|
372
|
-
#
|
373
|
-
# This API is available by invitation only.
|
374
|
-
# Replace the existing notice object at this URL with an updated object.
|
375
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
376
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
377
|
-
# All data from the existing object will be replaced with data in the object you PUT.
|
378
|
-
# To set a field's value to null, you may either set its value to null or omit that field from the object you post.
|
379
|
-
#
|
380
|
-
# ### Security Policies
|
381
|
-
#
|
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.
|
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.
|
384
|
-
# @param companyId [Integer] The ID of the company that this notice belongs to.
|
385
|
-
# @param id [Integer] The ID of the notice you wish to update.
|
386
|
-
# @param model [Object] The notice object you wish to update.
|
387
|
-
# @return [Object]
|
388
|
-
def update_notice(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}"
|
389
|
-
put(path, model) end
|
390
|
-
|
391
|
-
# Update a single notice comment.
|
392
|
-
#
|
393
|
-
# This API is available by invitation only.
|
394
|
-
# All data from the existing object will be replaced with data in the object you PUT.
|
395
|
-
# To set a field's value to null, you may either set its value to null or omit that field from the object you post.
|
396
|
-
#
|
397
|
-
# ### Security Policies
|
398
|
-
#
|
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.
|
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.
|
401
|
-
# @param companyId [Integer] The ID of the company that this notice comment belongs to.
|
402
|
-
# @param noticeid [Integer] The ID of the notice you wish to update.
|
403
|
-
# @param commentDetailsId [Integer] The ID of the comment you wish to update.
|
404
|
-
# @param model [Object] The notice comment object you wish to update.
|
405
|
-
# @return [Object]
|
406
|
-
def update_notice_comments(companyId, noticeid, commentDetailsId, model) path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
|
407
|
-
put(path, model) end
|
408
|
-
|
409
|
-
# Upload a new notice attachment.
|
410
|
-
#
|
411
|
-
# This API is available by invitation only.
|
412
|
-
#
|
413
|
-
# Uploads a file attachment for a tax notice.
|
414
|
-
#
|
415
|
-
# ### Security Policies
|
416
|
-
#
|
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.
|
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.
|
419
|
-
# @param companyId [Integer] The ID of the company for this attachment.
|
420
|
-
# @param model [Object] The upload request.
|
421
|
-
# @return [Object]
|
422
|
-
def upload_attachment(companyId, model) path = "/api/v2/companies/#{companyId}/notices/files/attachment"
|
423
|
-
post(path, model) end
|
424
55
|
end
|
425
56
|
end
|
426
57
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Notifications
|
4
|
-
|
5
|
-
|
6
|
-
# Mark a single notification as dismissed.
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Notifications
|
4
|
+
|
5
|
+
|
6
|
+
# Mark a single notification as dismissed.
|
7
|
+
#
|
8
8
|
# Marks the notification identified by this URL as dismissed.
|
9
9
|
#
|
10
10
|
# A notification is a message from Avalara that may have relevance to your business. You may want
|
@@ -22,14 +22,14 @@ module AvaTax
|
|
22
22
|
#
|
23
23
|
# ### Security Policies
|
24
24
|
#
|
25
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
26
26
|
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
27
|
-
# @return [Object]
|
28
|
-
def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
|
29
|
-
put(path) end
|
30
|
-
|
31
|
-
# Retrieve a single notification.
|
32
|
-
#
|
27
|
+
# @return [Object]
|
28
|
+
def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
|
29
|
+
put(path) end
|
30
|
+
|
31
|
+
# Retrieve a single notification.
|
32
|
+
#
|
33
33
|
# Retrieve a single notification by its unique ID number.
|
34
34
|
#
|
35
35
|
# A notification is a message from Avalara that may have relevance to your business. You may want
|
@@ -41,14 +41,14 @@ module AvaTax
|
|
41
41
|
#
|
42
42
|
# ### Security Policies
|
43
43
|
#
|
44
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
44
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
45
45
|
# @param id [Integer] The id of the notification to retrieve.
|
46
|
-
# @return [Object]
|
47
|
-
def get_notification(id) path = "/api/v2/notifications/#{id}"
|
48
|
-
get(path) end
|
49
|
-
|
50
|
-
# List all notifications.
|
51
|
-
#
|
46
|
+
# @return [Object]
|
47
|
+
def get_notification(id) path = "/api/v2/notifications/#{id}"
|
48
|
+
get(path) end
|
49
|
+
|
50
|
+
# List all notifications.
|
51
|
+
#
|
52
52
|
# List all notifications.
|
53
53
|
#
|
54
54
|
# A notification is a message from Avalara that may have relevance to your business. You may want
|
@@ -63,14 +63,14 @@ module AvaTax
|
|
63
63
|
#
|
64
64
|
# ### Security Policies
|
65
65
|
#
|
66
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
66
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
67
67
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
|
68
68
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
69
69
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
70
70
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
71
|
-
# @return [FetchResult]
|
72
|
-
def list_notifications(options={}) path = "/api/v2/notifications"
|
73
|
-
get(path, options) end
|
74
|
-
end
|
75
|
-
end
|
71
|
+
# @return [FetchResult]
|
72
|
+
def list_notifications(options={}) path = "/api/v2/notifications"
|
73
|
+
get(path, options) end
|
74
|
+
end
|
75
|
+
end
|
76
76
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Provisioning
|
4
|
-
|
5
|
-
|
6
|
-
# Request a new Avalara account
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Provisioning
|
4
|
+
|
5
|
+
|
6
|
+
# Request a new Avalara account
|
7
|
+
#
|
8
8
|
# This API is for use by partner provisioning services customers only.
|
9
9
|
#
|
10
10
|
# Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
|
@@ -24,14 +24,14 @@ module AvaTax
|
|
24
24
|
#
|
25
25
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
26
|
# * This API is available by invitation only.
|
27
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
27
|
+
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
28
28
|
# @param model [Object] Information about the account you wish to create and the selected product offerings.
|
29
|
-
# @return [Object]
|
30
|
-
def request_new_account(model) path = "/api/v2/accounts/request"
|
31
|
-
post(path, model) end
|
32
|
-
|
33
|
-
# Request a new entitilement to an existing customer
|
34
|
-
#
|
29
|
+
# @return [Object]
|
30
|
+
def request_new_account(model) path = "/api/v2/accounts/request"
|
31
|
+
post(path, model) end
|
32
|
+
|
33
|
+
# Request a new entitilement to an existing customer
|
34
|
+
#
|
35
35
|
# This API is for use by partner provisioning services customers only. This will allow the partners to allow
|
36
36
|
# the add new entitlement to an existing customer
|
37
37
|
#
|
@@ -39,12 +39,12 @@ module AvaTax
|
|
39
39
|
#
|
40
40
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
41
|
# * This API is available by invitation only.
|
42
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
42
|
+
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
43
43
|
# @param id [Integer] The avatax account id of the customer
|
44
44
|
# @param offer [String] The offer to be added to an already existing customer
|
45
|
-
# @return [Object]
|
46
|
-
def request_new_entitlement(id, offer) path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
|
47
|
-
post(path) end
|
48
|
-
end
|
49
|
-
end
|
45
|
+
# @return [Object]
|
46
|
+
def request_new_entitlement(id, offer) path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
|
47
|
+
post(path) end
|
48
|
+
end
|
49
|
+
end
|
50
50
|
end
|