avatax 19.4.0 → 19.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f278d32009a90ac41c3c23927fda86722ecab67e4f17d520f582a2a2e13fbd75
4
- data.tar.gz: 1b9b0d495f4d3d5c9fa0ac8c179e190ff21ec3e08065e725f77db20c20cd7bc8
3
+ metadata.gz: 2512039042d82fe246845a50c231a866722d3edaaa96d706ddb998bd29a55652
4
+ data.tar.gz: c547e15c054c2c1333461de86bf875355a2d702fd9e41be5026cee56a65b26bc
5
5
  SHA512:
6
- metadata.gz: b59549e1462c8a29eb01bc8e0ca4fe373bf3d1f2f4a9ad24965277b10ee50a9c9cda026c6129541c94b421d5904926b376805eff5fe23bf5cb3b2f725b8bf934
7
- data.tar.gz: f921e4de25133cdddfad050c8ec27ad15ca63b320eb471edacbf5b967b8850904fb21c4d188ab0ee4fbd3b8a4edc67673a945ce41f875c1243f9c56ebf2da2a2
6
+ metadata.gz: 30c074e4a60b2d613061113480c879b7ea24539fe49771d24928342f512c8eacaa8bc977460e851ad47a3c600fea744750c2cbe08528db1943fb54add04d2e6b
7
+ data.tar.gz: 6dd71355cd5af75146284ef35c6cac6f3c6b4d2877f0a243967fdae06fe9448b2c7debc42c0583877697e5de6bb2d1af06ce88867f856ff49a5b0c3f1a5ec6c0
@@ -91,7 +91,7 @@ module AvaTax
91
91
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
92
92
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
93
93
  # @param companyId [Integer] The unique ID number of the company that issued this invitation
94
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
94
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
95
95
  # @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink
96
96
  # @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.
97
97
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -21,7 +21,7 @@ module AvaTax
21
21
  #
22
22
  # ### Security Policies
23
23
  #
24
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
24
+ # * 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.
25
25
  # @param id [Integer]
26
26
  # @param model [Object]
27
27
  # @return [String]
@@ -89,7 +89,7 @@ module AvaTax
89
89
  #
90
90
  # ### Security Policies
91
91
  #
92
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
92
+ # * 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.
93
93
  # @param id [Integer] The unique identifier of the company
94
94
  # @param model [Object] The funding initialization request
95
95
  # @return [Object]
@@ -125,7 +125,7 @@ module AvaTax
125
125
  #
126
126
  # * 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.
127
127
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
128
- # * 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.
128
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
129
129
  # @param companyId [Integer] The unique identifier of the company
130
130
  # @return [Object]
131
131
  def funding_configuration_by_company(companyId)
@@ -145,7 +145,7 @@ module AvaTax
145
145
  #
146
146
  # * 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.
147
147
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
148
- # * 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.
148
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
149
149
  # @param companyId [Integer] The unique identifier of the company
150
150
  # @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
151
151
  # @return [FundingConfigurationModel[]]
@@ -67,7 +67,6 @@ module AvaTax
67
67
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
68
68
  # @param companyId [Integer] The ID of the company that owns these contacts
69
69
  # @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/).
70
- # @param include [String] A comma separated list of additional data to retrieve.
71
70
  # @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.
72
71
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
73
72
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -91,7 +90,6 @@ module AvaTax
91
90
  #
92
91
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
93
92
  # @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/).
94
- # @param include [String] A comma separated list of additional data to retrieve.
95
93
  # @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.
96
94
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
97
95
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -3,308 +3,6 @@ module AvaTax
3
3
  module Filings
4
4
 
5
5
 
