avatax 19.5.0 → 19.6.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/filingcalendars.rb +11 -452
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: acdb0cdea13e0be6e6a41ba6b3c5c40c009497443f9403f94f5343447135c827
|
|
4
|
+
data.tar.gz: 7c24642b868c3e02bcc874e904de688ea2fd36eadc2228777acf82b03c01e225
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1e1ced4ca131b1b80f375d193e3dacae07c464c4b54d0e360af1b3369e6d3bbbe3fac2a5a8ff45067efcb40914d36da0c120c6195b5d3b7e408794d8e1e2f440
|
|
7
|
+
data.tar.gz: b66ef8d5bce5646278dbcd61d023365c2010b42bd8f64fb18da15c5013513f61b4e2e54eaade3fe2a680f5bfc294c9697284a5a43405e1fc5750a128d920f9ea
|
|
@@ -3,468 +3,27 @@ module AvaTax
|
|
|
3
3
|
module FilingCalendars
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
#
|
|
6
|
+
# Checks to see if the company has a valid POA for a tax form code
|
|
7
7
|
#
|
|
8
8
|
# This API is available by invitation only.
|
|
9
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
10
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
11
|
-
# The filing request must be in the "ChangeRequest" status to be approved.
|
|
12
9
|
#
|
|
13
|
-
#
|
|
14
|
-
#
|
|
15
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
16
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
17
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
18
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing request object
|
|
19
|
-
# @param id [Integer] The unique ID of the filing request object
|
|
20
|
-
# @return [Object]
|
|
21
|
-
def approve_filing_request(companyId, id)
|
|
22
|
-
path = "/api/v2/companies/#{companyId}/filingrequests/#{id}/approve"
|
|
23
|
-
post(path)
|
|
24
|
-
end
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
# Cancel existing Filing Request
|
|
28
|
-
#
|
|
29
|
-
# This API is available by invitation only.
|
|
30
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
31
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
32
|
-
#
|
|
33
|
-
# ### Security Policies
|
|
34
|
-
#
|
|
35
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
36
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
37
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
38
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing request object
|
|
39
|
-
# @param id [Integer] The unique ID of the filing request object
|
|
40
|
-
# @return [Object]
|
|
41
|
-
def cancel_filing_request(companyId, id)
|
|
42
|
-
path = "/api/v2/companies/#{companyId}/filingrequests/#{id}/cancel"
|
|
43
|
-
post(path)
|
|
44
|
-
end
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
# Create a new filing request to cancel a filing calendar
|
|
48
|
-
#
|
|
49
|
-
# This API is available by invitation only.
|
|
50
|
-
#
|
|
51
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
52
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
53
|
-
#
|
|
54
|
-
# ### Security Policies
|
|
55
|
-
#
|
|
56
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
57
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
58
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
59
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
|
60
|
-
# @param id [Integer] The unique ID number of the filing calendar to cancel
|
|
61
|
-
# @param model [FilingRequestModel[]] The cancellation request for this filing calendar
|
|
62
|
-
# @return [Object]
|
|
63
|
-
def cancel_filing_requests(companyId, id, model)
|
|
64
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/request"
|
|
65
|
-
post(path, model)
|
|
66
|
-
end
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
# Create a filing calendar
|
|
70
|
-
#
|
|
71
|
-
# This API is available by invitation only and only available for users with Compliance access
|
|
72
|
-
# A "filing request" represents information that compliance uses to file a return
|
|
73
|
-
#
|
|
74
|
-
# ### Security Policies
|
|
75
|
-
#
|
|
76
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
77
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
78
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
79
|
-
# @param companyId [Integer] The unique ID of the company that will add the new filing calendar
|
|
80
|
-
# @param model [FilingCalendarModel[]] Filing calendars that will be added
|
|
81
|
-
# @return [Object]
|
|
82
|
-
def create_filing_calendars(companyId, model)
|
|
83
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars"
|
|
84
|
-
post(path, model)
|
|
85
|
-
end
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
# Create a new filing request to create a filing calendar
|
|
89
|
-
#
|
|
90
|
-
# This API is available by invitation only.
|
|
91
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
92
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
93
|
-
#
|
|
94
|
-
# ### Security Policies
|
|
95
|
-
#
|
|
96
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
97
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
98
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
99
|
-
# @param companyId [Integer] The unique ID of the company that will add the new filing calendar
|
|
100
|
-
# @param model [FilingRequestModel[]] Information about the proposed new filing calendar
|
|
101
|
-
# @return [Object]
|
|
102
|
-
def create_filing_requests(companyId, model)
|
|
103
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/add/request"
|
|
104
|
-
post(path, model)
|
|
105
|
-
end
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
# Returns a list of options for adding the specified form.
|
|
109
|
-
#
|
|
110
|
-
# This API is available by invitation only.
|
|
111
|
-
#
|
|
112
|
-
# ### Security Policies
|
|
113
|
-
#
|
|
114
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
115
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
116
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
117
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
|
118
|
-
# @param formCode [String] The unique code of the form
|
|
119
|
-
# @return [CycleAddOptionModel[]]
|
|
120
|
-
def cycle_safe_add(companyId, options={})
|
|
121
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/add/options"
|
|
122
|
-
get(path, options)
|
|
123
|
-
end
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
# Indicates when changes are allowed to be made to a filing calendar.
|
|
127
|
-
#
|
|
128
|
-
# This API is available by invitation only.
|
|
129
|
-
#
|
|
130
|
-
# ### Security Policies
|
|
131
|
-
#
|
|
132
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
133
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
134
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
135
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
|
136
|
-
# @param id [Integer] The unique ID of the filing calendar object
|
|
137
|
-
# @param model [FilingCalendarEditModel[]] A list of filing calendar edits to be made
|
|
138
|
-
# @return [Object]
|
|
139
|
-
def cycle_safe_edit(companyId, id, model)
|
|
140
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/options"
|
|
141
|
-
post(path, model)
|
|
142
|
-
end
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
# Returns a list of options for expiring a filing calendar
|
|
146
|
-
#
|
|
147
|
-
# This API is available by invitation only.
|
|
148
|
-
#
|
|
149
|
-
# ### Security Policies
|
|
150
|
-
#
|
|
151
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
152
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
153
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
154
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
|
155
|
-
# @param id [Integer] The unique ID of the filing calendar object
|
|
156
|
-
# @return [Object]
|
|
157
|
-
def cycle_safe_expiration(companyId, id)
|
|
158
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/options"
|
|
159
|
-
get(path)
|
|
160
|
-
end
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
# Delete a single filing calendar.
|
|
164
|
-
#
|
|
165
|
-
# This API is available by invitation only.
|
|
166
|
-
# Mark the existing notice object at this URL as deleted.
|
|
167
|
-
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
|
168
|
-
# Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
|
|
169
|
-
#
|
|
170
|
-
# ### Security Policies
|
|
171
|
-
#
|
|
172
|
-
# * 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.
|
|
173
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
174
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
175
|
-
# @param companyId [Integer] The ID of the company that owns this filing calendar.
|
|
176
|
-
# @param id [Integer] The ID of the filing calendar you wish to delete.
|
|
177
|
-
# @return [ErrorDetail[]]
|
|
178
|
-
def delete_filing_calendar(companyId, id)
|
|
179
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
|
|
180
|
-
delete(path)
|
|
181
|
-
end
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
# Retrieve a single filing calendar
|
|
185
|
-
#
|
|
186
|
-
# This API is available by invitation only.
|
|
187
|
-
#
|
|
188
|
-
# ### Security Policies
|
|
189
|
-
#
|
|
190
|
-
# * 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.
|
|
191
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
192
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
193
|
-
# @param companyId [Integer] The ID of the company that owns this filing calendar
|
|
194
|
-
# @param id [Integer] The primary key of this filing calendar
|
|
195
|
-
# @return [Object]
|
|
196
|
-
def get_filing_calendar(companyId, id)
|
|
197
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
|
|
198
|
-
get(path)
|
|
199
|
-
end
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
# Retrieve a single filing request
|
|
203
|
-
#
|
|
204
|
-
# This API is available by invitation only.
|
|
205
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
206
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
207
|
-
#
|
|
208
|
-
# ### Security Policies
|
|
209
|
-
#
|
|
210
|
-
# * 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.
|
|
211
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
212
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
213
|
-
# @param companyId [Integer] The ID of the company that owns this filing calendar
|
|
214
|
-
# @param id [Integer] The primary key of this filing calendar
|
|
215
|
-
# @return [Object]
|
|
216
|
-
def get_filing_request(companyId, id)
|
|
217
|
-
path = "/api/v2/companies/#{companyId}/filingrequests/#{id}"
|
|
218
|
-
get(path)
|
|
219
|
-
end
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
# Retrieve all filing calendars for this company
|
|
223
|
-
#
|
|
224
|
-
# This API is available by invitation only.
|
|
225
|
-
#
|
|
226
|
-
# ### Security Policies
|
|
227
|
-
#
|
|
228
|
-
# * 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.
|
|
229
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
230
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
231
|
-
# @param companyId [Integer] The ID of the company that owns these batches
|
|
232
|
-
# @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:* formCountry, formRegion, taxFormCode, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
|
|
233
|
-
# @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.
|
|
234
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
235
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
236
|
-
# @param returnCountry [String] A comma separated list of countries
|
|
237
|
-
# @param returnRegion [String] A comma separated list of regions
|
|
238
|
-
# @return [FetchResult]
|
|
239
|
-
def list_filing_calendars(companyId, options={})
|
|
240
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars"
|
|
241
|
-
get(path, options)
|
|
242
|
-
end
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
# Retrieve all filing requests for this company
|
|
246
|
-
#
|
|
247
|
-
# This API is available by invitation only.
|
|
248
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
249
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
10
|
+
# This API fetches valid POA's for a company by TaxFormCode or by country/region
|
|
250
11
|
#
|
|
251
12
|
# ### Security Policies
|
|
252
13
|
#
|
|
253
|
-
# * 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.
|
|
14
|
+
# * 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.
|
|
254
15
|
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
255
|
-
# * This API is available by invitation only.
|
|
256
|
-
# @param companyId [Integer] The
|
|
257
|
-
# @param
|
|
258
|
-
# @param
|
|
259
|
-
# @param
|
|
260
|
-
# @
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
def list_filing_requests(companyId, options={})
|
|
264
|
-
path = "/api/v2/companies/#{companyId}/filingrequests"
|
|
16
|
+
# * This API is available by invitation only.
|
|
17
|
+
# @param companyId [Integer] The company id that we are checking about
|
|
18
|
+
# @param taxFormCode [String] The tax form code that we are checking
|
|
19
|
+
# @param country [String] The country we are fetching POAs for
|
|
20
|
+
# @param region [String] The region we are fetching POAs for
|
|
21
|
+
# @return [PowerOfAttorneyCheckModel[]]
|
|
22
|
+
def active_power_of_attorney(companyId, options={})
|
|
23
|
+
path = "/api/v2/companies/#{companyId}/filingcalendars/powerofattorney"
|
|
265
24
|
get(path, options)
|
|
266
25
|
end
|
|
267
26
|
|
|
268
|
-
|
|
269
|
-
# New request for getting for validating customer's login credentials
|
|
270
|
-
#
|
|
271
|
-
# This API is available by invitation only.
|
|
272
|
-
#
|
|
273
|
-
# This API verifies that a customer has submitted correct login credentials for a tax authority's online filing system.
|
|
274
|
-
#
|
|
275
|
-
# ### Security Policies
|
|
276
|
-
#
|
|
277
|
-
# * 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.
|
|
278
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
279
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
280
|
-
# @param model [Object] The model of the login information we are verifying
|
|
281
|
-
# @return [Object]
|
|
282
|
-
def login_verification_request(model)
|
|
283
|
-
path = "/api/v2/filingcalendars/credentials/verify"
|
|
284
|
-
post(path, model)
|
|
285
|
-
end
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
# Gets the request status and Login Result
|
|
289
|
-
#
|
|
290
|
-
# This API is available by invitation only.
|
|
291
|
-
#
|
|
292
|
-
# This API checks the status of a login verification request. It may only be called by authorized users from the account
|
|
293
|
-
# that initially requested the login verification.
|
|
294
|
-
#
|
|
295
|
-
# ### Security Policies
|
|
296
|
-
#
|
|
297
|
-
# * 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.
|
|
298
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
299
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
300
|
-
# @param jobId [Integer] The unique ID number of this login request
|
|
301
|
-
# @return [Object]
|
|
302
|
-
def login_verification_status(jobId)
|
|
303
|
-
path = "/api/v2/filingcalendars/credentials/#{jobId}"
|
|
304
|
-
get(path)
|
|
305
|
-
end
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
# Retrieve all filing calendars
|
|
309
|
-
#
|
|
310
|
-
# This API is available by invitation only.
|
|
311
|
-
#
|
|
312
|
-
# This API is deprecated - please use POST `/api/v2/filingrequests/query` API.
|
|
313
|
-
#
|
|
314
|
-
# ### Security Policies
|
|
315
|
-
#
|
|
316
|
-
# * 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.
|
|
317
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
318
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
319
|
-
# @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:* formCountry, formRegion, taxFormCode, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
|
|
320
|
-
# @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
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
322
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
323
|
-
# @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
|
|
324
|
-
# @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
|
|
325
|
-
# @return [FetchResult]
|
|
326
|
-
def query_filing_calendars(options={})
|
|
327
|
-
path = "/api/v2/filingcalendars"
|
|
328
|
-
get(path, options)
|
|
329
|
-
end
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
# Retrieve all filing calendars
|
|
333
|
-
#
|
|
334
|
-
# This API is available by invitation only.
|
|
335
|
-
#
|
|
336
|
-
# This API is intended to replace the GET `/api/v2/filingcalendars` 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.
|
|
337
|
-
# The documentation of the GET API shows how filtering, sorting and pagination works.
|
|
338
|
-
#
|
|
339
|
-
# ### Security Policies
|
|
340
|
-
#
|
|
341
|
-
# * 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.
|
|
342
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
343
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
344
|
-
# @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
|
|
345
|
-
# @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
|
|
346
|
-
# @param model [Object] Query object to filter, sort and paginate the filing calendars.
|
|
347
|
-
# @return [FetchResult]
|
|
348
|
-
def query_filing_calendars_post(model, options={})
|
|
349
|
-
path = "/api/v2/filingcalendars/query"
|
|
350
|
-
post(path, model, options)
|
|
351
|
-
end
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
# Retrieve all filing requests
|
|
355
|
-
#
|
|
356
|
-
# This API is available by invitation only.
|
|
357
|
-
#
|
|
358
|
-
# This API is deprecated - please use POST `/api/v2/filingrequests/query` API.
|
|
359
|
-
#
|
|
360
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
361
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
362
|
-
#
|
|
363
|
-
# 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/) .
|
|
364
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
|
365
|
-
#
|
|
366
|
-
# ### Security Policies
|
|
367
|
-
#
|
|
368
|
-
# * 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.
|
|
369
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
370
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
371
|
-
# @param filingCalendarId [Integer] Specific filing calendar id for the request
|
|
372
|
-
# @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/).
|
|
373
|
-
# @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.
|
|
374
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
375
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
376
|
-
# @return [FetchResult]
|
|
377
|
-
def query_filing_requests(options={})
|
|
378
|
-
path = "/api/v2/filingrequests"
|
|
379
|
-
get(path, options)
|
|
380
|
-
end
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
# Retrieve all filing requests
|
|
384
|
-
#
|
|
385
|
-
# This API is available by invitation only.
|
|
386
|
-
#
|
|
387
|
-
# This API is intended to replace the GET `/api/v2/filingrequests` 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.
|
|
388
|
-
# The documentation of the GET API shows how filtering, sorting and pagination works.
|
|
389
|
-
#
|
|
390
|
-
# ### Security Policies
|
|
391
|
-
#
|
|
392
|
-
# * 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.
|
|
393
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
394
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
395
|
-
# @param filingCalendarId [Integer] Specific filing calendar id for the request
|
|
396
|
-
# @param model [Object] Query object to filter, sort and paginate the filing calendars.
|
|
397
|
-
# @return [FetchResult]
|
|
398
|
-
def query_filing_requests_post(model, options={})
|
|
399
|
-
path = "/api/v2/filingrequests/query"
|
|
400
|
-
post(path, model, options)
|
|
401
|
-
end
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
# Create a new filing request to edit a filing calendar
|
|
405
|
-
#
|
|
406
|
-
# This API is available by invitation only.
|
|
407
|
-
#
|
|
408
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
409
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
410
|
-
#
|
|
411
|
-
# Certain users may not update filing calendars directly. Instead, they may submit an edit request
|
|
412
|
-
# to modify the value of a filing calendar using this API.
|
|
413
|
-
#
|
|
414
|
-
# ### Security Policies
|
|
415
|
-
#
|
|
416
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
417
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
418
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
419
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
|
420
|
-
# @param id [Integer] The unique ID number of the filing calendar to edit
|
|
421
|
-
# @param model [FilingRequestModel[]] A list of filing calendar edits to be made
|
|
422
|
-
# @return [Object]
|
|
423
|
-
def request_filing_calendar_update(companyId, id, model)
|
|
424
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/request"
|
|
425
|
-
post(path, model)
|
|
426
|
-
end
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
# Edit existing Filing Calendar
|
|
430
|
-
#
|
|
431
|
-
# This API is available by invitation only.
|
|
432
|
-
#
|
|
433
|
-
# ### Security Policies
|
|
434
|
-
#
|
|
435
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
436
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
437
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
438
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
|
439
|
-
# @param id [Integer] The unique ID of the filing calendar object
|
|
440
|
-
# @param model [Object] The filing calendar model you are wishing to update with.
|
|
441
|
-
# @return [Object]
|
|
442
|
-
def update_filing_calendar(companyId, id, model)
|
|
443
|
-
path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
|
|
444
|
-
put(path, model)
|
|
445
|
-
end
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
# Edit existing Filing Request
|
|
449
|
-
#
|
|
450
|
-
# This API is available by invitation only.
|
|
451
|
-
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
|
452
|
-
# are reviewed and validated by Avalara Compliance before being implemented.
|
|
453
|
-
#
|
|
454
|
-
# ### Security Policies
|
|
455
|
-
#
|
|
456
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
457
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
|
458
|
-
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
|
459
|
-
# @param companyId [Integer] The unique ID of the company that owns the filing request object
|
|
460
|
-
# @param id [Integer] The unique ID of the filing request object
|
|
461
|
-
# @param model [Object] A list of filing calendar edits to be made
|
|
462
|
-
# @return [Object]
|
|
463
|
-
def update_filing_request(companyId, id, model)
|
|
464
|
-
path = "/api/v2/companies/#{companyId}/filingrequests/#{id}"
|
|
465
|
-
put(path, model)
|
|
466
|
-
end
|
|
467
|
-
|
|
468
27
|
end
|
|
469
28
|
end
|
|
470
29
|
end
|
data/lib/avatax/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: avatax
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 19.
|
|
4
|
+
version: 19.6.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Marcus Vorwaller
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2019-
|
|
11
|
+
date: 2019-06-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|