avatax 19.3.0 → 19.4.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 +28 -0
- data/lib/avatax/client/addresses.rb +10 -0
- data/lib/avatax/client/avafileforms.rb +30 -0
- data/lib/avatax/client/batches.rb +24 -0
- data/lib/avatax/client/certexpressinvites.rb +15 -0
- data/lib/avatax/client/certificates.rb +76 -1
- data/lib/avatax/client/companies.rb +66 -2
- data/lib/avatax/client/contacts.rb +24 -0
- data/lib/avatax/client/customers.rb +50 -0
- data/lib/avatax/client/datasources.rb +30 -0
- data/lib/avatax/client/definitions.rb +28 -4
- data/lib/avatax/client/distancethresholds.rb +24 -0
- data/lib/avatax/client/filingcalendars.rb +132 -0
- data/lib/avatax/client/filings.rb +164 -2
- data/lib/avatax/client/free.rb +4 -0
- data/lib/avatax/client/fundingrequests.rb +12 -0
- data/lib/avatax/client/items.rb +64 -23
- data/lib/avatax/client/jurisdictionoverrides.rb +24 -0
- data/lib/avatax/client/locations.rb +28 -0
- data/lib/avatax/client/multidocument.rb +50 -0
- data/lib/avatax/client/nexus.rb +34 -21
- data/lib/avatax/client/notices.rb +141 -2
- data/lib/avatax/client/notifications.rb +12 -0
- data/lib/avatax/client/onboarding.rb +12 -0
- data/lib/avatax/client/registrar.rb +44 -1
- data/lib/avatax/client/reports.rb +16 -0
- data/lib/avatax/client/settings.rb +24 -0
- data/lib/avatax/client/subscriptions.rb +12 -0
- data/lib/avatax/client/taxcodes.rb +24 -0
- data/lib/avatax/client/taxcontent.rb +14 -15
- data/lib/avatax/client/taxrules.rb +24 -0
- data/lib/avatax/client/transactions.rb +187 -1
- data/lib/avatax/client/upcs.rb +30 -0
- data/lib/avatax/client/users.rb +44 -14
- data/lib/avatax/client/utilities.rb +4 -0
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
@@ -10,6 +10,10 @@ module AvaTax
|
|
10
10
|
# A company-distance-threshold model indicates the distance between a company
|
11
11
|
# and the taxing borders of various countries. Distance thresholds are necessary
|
12
12
|
# to correctly calculate some value-added taxes.
|
13
|
+
#
|
14
|
+
# ### Security Policies
|
15
|
+
#
|
16
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
13
17
|
# @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
|
14
18
|
# @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
|
15
19
|
# @return [CompanyDistanceThresholdModel[]]
|
@@ -26,6 +30,10 @@ module AvaTax
|
|
26
30
|
# A company-distance-threshold model indicates the distance between a company
|
27
31
|
# and the taxing borders of various countries. Distance thresholds are necessary
|
28
32
|
# to correctly calculate some value-added taxes.
|
33
|
+
#
|
34
|
+
# ### Security Policies
|
35
|
+
#
|
36
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
29
37
|
# @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
|
30
38
|
# @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
|
31
39
|
# @return [ErrorDetail[]]
|
@@ -42,6 +50,10 @@ module AvaTax
|
|
42
50
|
# A company-distance-threshold model indicates the distance between a company
|
43
51
|
# and the taxing borders of various countries. Distance thresholds are necessary
|
44
52
|
# to correctly calculate some value-added taxes.
|
53
|
+
#
|
54
|
+
# ### Security Policies
|
55
|
+
#
|
56
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
45
57
|
# @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
|
46
58
|
# @param id [Integer] The unique ID number referring to this DistanceThreshold object
|
47
59
|
# @return [Object]
|
@@ -58,6 +70,10 @@ module AvaTax
|
|
58
70
|
# A company-distance-threshold model indicates the distance between a company
|
59
71
|
# and the taxing borders of various countries. Distance thresholds are necessary
|
60
72
|
# to correctly calculate some value-added taxes.
|
73
|
+
#
|
74
|
+
# ### Security Policies
|
75
|
+
#
|
76
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
61
77
|
# @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
|
62
78
|
# @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/).
|
63
79
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -81,6 +97,10 @@ module AvaTax
|
|
81
97
|
#
|
82
98
|
# 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/) .
|
83
99
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
100
|
+
#
|
101
|
+
# ### Security Policies
|
102
|
+
#
|
103
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
84
104
|
# @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/).
|
85
105
|
# @param include [String] A comma separated list of additional data to retrieve.
|
86
106
|
# @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.
|
@@ -103,6 +123,10 @@ module AvaTax
|
|
103
123
|
#
|
104
124
|
# All data from the existing object will be replaced with data in the object you PUT.
|
105
125
|
# 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.
|
126
|
+
#
|
127
|
+
# ### Security Policies
|
128
|
+
#
|
129
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
106
130
|
# @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
|
107
131
|
# @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
|
108
132
|
# @param model [Object] The new DistanceThreshold object to store.
|
@@ -9,6 +9,12 @@ module AvaTax
|
|
9
9
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
10
10
|
# are reviewed and validated by Avalara Compliance before being implemented.
|
11
11
|
# The filing request must be in the "ChangeRequest" status to be approved.
|
12
|
+
#
|
13
|
+
# ### Security Policies
|
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.
|
12
18
|
# @param companyId [Integer] The unique ID of the company that owns the filing request object
|
13
19
|
# @param id [Integer] The unique ID of the filing request object
|
14
20
|
# @return [Object]
|
@@ -23,6 +29,12 @@ module AvaTax
|
|
23
29
|
# This API is available by invitation only.
|
24
30
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
25
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.
|
26
38
|
# @param companyId [Integer] The unique ID of the company that owns the filing request object
|
27
39
|
# @param id [Integer] The unique ID of the filing request object
|
28
40
|
# @return [Object]
|
@@ -38,6 +50,12 @@ module AvaTax
|
|
38
50
|
#
|
39
51
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
40
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.
|
41
59
|
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
42
60
|
# @param id [Integer] The unique ID number of the filing calendar to cancel
|
43
61
|
# @param model [FilingRequestModel[]] The cancellation request for this filing calendar
|
@@ -52,6 +70,12 @@ module AvaTax
|
|
52
70
|
#
|
53
71
|
# This API is available by invitation only and only available for users with Compliance access
|
54
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.
|
55
79
|
# @param companyId [Integer] The unique ID of the company that will add the new filing calendar
|
56
80
|
# @param model [FilingCalendarModel[]] Filing calendars that will be added
|
57
81
|
# @return [Object]
|
@@ -66,6 +90,12 @@ module AvaTax
|
|
66
90
|
# This API is available by invitation only.
|
67
91
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
68
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.
|
69
99
|
# @param companyId [Integer] The unique ID of the company that will add the new filing calendar
|
70
100
|
# @param model [FilingRequestModel[]] Information about the proposed new filing calendar
|
71
101
|
# @return [Object]
|
@@ -78,6 +108,12 @@ module AvaTax
|
|
78
108
|
# Returns a list of options for adding the specified form.
|
79
109
|
#
|
80
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.
|
81
117
|
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
82
118
|
# @param formCode [String] The unique code of the form
|
83
119
|
# @return [CycleAddOptionModel[]]
|
@@ -90,6 +126,12 @@ module AvaTax
|
|
90
126
|
# Indicates when changes are allowed to be made to a filing calendar.
|
91
127
|
#
|
92
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.
|
93
135
|
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
94
136
|
# @param id [Integer] The unique ID of the filing calendar object
|
95
137
|
# @param model [FilingCalendarEditModel[]] A list of filing calendar edits to be made
|
@@ -103,6 +145,12 @@ module AvaTax
|
|
103
145
|
# Returns a list of options for expiring a filing calendar
|
104
146
|
#
|
105
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.
|
106
154
|
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
107
155
|
# @param id [Integer] The unique ID of the filing calendar object
|
108
156
|
# @return [Object]
|
@@ -118,6 +166,12 @@ module AvaTax
|
|
118
166
|
# Mark the existing notice object at this URL as deleted.
|
119
167
|
# A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
|
120
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.
|
121
175
|
# @param companyId [Integer] The ID of the company that owns this filing calendar.
|
122
176
|
# @param id [Integer] The ID of the filing calendar you wish to delete.
|
123
177
|
# @return [ErrorDetail[]]
|
@@ -130,6 +184,12 @@ module AvaTax
|
|
130
184
|
# Retrieve a single filing calendar
|
131
185
|
#
|
132
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.
|
133
193
|
# @param companyId [Integer] The ID of the company that owns this filing calendar
|
134
194
|
# @param id [Integer] The primary key of this filing calendar
|
135
195
|
# @return [Object]
|
@@ -144,6 +204,12 @@ module AvaTax
|
|
144
204
|
# This API is available by invitation only.
|
145
205
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
146
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.
|
147
213
|
# @param companyId [Integer] The ID of the company that owns this filing calendar
|
148
214
|
# @param id [Integer] The primary key of this filing calendar
|
149
215
|
# @return [Object]
|
@@ -156,6 +222,12 @@ module AvaTax
|
|
156
222
|
# Retrieve all filing calendars for this company
|
157
223
|
#
|
158
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.
|
159
231
|
# @param companyId [Integer] The ID of the company that owns these batches
|
160
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
|
161
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.
|
@@ -175,6 +247,12 @@ module AvaTax
|
|
175
247
|
# This API is available by invitation only.
|
176
248
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
177
249
|
# are reviewed and validated by Avalara Compliance before being implemented.
|
250
|
+
#
|
251
|
+
# ### Security Policies
|
252
|
+
#
|
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.
|
254
|
+
# * 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. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
|
178
256
|
# @param companyId [Integer] The ID of the company that owns these batches
|
179
257
|
# @param filingCalendarId [Integer] Specific filing calendar id for the request
|
180
258
|
# @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/).
|
@@ -193,6 +271,12 @@ module AvaTax
|
|
193
271
|
# This API is available by invitation only.
|
194
272
|
#
|
195
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.
|
196
280
|
# @param model [Object] The model of the login information we are verifying
|
197
281
|
# @return [Object]
|
198
282
|
def login_verification_request(model)
|
@@ -207,6 +291,12 @@ module AvaTax
|
|
207
291
|
#
|
208
292
|
# This API checks the status of a login verification request. It may only be called by authorized users from the account
|
209
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.
|
210
300
|
# @param jobId [Integer] The unique ID number of this login request
|
211
301
|
# @return [Object]
|
212
302
|
def login_verification_status(jobId)
|
@@ -220,6 +310,12 @@ module AvaTax
|
|
220
310
|
# This API is available by invitation only.
|
221
311
|
#
|
222
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.
|
223
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
|
224
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.
|
225
321
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -239,6 +335,12 @@ module AvaTax
|
|
239
335
|
#
|
240
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.
|
241
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.
|
242
344
|
# @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
|
243
345
|
# @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
|
244
346
|
# @param model [Object] Query object to filter, sort and paginate the filing calendars.
|
@@ -260,6 +362,12 @@ module AvaTax
|
|
260
362
|
#
|
261
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/) .
|
262
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.
|
263
371
|
# @param filingCalendarId [Integer] Specific filing calendar id for the request
|
264
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/).
|
265
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.
|
@@ -278,6 +386,12 @@ module AvaTax
|
|
278
386
|
#
|
279
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.
|
280
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.
|
281
395
|
# @param filingCalendarId [Integer] Specific filing calendar id for the request
|
282
396
|
# @param model [Object] Query object to filter, sort and paginate the filing calendars.
|
283
397
|
# @return [FetchResult]
|
@@ -296,6 +410,12 @@ module AvaTax
|
|
296
410
|
#
|
297
411
|
# Certain users may not update filing calendars directly. Instead, they may submit an edit request
|
298
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.
|
299
419
|
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
300
420
|
# @param id [Integer] The unique ID number of the filing calendar to edit
|
301
421
|
# @param model [FilingRequestModel[]] A list of filing calendar edits to be made
|
@@ -309,6 +429,12 @@ module AvaTax
|
|
309
429
|
# Edit existing Filing Calendar
|
310
430
|
#
|
311
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.
|
312
438
|
# @param companyId [Integer] The unique ID of the company that owns the filing calendar object
|
313
439
|
# @param id [Integer] The unique ID of the filing calendar object
|
314
440
|
# @param model [Object] The filing calendar model you are wishing to update with.
|
@@ -324,6 +450,12 @@ module AvaTax
|
|
324
450
|
# This API is available by invitation only.
|
325
451
|
# A "filing request" represents a request to change an existing filing calendar. Filing requests
|
326
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.
|
327
459
|
# @param companyId [Integer] The unique ID of the company that owns the filing request object
|
328
460
|
# @param id [Integer] The unique ID of the filing request object
|
329
461
|
# @param model [Object] A list of filing calendar edits to be made
|
@@ -12,6 +12,12 @@ module AvaTax
|
|
12
12
|
# Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
|
13
13
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
14
14
|
# based on filing frequency of filing.
|
15
|
+
#
|
16
|
+
# ### Security Policies
|
17
|
+
#
|
18
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
19
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
20
|
+
# * 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.
|
15
21
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
16
22
|
# @param year [Integer] The year of the filing period to approve.
|
17
23
|
# @param month [Integer] The month of the filing period to approve.
|
@@ -32,6 +38,12 @@ module AvaTax
|
|
32
38
|
# Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
|
33
39
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
34
40
|
# based on filing frequency of filing.
|
41
|
+
#
|
42
|
+
# ### Security Policies
|
43
|
+
#
|
44
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
45
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
46
|
+
# * 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.
|
35
47
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
36
48
|
# @param year [Integer] The year of the filing period to approve.
|
37
49
|
# @param month [Integer] The month of the filing period to approve.
|
@@ -53,6 +65,12 @@ module AvaTax
|
|
53
65
|
# Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
|
54
66
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
55
67
|
# based on filing frequency of filing.
|
68
|
+
#
|
69
|
+
# ### Security Policies
|
70
|
+
#
|
71
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
72
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
73
|
+
# * 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.
|
56
74
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
57
75
|
# @param year [Integer] The year of the filing period to approve.
|
58
76
|
# @param month [Integer] The month of the filing period to approve.
|
@@ -74,6 +92,12 @@ module AvaTax
|
|
74
92
|
# Sometimes may be a manual change in tax liability similar to an augmentation.
|
75
93
|
# This API creates a new adjustment for an existing tax filing.
|
76
94
|
# This API can only be used when the filing has not yet been approved.
|
95
|
+
#
|
96
|
+
# ### Security Policies
|
97
|
+
#
|
98
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
99
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
100
|
+
# * 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.
|
77
101
|
# @param companyId [Integer] The ID of the company that owns the filing being adjusted.
|
78
102
|
# @param year [Integer] The year of the filing's filing period being adjusted.
|
79
103
|
# @param month [Integer] The month of the filing's filing period being adjusted.
|
@@ -95,6 +119,12 @@ module AvaTax
|
|
95
119
|
# usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
|
96
120
|
# This API creates a new augmentation for an existing tax filing.
|
97
121
|
# This API can only be used when the filing has not been approved.
|
122
|
+
#
|
123
|
+
# ### Security Policies
|
124
|
+
#
|
125
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
126
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
127
|
+
# * 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.
|
98
128
|
# @param companyId [Integer] The ID of the company that owns the filing being changed.
|
99
129
|
# @param year [Integer] The month of the filing's filing period being changed.
|
100
130
|
# @param month [Integer] The month of the filing's filing period being changed.
|
@@ -117,6 +147,12 @@ module AvaTax
|
|
117
147
|
# Sometimes may be a manual change in tax liability similar to an augmentation.
|
118
148
|
# This API creates a new payment for an existing tax filing.
|
119
149
|
# This API can only be used when the filing has not yet been approved.
|
150
|
+
#
|
151
|
+
# ### Security Policies
|
152
|
+
#
|
153
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
154
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
155
|
+
# * 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.
|
120
156
|
# @param companyId [Integer] The ID of the company that owns the filing being adjusted.
|
121
157
|
# @param year [Integer] The year of the filing's filing period being adjusted.
|
122
158
|
# @param month [Integer] The month of the filing's filing period being adjusted.
|
@@ -139,6 +175,12 @@ module AvaTax
|
|
139
175
|
# Sometimes may be a manual change in tax liability similar to an augmentation.
|
140
176
|
# This API deletes an adjustment for an existing tax filing.
|
141
177
|
# This API can only be used when the filing has been unapproved.
|
178
|
+
#
|
179
|
+
# ### Security Policies
|
180
|
+
#
|
181
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
182
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
183
|
+
# * 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.
|
142
184
|
# @param companyId [Integer] The ID of the company that owns the filing being adjusted.
|
143
185
|
# @param id [Integer] The ID of the adjustment being deleted.
|
144
186
|
# @return [ErrorDetail[]]
|
@@ -155,6 +197,12 @@ module AvaTax
|
|
155
197
|
# usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
|
156
198
|
# This API deletes an augmentation for an existing tax filing.
|
157
199
|
# This API can only be used when the filing has been unapproved.
|
200
|
+
#
|
201
|
+
# ### Security Policies
|
202
|
+
#
|
203
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
204
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
205
|
+
# * 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.
|
158
206
|
# @param companyId [Integer] The ID of the company that owns the filing being changed.
|
159
207
|
# @param id [Integer] The ID of the augmentation being added.
|
160
208
|
# @return [ErrorDetail[]]
|
@@ -172,6 +220,12 @@ module AvaTax
|
|
172
220
|
# Sometimes may be a manual change in tax liability similar to an augmentation.
|
173
221
|
# This API deletes an payment for an existing tax filing.
|
174
222
|
# This API can only be used when the filing has been unapproved.
|
223
|
+
#
|
224
|
+
# ### Security Policies
|
225
|
+
#
|
226
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
227
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
228
|
+
# * 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
229
|
# @param companyId [Integer] The ID of the company that owns the filing being adjusted.
|
176
230
|
# @param id [Integer] The ID of the payment being deleted.
|
177
231
|
# @return [ErrorDetail[]]
|
@@ -184,6 +238,12 @@ module AvaTax
|
|
184
238
|
# Retrieve worksheet checkup report for company and filing period.
|
185
239
|
#
|
186
240
|
# This API is available by invitation only.
|
241
|
+
#
|
242
|
+
# ### Security Policies
|
243
|
+
#
|
244
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
245
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
246
|
+
# * 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.
|
187
247
|
# @param filingsId [Integer] The unique id of the worksheet.
|
188
248
|
# @param companyId [Integer] The unique ID of the company that owns the worksheet.
|
189
249
|
# @return [Object]
|
@@ -196,6 +256,12 @@ module AvaTax
|
|
196
256
|
# Retrieve worksheet checkup report for company and filing period.
|
197
257
|
#
|
198
258
|
# This API is available by invitation only.
|
259
|
+
#
|
260
|
+
# ### Security Policies
|
261
|
+
#
|
262
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
263
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
264
|
+
# * 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.
|
199
265
|
# @param companyId [Integer] The unique ID of the company that owns the worksheets object.
|
200
266
|
# @param year [Integer] The year of the filing period.
|
201
267
|
# @param month [Integer] The month of the filing period.
|
@@ -208,7 +274,9 @@ module AvaTax
|
|
208
274
|
|
209
275
|
# Retrieve a list of filings for the specified accrual return.
|
210
276
|
#
|
211
|
-
#
|
277
|
+
# ### Security Policies
|
278
|
+
#
|
279
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
212
280
|
# @param companyId [Integer] The ID of the company that owns these batches
|
213
281
|
# @param filingReturnId [Integer] The ID of the accrual return
|
214
282
|
# @return [FetchResult]
|
@@ -221,6 +289,12 @@ module AvaTax
|
|
221
289
|
# Retrieve a single attachment for a filing
|
222
290
|
#
|
223
291
|
# This API is available by invitation only.
|
292
|
+
#
|
293
|
+
# ### Security Policies
|
294
|
+
#
|
295
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
296
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
297
|
+
# * 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.
|
224
298
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
225
299
|
# @param filingReturnId [Integer] The unique id of the worksheet return.
|
226
300
|
# @param fileId [Integer] The unique id of the document you are downloading
|
@@ -236,6 +310,12 @@ module AvaTax
|
|
236
310
|
# This API is available by invitation only.
|
237
311
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
238
312
|
# based on filing frequency of filing.
|
313
|
+
#
|
314
|
+
# ### Security Policies
|
315
|
+
#
|
316
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, 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.
|
239
319
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
240
320
|
# @param year [Integer] The year of the filing period.
|
241
321
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -251,6 +331,12 @@ module AvaTax
|
|
251
331
|
# This API is available by invitation only.
|
252
332
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
253
333
|
# based on filing frequency of filing.
|
334
|
+
#
|
335
|
+
# ### Security Policies
|
336
|
+
#
|
337
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
338
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
339
|
+
# * 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.
|
254
340
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
255
341
|
# @param year [Integer] The year of the filing period.
|
256
342
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -266,6 +352,12 @@ module AvaTax
|
|
266
352
|
# This API is available by invitation only.
|
267
353
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
268
354
|
# based on filing frequency of filing.
|
355
|
+
#
|
356
|
+
# ### Security Policies
|
357
|
+
#
|
358
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
359
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
360
|
+
# * 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.
|
269
361
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
270
362
|
# @param id [Integer] The id of the filing return your retrieving
|
271
363
|
# @param details [Boolean] Indicates if you would like the credit details returned
|
@@ -281,6 +373,12 @@ module AvaTax
|
|
281
373
|
# This API is available by invitation only.
|
282
374
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
283
375
|
# based on filing frequency of filing.
|
376
|
+
#
|
377
|
+
# ### Security Policies
|
378
|
+
#
|
379
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
380
|
+
# * 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.
|
381
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
284
382
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
285
383
|
# @param year [Integer] The year of the filing period.
|
286
384
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -296,6 +394,12 @@ module AvaTax
|
|
296
394
|
# This API is available by invitation only.
|
297
395
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
298
396
|
# based on filing frequency of filing.
|
397
|
+
#
|
398
|
+
# ### Security Policies
|
399
|
+
#
|
400
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
401
|
+
# * 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.
|
402
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
299
403
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
300
404
|
# @param year [Integer] The year of the filing period.
|
301
405
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -312,6 +416,12 @@ module AvaTax
|
|
312
416
|
# This API is available by invitation only.
|
313
417
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
314
418
|
# based on filing frequency of filing.
|
419
|
+
#
|
420
|
+
# ### Security Policies
|
421
|
+
#
|
422
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
423
|
+
# * 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.
|
424
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
315
425
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
316
426
|
# @param year [Integer] The year of the filing period.
|
317
427
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -329,6 +439,12 @@ module AvaTax
|
|
329
439
|
# This API is available by invitation only.
|
330
440
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
331
441
|
# based on filing frequency of filing.
|
442
|
+
#
|
443
|
+
# ### Security Policies
|
444
|
+
#
|
445
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
446
|
+
# * 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.
|
447
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
332
448
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
333
449
|
# @param year [Integer] The year of the filing period.
|
334
450
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -345,7 +461,11 @@ module AvaTax
|
|
345
461
|
# Retrieve a list of filings for the specified company in the year and month of a given filing period.
|
346
462
|
# This gets the basic information from the filings and doesn't include anything extra.
|
347
463
|
#
|
348
|
-
#
|
464
|
+
# ### Security Policies
|
465
|
+
#
|
466
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
467
|
+
# * 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.
|
468
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
349
469
|
# @param companyId [Integer] The ID of the company that owns these batches
|
350
470
|
# @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
|
351
471
|
# @param endPeriodYear [Integer] The year of the period you are trying to retrieve
|
@@ -366,6 +486,12 @@ module AvaTax
|
|
366
486
|
# This API is available by invitation only.
|
367
487
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
368
488
|
# based on filing frequency of filing.
|
489
|
+
#
|
490
|
+
# ### Security Policies
|
491
|
+
#
|
492
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
493
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
494
|
+
# * 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.
|
369
495
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
370
496
|
# @param year [Integer] The year of the filing period.
|
371
497
|
# @param month [Integer] The two digit month of the filing period.
|
@@ -387,6 +513,12 @@ module AvaTax
|
|
387
513
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
388
514
|
# based on filing frequency of filing.
|
389
515
|
# This API requires filing to be unapproved.
|
516
|
+
#
|
517
|
+
# ### Security Policies
|
518
|
+
#
|
519
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
520
|
+
# * 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.
|
521
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
390
522
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
391
523
|
# @param year [Integer] The year of the filing period to be rebuilt.
|
392
524
|
# @param month [Integer] The month of the filing period to be rebuilt.
|
@@ -406,6 +538,12 @@ module AvaTax
|
|
406
538
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
407
539
|
# based on filing frequency of filing.
|
408
540
|
# This API requires filing to be unapproved.
|
541
|
+
#
|
542
|
+
# ### Security Policies
|
543
|
+
#
|
544
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
545
|
+
# * 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.
|
546
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
409
547
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
410
548
|
# @param year [Integer] The year of the filing period to be rebuilt.
|
411
549
|
# @param month [Integer] The month of the filing period to be rebuilt.
|
@@ -426,6 +564,12 @@ module AvaTax
|
|
426
564
|
# A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
|
427
565
|
# based on filing frequency of filing.
|
428
566
|
# This API requires filing to be unapproved.
|
567
|
+
#
|
568
|
+
# ### Security Policies
|
569
|
+
#
|
570
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
571
|
+
# * 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.
|
572
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
429
573
|
# @param companyId [Integer] The ID of the company that owns the filings.
|
430
574
|
# @param year [Integer] The year of the filing period to be rebuilt.
|
431
575
|
# @param month [Integer] The month of the filing period to be rebuilt.
|
@@ -447,6 +591,12 @@ module AvaTax
|
|
447
591
|
# Sometimes may be a manual change in tax liability similar to an augmentation.
|
448
592
|
# This API modifies an adjustment for an existing tax filing.
|
449
593
|
# This API can only be used when the filing has not yet been approved.
|
594
|
+
#
|
595
|
+
# ### Security Policies
|
596
|
+
#
|
597
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
598
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
599
|
+
# * 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.
|
450
600
|
# @param companyId [Integer] The ID of the company that owns the filing being adjusted.
|
451
601
|
# @param id [Integer] The ID of the adjustment being edited.
|
452
602
|
# @param model [Object] The updated Adjustment.
|
@@ -464,6 +614,12 @@ module AvaTax
|
|
464
614
|
# usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
|
465
615
|
# This API modifies an augmentation for an existing tax filing.
|
466
616
|
# This API can only be used when the filing has not been approved.
|
617
|
+
#
|
618
|
+
# ### Security Policies
|
619
|
+
#
|
620
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
621
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
622
|
+
# * 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.
|
467
623
|
# @param companyId [Integer] The ID of the company that owns the filing being changed.
|
468
624
|
# @param id [Integer] The ID of the augmentation being edited.
|
469
625
|
# @param model [Object] The updated Augmentation.
|
@@ -482,6 +638,12 @@ module AvaTax
|
|
482
638
|
# Sometimes may be a manual change in tax liability similar to an augmentation.
|
483
639
|
# This API modifies an payment for an existing tax filing.
|
484
640
|
# This API can only be used when the filing has not yet been approved.
|
641
|
+
#
|
642
|
+
# ### Security Policies
|
643
|
+
#
|
644
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, CSPTester, FirmUser, SSTAdmin, TechnicalSupportAdmin.
|
645
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
646
|
+
# * 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.
|
485
647
|
# @param companyId [Integer] The ID of the company that owns the filing being adjusted.
|
486
648
|
# @param id [Integer] The ID of the payment being edited.
|
487
649
|
# @param model [Object] The updated Payment.
|