6
- # Approve all filings for the specified company in the given filing period.
7
- #
8
- # This API is available by invitation only.
9
- # Approving a return means the customer is ready to let Avalara file that return.
10
- # Customer either approves themselves from admin console,
11
- # else system auto-approves the night before the filing cycle.
12
- # Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
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
- # 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.
21
- # @param companyId [Integer] The ID of the company that owns the filings.
22
- # @param year [Integer] The year of the filing period to approve.
23
- # @param month [Integer] The month of the filing period to approve.
24
- # @param model [Object] The approve request you wish to execute.
25
- # @return [FilingModel[]]
26
- def approve_filings(companyId, year, month, model)
27
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/approve"
28
- post(path, model)
29
- end
30
-
31
-
32
- # Approve all filings for the specified company in the given filing period and country.
33
- #
34
- # This API is available by invitation only.
35
- # Approving a return means the customer is ready to let Avalara file that return.
36
- # Customer either approves themselves from admin console,
37
- # else system auto-approves the night before the filing cycle.
38
- # Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
39
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
47
- # @param companyId [Integer] The ID of the company that owns the filings.
48
- # @param year [Integer] The year of the filing period to approve.
49
- # @param month [Integer] The month of the filing period to approve.
50
- # @param country [String] The two-character ISO-3166 code for the country.
51
- # @param model [Object] The approve request you wish to execute.
52
- # @return [FilingModel[]]
53
- def approve_filings_country(companyId, year, month, country, model)
54
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/approve"
55
- post(path, model)
56
- end
57
-
58
-
59
- # Approve all filings for the specified company in the given filing period, country and region.
60
- #
61
- # This API is available by invitation only.
62
- # Approving a return means the customer is ready to let Avalara file that return.
63
- # Customer either approves themselves from admin console,
64
- # else system auto-approves the night before the filing cycle
65
- # Sometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.
66
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
74
- # @param companyId [Integer] The ID of the company that owns the filings.
75
- # @param year [Integer] The year of the filing period to approve.
76
- # @param month [Integer] The month of the filing period to approve.
77
- # @param country [String] The two-character ISO-3166 code for the country.
78
- # @param region [String] The two or three character region code for the region.
79
- # @param model [Object] The approve request you wish to execute.
80
- # @return [FilingModel[]]
81
- def approve_filings_country_region(companyId, year, month, country, region, model)
82
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/approve"
83
- post(path, model)
84
- end
85
-
86
-
87
- # Add an adjustment to a given filing.
88
- #
89
- # This API is available by invitation only.
90
- # An "Adjustment" is usually an increase or decrease to customer funding to Avalara,
91
- # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
92
- # Sometimes may be a manual change in tax liability similar to an augmentation.
93
- # This API creates a new adjustment for an existing tax filing.
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.
101
- # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
102
- # @param year [Integer] The year of the filing's filing period being adjusted.
103
- # @param month [Integer] The month of the filing's filing period being adjusted.
104
- # @param country [String] The two-character ISO-3166 code for the country of the filing being adjusted.
105
- # @param region [String] The two or three character region code for the region.
106
- # @param formCode [String] The unique code of the form being adjusted.
107
- # @param model [FilingAdjustmentModel[]] A list of Adjustments to be created for the specified filing.
108
- # @return [FilingAdjustmentModel[]]
109
- def create_return_adjustment(companyId, year, month, country, region, formCode, model)
110
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/adjust"
111
- post(path, model)
112
- end
113
-
114
-
115
- # Add an augmentation for a given filing.
116
- #
117
- # This API is available by invitation only.
118
- # An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara
119
- # usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
120
- # This API creates a new augmentation for an existing tax filing.
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.
128
- # @param companyId [Integer] The ID of the company that owns the filing being changed.
129
- # @param year [Integer] The month of the filing's filing period being changed.
130
- # @param month [Integer] The month of the filing's filing period being changed.
131
- # @param country [String] The two-character ISO-3166 code for the country of the filing being changed.
132
- # @param region [String] The two or three character region code for the region of the filing being changed.
133
- # @param formCode [String] The unique code of the form being changed.
134
- # @param model [FilingAugmentationModel[]] A list of augmentations to be created for the specified filing.
135
- # @return [FilingAugmentationModel[]]
136
- def create_return_augmentation(companyId, year, month, country, region, formCode, model)
137
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/augment"
138
- post(path, model)
139
- end
140
-
141
-
142
- # Add an payment to a given filing.
143
- #
144
- # This API is available by invitation only.
145
- # An "Payment" is usually an increase or decrease to customer funding to Avalara,
146
- # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
147
- # Sometimes may be a manual change in tax liability similar to an augmentation.
148
- # This API creates a new payment for an existing tax filing.
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.
156
- # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
157
- # @param year [Integer] The year of the filing's filing period being adjusted.
158
- # @param month [Integer] The month of the filing's filing period being adjusted.
159
- # @param country [String] The two-character ISO-3166 code for the country of the filing being adjusted.
160
- # @param region [String] The two or three character region code for the region.
161
- # @param formCode [String] The unique code of the form being adjusted.
162
- # @param model [FilingPaymentModel[]] A list of Payments to be created for the specified filing.
163
- # @return [FilingPaymentModel[]]
164
- def create_return_payment(companyId, year, month, country, region, formCode, model)
165
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/payment"
166
- post(path, model)
167
- end
168
-
169
-
170
- # Delete an adjustment for a given filing.
171
- #
172
- # This API is available by invitation only.
173
- # An "Adjustment" is usually an increase or decrease to customer funding to Avalara,
174
- # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
175
- # Sometimes may be a manual change in tax liability similar to an augmentation.
176
- # This API deletes an adjustment for an existing tax filing.
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.
184
- # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
185
- # @param id [Integer] The ID of the adjustment being deleted.
186
- # @return [ErrorDetail[]]
187
- def delete_return_adjustment(companyId, id)
188
- path = "/api/v2/companies/#{companyId}/filings/adjust/#{id}"
189
- delete(path)
190
- end
191
-
192
-
193
- # Delete an augmentation for a given filing.
194
- #
195
- # This API is available by invitation only.
196
- # An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara
197
- # usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
198
- # This API deletes an augmentation for an existing tax filing.
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.
206
- # @param companyId [Integer] The ID of the company that owns the filing being changed.
207
- # @param id [Integer] The ID of the augmentation being added.
208
- # @return [ErrorDetail[]]
209
- def delete_return_augmentation(companyId, id)
210
- path = "/api/v2/companies/#{companyId}/filings/augment/#{id}"
211
- delete(path)
212
- end
213
-
214
-
215
- # Delete an payment for a given filing.
216
- #
217
- # This API is available by invitation only.
218
- # An "Payment" is usually an increase or decrease to customer funding to Avalara,
219
- # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
220
- # Sometimes may be a manual change in tax liability similar to an augmentation.
221
- # This API deletes an payment for an existing tax filing.
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.
229
- # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
230
- # @param id [Integer] The ID of the payment being deleted.
231
- # @return [ErrorDetail[]]
232
- def delete_return_payment(companyId, id)
233
- path = "/api/v2/companies/#{companyId}/filings/payment/#{id}"
234
- delete(path)
235
- end
236
-
237
-
238
- # Retrieve worksheet checkup report for company and filing period.
239
- #
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.
247
- # @param filingsId [Integer] The unique id of the worksheet.
248
- # @param companyId [Integer] The unique ID of the company that owns the worksheet.
249
- # @return [Object]
250
- def filings_checkup_report(filingsId, companyId)
251
- path = "/api/v2/companies/#{companyId}/filings/#{filingsId}/checkup"
252
- get(path)
253
- end
254
-
255
-
256
- # Retrieve worksheet checkup report for company and filing period.
257
- #
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.
265
- # @param companyId [Integer] The unique ID of the company that owns the worksheets object.
266
- # @param year [Integer] The year of the filing period.
267
- # @param month [Integer] The month of the filing period.
268
- # @return [Object]
269
- def filings_checkup_reports(companyId, year, month)
270
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/checkup"
271
- get(path)
272
- end
273
-
274
-
275
- # Retrieve a list of filings for the specified accrual return.
276
- #
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.
280
- # @param companyId [Integer] The ID of the company that owns these batches
281
- # @param filingReturnId [Integer] The ID of the accrual return
282
- # @return [FetchResult]
283
- def get_accrual_fillings(companyId, filingReturnId)
284
- path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
285
- get(path)
286
- end
287
-
288
-
289
- # Retrieve a single attachment for a filing
290
- #
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.
298
- # @param companyId [Integer] The ID of the company that owns the filings.
299
- # @param filingReturnId [Integer] The unique id of the worksheet return.
300
- # @param fileId [Integer] The unique id of the document you are downloading
301
- # @return [Object]
302
- def get_filing_attachment(companyId, filingReturnId, options={})
303
- path = "/api/v2/companies/#{companyId}/filings/#{filingReturnId}/attachment"
304
- get(path, options)
305
- end
306
-
307
-
308
6
  # Retrieve a list of filings for the specified company in the year and month of a given filing period.
309
7
  #
310
8
  # This API is available by invitation only.
@@ -315,7 +13,7 @@ module AvaTax
315
13
  #
316
14
  # * 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
15
  # * 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.
16
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
319
17
  # @param companyId [Integer] The ID of the company that owns the filings.
320
18
  # @param year [Integer] The year of the filing period.
321
19
  # @param month [Integer] The two digit month of the filing period.
@@ -336,7 +34,7 @@ module AvaTax
336
34
  #
337
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.
338
36
  # * 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.
37
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
340
38
  # @param companyId [Integer] The ID of the company that owns the filings.
341
39
  # @param year [Integer] The year of the filing period.
342
40
  # @param month [Integer] The two digit month of the filing period.
@@ -346,313 +44,6 @@ module AvaTax
346
44
  get(path)
347
45
  end
348
46
 
349
-
350
- # Retrieve a filing for the specified company and id.
351
- #
352
- # This API is available by invitation only.
353
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
361
- # @param companyId [Integer] The ID of the company that owns the filings.
362
- # @param id [Integer] The id of the filing return your retrieving
363
- # @param details [Boolean] Indicates if you would like the credit details returned
364
- # @return [Object]
365
- def get_filing_return(companyId, id, options={})
366
- path = "/api/v2/companies/#{companyId}/filings/returns/#{id}"
367
- get(path, options)
368
- end
369
-
370
-
371
- # Retrieve a list of filings for the specified company in the year and month of a given filing period.
372
- #
373
- # This API is available by invitation only.
374
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
382
- # @param companyId [Integer] The ID of the company that owns the filings.
383
- # @param year [Integer] The year of the filing period.
384
- # @param month [Integer] The two digit month of the filing period.
385
- # @return [FetchResult]
386
- def get_filings(companyId, year, month)
387
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}"
388
- get(path)
389
- end
390
-
391
-
392
- # Retrieve a list of filings for the specified company in the given filing period and country.
393
- #
394
- # This API is available by invitation only.
395
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
403
- # @param companyId [Integer] The ID of the company that owns the filings.
404
- # @param year [Integer] The year of the filing period.
405
- # @param month [Integer] The two digit month of the filing period.
406
- # @param country [String] The two-character ISO-3166 code for the country.
407
- # @return [FetchResult]
408
- def get_filings_by_country(companyId, year, month, country)
409
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}"
410
- get(path)
411
- end
412
-
413
-
414
- # Retrieve a list of filings for the specified company in the filing period, country and region.
415
- #
416
- # This API is available by invitation only.
417
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
425
- # @param companyId [Integer] The ID of the company that owns the filings.
426
- # @param year [Integer] The year of the filing period.
427
- # @param month [Integer] The two digit month of the filing period.
428
- # @param country [String] The two-character ISO-3166 code for the country.
429
- # @param region [String] The two or three character region code for the region.
430
- # @return [FetchResult]
431
- def get_filings_by_country_region(companyId, year, month, country, region)
432
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}"
433
- get(path)
434
- end
435
-
436
-
437
- # Retrieve a list of filings for the specified company in the given filing period, country, region and form.
438
- #
439
- # This API is available by invitation only.
440
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
448
- # @param companyId [Integer] The ID of the company that owns the filings.
449
- # @param year [Integer] The year of the filing period.
450
- # @param month [Integer] The two digit month of the filing period.
451
- # @param country [String] The two-character ISO-3166 code for the country.
452
- # @param region [String] The two or three character region code for the region.
453
- # @param formCode [String] The unique code of the form.
454
- # @return [FetchResult]
455
- def get_filings_by_return_name(companyId, year, month, country, region, formCode)
456
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}"
457
- get(path)
458
- end
459
-
460
-
461
- # Retrieve a list of filings for the specified company in the year and month of a given filing period.
462
- # This gets the basic information from the filings and doesn't include anything extra.
463
- #
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.
469
- # @param companyId [Integer] The ID of the company that owns these batches
470
- # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
471
- # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
472
- # @param frequency [String] The frequency of the return you are trying to retrieve (See FilingFrequencyId::* for a list of allowable values)
473
- # @param status [String] The status of the return(s) you are trying to retrieve (See FilingStatusId::* for a list of allowable values)
474
- # @param country [String] The country of the return(s) you are trying to retrieve
475
- # @param region [String] The region of the return(s) you are trying to retrieve
476
- # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
477
- # @return [FetchResult]
478
- def get_filings_returns(companyId, options={})
479
- path = "/api/v2/companies/#{companyId}/filings/returns"
480
- get(path, options)
481
- end
482
-
483
-
484
- # Retrieve a list of filings for the specified company in the year and month of a given filing period.
485
- #
486
- # This API is available by invitation only.
487
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
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.
495
- # @param companyId [Integer] The ID of the company that owns the filings.
496
- # @param year [Integer] The year of the filing period.
497
- # @param month [Integer] The two digit month of the filing period.
498
- # @param country [String] The two-character ISO-3166 code for the country.
499
- # @param region [String] The two or three character region code for the region.
500
- # @param formCode [String] The unique code of the form.
501
- # @return [FetchResult]
502
- def get_tax_filings(companyId, options={})
503
- path = "/api/v2/companies/#{companyId}/filings"
504
- get(path, options)
505
- end
506
-
507
-
508
- # Rebuild a set of filings for the specified company in the given filing period.
509
- #
510
- # This API is available by invitation only.
511
- # Rebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing.
512
- # Rebuilding has to be done whenever a customer adds transactions to a filing.
513
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
514
- # based on filing frequency of filing.
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.
522
- # @param companyId [Integer] The ID of the company that owns the filings.
523
- # @param year [Integer] The year of the filing period to be rebuilt.
524
- # @param month [Integer] The month of the filing period to be rebuilt.
525
- # @param model [Object] The rebuild request you wish to execute.
526
- # @return [FetchResult]
527
- def rebuild_filings(companyId, year, month, model)
528
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/rebuild"
529
- post(path, model)
530
- end
531
-
532
-
533
- # Rebuild a set of filings for the specified company in the given filing period and country.
534
- #
535
- # This API is available by invitation only.
536
- # Rebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing.
537
- # Rebuilding has to be done whenever a customer adds transactions to a filing.
538
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
539
- # based on filing frequency of filing.
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.
547
- # @param companyId [Integer] The ID of the company that owns the filings.
548
- # @param year [Integer] The year of the filing period to be rebuilt.
549
- # @param month [Integer] The month of the filing period to be rebuilt.
550
- # @param country [String] The two-character ISO-3166 code for the country.
551
- # @param model [Object] The rebuild request you wish to execute.
552
- # @return [FetchResult]
553
- def rebuild_filings_by_country(companyId, year, month, country, model)
554
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/rebuild"
555
- post(path, model)
556
- end
557
-
558
-
559
- # Rebuild a set of filings for the specified company in the given filing period, country and region.
560
- #
561
- # This API is available by invitation only.audit.CheckAuthorizationReturns(null, companyId);
562
- # Rebuilding a return means re-creating or updating the amounts to be filed for a filing.
563
- # Rebuilding has to be done whenever a customer adds transactions to a filing.
564
- # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
565
- # based on filing frequency of filing.
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.
573
- # @param companyId [Integer] The ID of the company that owns the filings.
574
- # @param year [Integer] The year of the filing period to be rebuilt.
575
- # @param month [Integer] The month of the filing period to be rebuilt.
576
- # @param country [String] The two-character ISO-3166 code for the country.
577
- # @param region [String] The two or three character region code for the region.
578
- # @param model [Object] The rebuild request you wish to execute.
579
- # @return [FetchResult]
580
- def rebuild_filings_by_country_region(companyId, year, month, country, region, model)
581
- path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/rebuild"
582
- post(path, model)
583
- end
584
-
585
-
586
- # Edit an adjustment for a given filing.
587
- #
588
- # This API is available by invitation only.
589
- # An "Adjustment" is usually an increase or decrease to customer funding to Avalara,
590
- # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
591
- # Sometimes may be a manual change in tax liability similar to an augmentation.
592
- # This API modifies an adjustment for an existing tax filing.
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.
600
- # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
601
- # @param id [Integer] The ID of the adjustment being edited.
602
- # @param model [Object] The updated Adjustment.
603
- # @return [Object]
604
- def update_return_adjustment(companyId, id, model)
605
- path = "/api/v2/companies/#{companyId}/filings/adjust/#{id}"
606
- put(path, model)
607
- end
608
-
609
-
610
- # Edit an augmentation for a given filing.
611
- #
612
- # This API is available by invitation only.
613
- # An "Augmentation" is a manually added increase or decrease in tax liability, by either customer or Avalara
614
- # usually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.
615
- # This API modifies an augmentation for an existing tax filing.
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.
623
- # @param companyId [Integer] The ID of the company that owns the filing being changed.
624
- # @param id [Integer] The ID of the augmentation being edited.
625
- # @param model [Object] The updated Augmentation.
626
- # @return [Object]
627
- def update_return_augmentation(companyId, id, model)
628
- path = "/api/v2/companies/#{companyId}/filings/augment/#{id}"
629
- put(path, model)
630
- end
631
-
632
-
633
- # Edit an payment for a given filing.
634
- #
635
- # This API is available by invitation only.
636
- # An "Payment" is usually an increase or decrease to customer funding to Avalara,
637
- # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
638
- # Sometimes may be a manual change in tax liability similar to an augmentation.
639
- # This API modifies an payment for an existing tax filing.
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.
647
- # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
648
- # @param id [Integer] The ID of the payment being edited.
649
- # @param model [Object] The updated Payment.
650
- # @return [Object]
651
- def update_return_payment(companyId, id, model)
652
- path = "/api/v2/companies/#{companyId}/filings/payment/#{id}"
653
- put(path, model)
654
- end
655
-
656
47
  end
657
48
  end
658
49
  end
@@ -58,9 +58,9 @@ module AvaTax
58
58
  # @param line2 [String] The street address of the location.
59
59
  # @param line3 [String] The street address of the location.
60
60
  # @param city [String] The city name of the location.
61
- # @param region [String] Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
61
+ # @param region [String] Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
62
62
  # @param postalCode [String] The postal code of the location.
63
- # @param country [String] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
63
+ # @param country [String] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
64
64
  # @return [Object]
65
65
  def tax_rates_by_address(options={})
66
66
  path = "/api/v2/taxrates/byaddress"
@@ -97,7 +97,7 @@ module AvaTax
97
97
  #
98
98
  # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
99
99
  # for information on how to upgrade to the full AvaTax CreateTransaction API.
100
- # @param country [String] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
100
+ # @param country [String] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
101
101
  # @param postalCode [String] The postal code of the location.
102
102
  # @return [Object]
103
103
  def tax_rates_by_postal_code(options={})
@@ -14,7 +14,7 @@ module AvaTax
14
14
  #
15
15
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
16
16
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
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.
17
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
18
18
  # @param companyId [Integer] The ID of the company that owns this notice.
19
19
  # @param id [Integer] The ID of the tax notice we are adding the comment for.
20
20
  # @param model [NoticeCommentModel[]] The notice comments you wish to create.
@@ -37,7 +37,7 @@ module AvaTax
37
37
  #
38
38
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
39
39
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
40
- # * 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.
40
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
41
41
  # @param companyId [Integer] The ID of the company that owns this notice.
42
42
  # @param id [Integer] The ID of the notice added to the finance details.
43
43
  # @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
@@ -59,7 +59,7 @@ module AvaTax
59
59
  #
60
60
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
61
61
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
62
- # * 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.
62
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
63
63
  # @param companyId [Integer] The ID of the company that owns this notice.
64
64
  # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
65
65
  # @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
@@ -81,7 +81,7 @@ module AvaTax
81
81
  #
82
82
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
83
83
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
84
- # * 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.
84
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
85
85
  # @param companyId [Integer] The ID of the company that owns this notice.
86
86
  # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
87
87
  # @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
@@ -103,7 +103,7 @@ module AvaTax
103
103
  #
104
104
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
105
105
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
106
- # * 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
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
107
107
  # @param companyId [Integer] The ID of the company that owns this notice.
108
108
  # @param model [NoticeModel[]] The notice object you wish to create.
109
109
  # @return [NoticeModel[]]
@@ -124,7 +124,7 @@ module AvaTax
124
124
  #
125
125
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
126
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.
127
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
128
128
  # @param companyId [Integer] The ID of the company that owns this notice.
129
129
  # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
130
130
  # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
@@ -147,7 +147,7 @@ module AvaTax
147
147
  #
148
148
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
149
149
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
150
- # * 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.
150
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
151
151
  # @param companyId [Integer] The ID of the company that owns this notice.
152
152
  # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
153
153
  # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
@@ -169,7 +169,7 @@ module AvaTax
169
169
  #
170
170
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
171
171
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
172
- # * 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.
172
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
173
173
  # @param companyId [Integer] The ID of the company that owns this notice.
174
174
  # @param id [Integer] The ID of the notice you wish to delete.
175
175
  # @return [ErrorDetail[]]
@@ -190,7 +190,7 @@ module AvaTax
190
190
  #
191
191
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
192
192
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
193
- # * 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
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
194
194
  # @param companyId [Integer] The ID of the company that owns this notice.
195
195
  # @param noticeId [Integer] The ID of the notice you wish to delete.
196
196
  # @param id [Integer] The ID of the responsibility you wish to delete.
@@ -212,7 +212,7 @@ module AvaTax
212
212
  #
213
213
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
214
214
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
215
- # * 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.
215
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
216
216
  # @param companyId [Integer] The ID of the company that owns this notice.
217
217
  # @param noticeId [Integer] The ID of the notice you wish to delete.
218
218
  # @param id [Integer] The ID of the root cause you wish to delete.
@@ -232,7 +232,7 @@ module AvaTax
232
232
  #
233
233
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
234
234
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
235
- # * 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.
235
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
236
236
  # @param companyId [Integer] The ID of the company for this attachment.
237
237
  # @param id [Integer] The ResourceFileId of the attachment to download.
238
238
  # @return [Object]
@@ -253,7 +253,7 @@ module AvaTax
253
253
  #
254
254
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
255
255
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
256
- # * 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.
256
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
257
257
  # @param companyId [Integer] The ID of the company for this notice.
258
258
  # @param id [Integer] The ID of this notice.
259
259
  # @return [Object]
@@ -274,7 +274,7 @@ module AvaTax
274
274
  #
275
275
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
276
276
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
277
- # * 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.
277
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
278
278
  # @param id [Integer] The ID of the notice.
279
279
  # @param companyId [Integer] The ID of the company that owns these notices.
280
280
  # @return [FetchResult]
@@ -296,7 +296,7 @@ module AvaTax
296
296
  #
297
297
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
298
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.
299
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
300
300
  # @param id [Integer] The ID of the company that owns these notices.
301
301
  # @param companyId [Integer] The ID of the company that owns these notices.
302
302
  # @return [FetchResult]
@@ -317,7 +317,7 @@ module AvaTax
317
317
  #
318
318
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
319
319
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
320
- # * 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.
320
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
321
321
  # @param id [Integer] The ID of the notice.
322
322
  # @param companyId [Integer] The ID of the company that owns these notices.
323
323
  # @return [FetchResult]
@@ -338,7 +338,7 @@ module AvaTax
338
338
  #
339
339
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
340
340
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
341
- # * 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.
341
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
342
342
  # @param id [Integer] The ID of the notice.
343
343
  # @param companyId [Integer] The ID of the company that owns these notices.
344
344
  # @return [FetchResult]
@@ -362,7 +362,7 @@ module AvaTax
362
362
  #
363
363
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
364
364
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
365
- # * 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.
365
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
366
366
  # @param companyId [Integer] The ID of the company that owns these notices.
367
367
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
368
368
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -393,7 +393,7 @@ module AvaTax
393
393
  #
394
394
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
395
395
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
396
- # * 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.
396
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
397
397
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
398
398
  # @param include [String] A comma separated list of additional data to retrieve.
399
399
  # @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.
@@ -417,7 +417,7 @@ module AvaTax
417
417
  #
418
418
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
419
419
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
420
- # * 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.
420
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
421
421
  # @param model [Object] Query object to filter, sort and paginate the filing calendars.
422
422
  # @return [FetchResult]
423
423
  def query_notices_post(model)
@@ -436,7 +436,7 @@ module AvaTax
436
436
  #
437
437
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
438
438
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
439
- # * 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.
439
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
440
440
  # @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
441
441
  # @param noticeid [Integer] The ID of the notice finance detail you wish to update.
442
442
  # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
@@ -461,7 +461,7 @@ module AvaTax
461
461
  #
462
462
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
463
463
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
464
- # * 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.
464
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
465
465
  # @param companyId [Integer] The ID of the company that this notice belongs to.
466
466
  # @param id [Integer] The ID of the notice you wish to update.
467
467
  # @param model [Object] The notice object you wish to update.
@@ -482,7 +482,7 @@ module AvaTax
482
482
  #
483
483
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
484
484
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
485
- # * 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
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
486
486
  # @param companyId [Integer] The ID of the company that this notice comment belongs to.
487
487
  # @param noticeid [Integer] The ID of the notice you wish to update.
488
488
  # @param commentDetailsId [Integer] The ID of the comment you wish to update.
@@ -504,7 +504,7 @@ module AvaTax
504
504
  #
505
505
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
506
506
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
507
- # * 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.
507
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
508
508
  # @param companyId [Integer] The ID of the company for this attachment.
509
509
  # @param model [Object] The upload request.
510
510
  # @return [Object]
@@ -20,7 +20,7 @@ module AvaTax
20
20
  #
21
21
  # ### Security Policies
22
22
  #
23
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
23
+ # * 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.
24
24
  # @param id [Integer] The id of the notification you wish to mark as dismissed.
25
25
  # @return [Object]
26
26
  def dismiss_notification(id)
@@ -23,7 +23,7 @@ module AvaTax
23
23
  # ### Security Policies
24
24
  #
25
25
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
26
- # * 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 [Onboarding] for your servers.
26
+ # * This API is available by invitation only.
27
27
  # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount].
28
28
  # @param model [Object] Information about the account you wish to create and the selected product offerings.
29
29
  # @return [Object]
@@ -41,7 +41,7 @@ module AvaTax
41
41
  # ### Security Policies
42
42
  #
43
43
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
44
- # * 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 [Onboarding] for your servers.
44
+ # * This API is available by invitation only.
45
45
  # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount].
46
46
  # @param id [Integer] The avatax account id of the customer
47
47
  # @param offer [String] The offer to be added to an already existing customer
@@ -118,10 +118,14 @@ module AvaTax
118
118
  # ### Security Policies
119
119
  #
120
120
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
121
+ # @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:* reportType, parameters, createdUser, completedDate
122
+ # @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.
123
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
124
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
121
125
  # @return [FetchResult]
122
- def list_reports()
126
+ def list_reports(options={})
123
127
  path = "/api/v2/reports"
124
- get(path)
128
+ get(path, options)
125
129
  end
126
130
 
127
131
  end
@@ -0,0 +1 @@
1
+ This folder is for storing offline tax content.
@@ -0,0 +1 @@
1
+ This folder stores tax rates by ZIP code.
@@ -31,7 +31,7 @@ module AvaTax
31
31
  #
32
32
  # ### Security Policies
33
33
  #
34
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
34
+ # * 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.
35
35
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
36
36
  # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
37
37
  # @return [Object]
@@ -69,7 +69,7 @@ module AvaTax
69
69
  #
70
70
  # ### Security Policies
71
71
  #
72
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
72
+ # * 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.
73
73
  # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
74
74
  # @param companyId [Integer] The ID number of the company that owns this location.
75
75
  # @param id [Integer] The ID number of the location to retrieve point-of-sale data.
@@ -129,7 +129,7 @@ module AvaTax
129
129
  #
130
130
  # ### Security Policies
131
131
  #
132
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
132
+ # * 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.
133
133
  # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
134
134
  # @param region [String] If the region is provided, this API is going to generate the tax rate per zipcode for only the region specified.
135
135
  # @return [Object]
@@ -154,8 +154,9 @@ module AvaTax
154
154
  #
155
155
  # ### Security Policies
156
156
  #
157
+ # * This API requires the user role Compliance Root User.
157
158
  # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
158
- # * 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
+ # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
159
160
  # @param model [Object] bulk lock request
160
161
  # @return [Object]
161
162
  def bulk_lock_transaction(model)
@@ -661,6 +662,35 @@ module AvaTax
661
662
  end
662
663
 
663
664
 
665
+ # Unvoids a transaction
666
+ #
667
+ # Unvoids a voided transaction
668
+ #
669
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
670
+ #
671
+ # * Lines
672
+ # * Details (implies lines)
673
+ # * Summary (implies details)
674
+ # * Addresses
675
+ # * SummaryOnly (omit lines and details - reduces API response size)
676
+ # * LinesOnly (omit details - reduces API response size)
677
+ # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
678
+ #
679
+ # ### Security Policies
680
+ #
681
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
682
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
683
+ # @param companyCode [String] The company code of the company that recorded this transaction
684
+ # @param transactionCode [String] The transaction code to commit
685
+ # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
686
+ # @param include [String] Specifies objects to include in this fetch call
687
+ # @return [Object]
688
+ def unvoid_transaction(companyCode, transactionCode, options={})
689
+ path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
690
+ post(path, options)
691
+ end
692
+
693
+
664
694
  # Verify a transaction
665
695
  #
666
696
  # Verifies that the transaction uniquely identified by this URL matches certain expected values.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '19.4.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '19.5.0'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
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.0
4
+ version: 19.5.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-04-16 00:00:00.000000000 Z
11
+ date: 2019-05-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -164,6 +164,8 @@ files:
164
164
  - lib/avatax/client/reports.rb
165
165
  - lib/avatax/client/settings.rb
166
166
  - lib/avatax/client/subscriptions.rb
167
+ - lib/avatax/client/taxContent/README.txt
168
+ - lib/avatax/client/taxRatesByZip/README.txt
167
169
  - lib/avatax/client/taxcodes.rb
168
170
  - lib/avatax/client/taxcontent.rb
169
171
  - lib/avatax/client/taxprofiles.rb