avatax 19.3.0 → 19.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +28 -0
- data/lib/avatax/client/addresses.rb +10 -0
- data/lib/avatax/client/avafileforms.rb +30 -0
- data/lib/avatax/client/batches.rb +24 -0
- data/lib/avatax/client/certexpressinvites.rb +15 -0
- data/lib/avatax/client/certificates.rb +76 -1
- data/lib/avatax/client/companies.rb +66 -2
- data/lib/avatax/client/contacts.rb +24 -0
- data/lib/avatax/client/customers.rb +50 -0
- data/lib/avatax/client/datasources.rb +30 -0
- data/lib/avatax/client/definitions.rb +28 -4
- data/lib/avatax/client/distancethresholds.rb +24 -0
- data/lib/avatax/client/filingcalendars.rb +132 -0
- data/lib/avatax/client/filings.rb +164 -2
- data/lib/avatax/client/free.rb +4 -0
- data/lib/avatax/client/fundingrequests.rb +12 -0
- data/lib/avatax/client/items.rb +64 -23
- data/lib/avatax/client/jurisdictionoverrides.rb +24 -0
- data/lib/avatax/client/locations.rb +28 -0
- data/lib/avatax/client/multidocument.rb +50 -0
- data/lib/avatax/client/nexus.rb +34 -21
- data/lib/avatax/client/notices.rb +141 -2
- data/lib/avatax/client/notifications.rb +12 -0
- data/lib/avatax/client/onboarding.rb +12 -0
- data/lib/avatax/client/registrar.rb +44 -1
- data/lib/avatax/client/reports.rb +16 -0
- data/lib/avatax/client/settings.rb +24 -0
- data/lib/avatax/client/subscriptions.rb +12 -0
- data/lib/avatax/client/taxcodes.rb +24 -0
- data/lib/avatax/client/taxcontent.rb +14 -15
- data/lib/avatax/client/taxrules.rb +24 -0
- data/lib/avatax/client/transactions.rb +187 -1
- data/lib/avatax/client/upcs.rb +30 -0
- data/lib/avatax/client/users.rb +44 -14
- data/lib/avatax/client/utilities.rb +4 -0
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
data/lib/avatax/client/free.rb
CHANGED
@@ -15,6 +15,10 @@ module AvaTax
|
|
15
15
|
# available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/).
|
16
16
|
#
|
17
17
|
# After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/).
|
18
|
+
#
|
19
|
+
# ### Security Policies
|
20
|
+
#
|
21
|
+
# * This API may be called without providing authentication credentials.
|
18
22
|
# @param model [Object] Required information to provision a free trial account.
|
19
23
|
# @return [Object]
|
20
24
|
def request_free_trial(model)
|
@@ -17,6 +17,12 @@ module AvaTax
|
|
17
17
|
# JavaScript funding setup widget inline.
|
18
18
|
# Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page.
|
19
19
|
# This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
20
|
+
#
|
21
|
+
# ### Security Policies
|
22
|
+
#
|
23
|
+
# * 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.
|
24
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
25
|
+
# * 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.
|
20
26
|
# @param id [Integer] The unique ID number of this funding request
|
21
27
|
# @return [Object]
|
22
28
|
def activate_funding_request(id)
|
@@ -37,6 +43,12 @@ module AvaTax
|
|
37
43
|
# before approval.
|
38
44
|
# This API checks the status on an existing funding request.
|
39
45
|
# This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
46
|
+
#
|
47
|
+
# ### Security Policies
|
48
|
+
#
|
49
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
50
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
51
|
+
# * 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
52
|
# @param id [Integer] The unique ID number of this funding request
|
41
53
|
# @return [Object]
|
42
54
|
def funding_request_status(id)
|
data/lib/avatax/client/items.rb
CHANGED
@@ -12,6 +12,10 @@ module AvaTax
|
|
12
12
|
# When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
|
13
13
|
#
|
14
14
|
# An item may only have one classification per tax system.
|
15
|
+
#
|
16
|
+
# ### Security Policies
|
17
|
+
#
|
18
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
15
19
|
# @param companyId [Integer] The company id.
|
16
20
|
# @param itemId [Integer] The item id.
|
17
21
|
# @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
|
@@ -35,6 +39,10 @@ module AvaTax
|
|
35
39
|
# To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product`
|
36
40
|
#
|
37
41
|
# Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
|
42
|
+
#
|
43
|
+
# ### Security Policies
|
44
|
+
#
|
45
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
38
46
|
# @param companyId [Integer] The ID of the company that owns this item parameter.
|
39
47
|
# @param itemId [Integer] The item id.
|
40
48
|
# @param model [ItemParameterModel[]] The item parameters you wish to create.
|
@@ -56,6 +64,10 @@ module AvaTax
|
|
56
64
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
57
65
|
#
|
58
66
|
# The tax code takes precedence over the tax code id if both are provided.
|
67
|
+
#
|
68
|
+
# ### Security Policies
|
69
|
+
#
|
70
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
59
71
|
# @param companyId [Integer] The ID of the company that owns this item.
|
60
72
|
# @param model [ItemModel[]] The item you wish to create.
|
61
73
|
# @return [ItemModel[]]
|
@@ -76,6 +88,10 @@ module AvaTax
|
|
76
88
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
77
89
|
#
|
78
90
|
# Deleting an item will also delete the parameters and classifications associated with that item.
|
91
|
+
#
|
92
|
+
# ### Security Policies
|
93
|
+
#
|
94
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
79
95
|
# @param companyId [Integer] The ID of the company that owns this item.
|
80
96
|
# @param id [Integer] The ID of the item you wish to delete.
|
81
97
|
# @return [ErrorDetail[]]
|
@@ -92,6 +108,10 @@ module AvaTax
|
|
92
108
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
93
109
|
#
|
94
110
|
# When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
|
111
|
+
#
|
112
|
+
# ### Security Policies
|
113
|
+
#
|
114
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
95
115
|
# @param companyId [Integer] The company id.
|
96
116
|
# @param itemId [Integer] The item id.
|
97
117
|
# @param id [Integer] The item classification id.
|
@@ -111,6 +131,10 @@ module AvaTax
|
|
111
131
|
# A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
|
112
132
|
#
|
113
133
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
134
|
+
#
|
135
|
+
# ### Security Policies
|
136
|
+
#
|
137
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
114
138
|
# @param companyId [Integer] The company id
|
115
139
|
# @param itemId [Integer] The item id
|
116
140
|
# @param id [Integer] The parameter id
|
@@ -130,6 +154,10 @@ module AvaTax
|
|
130
154
|
# and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
|
131
155
|
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
132
156
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
157
|
+
#
|
158
|
+
# ### Security Policies
|
159
|
+
#
|
160
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
133
161
|
# @param companyId [Integer] The ID of the company that owns this item object
|
134
162
|
# @param id [Integer] The primary key of this item
|
135
163
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -147,6 +175,10 @@ module AvaTax
|
|
147
175
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
148
176
|
#
|
149
177
|
# When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
|
178
|
+
#
|
179
|
+
# ### Security Policies
|
180
|
+
#
|
181
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
150
182
|
# @param companyId [Integer] The company id.
|
151
183
|
# @param itemId [Integer] The item id.
|
152
184
|
# @param id [Integer] The item classification id.
|
@@ -166,6 +198,10 @@ module AvaTax
|
|
166
198
|
# A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
|
167
199
|
#
|
168
200
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
201
|
+
#
|
202
|
+
# ### Security Policies
|
203
|
+
#
|
204
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
169
205
|
# @param companyId [Integer] The company id
|
170
206
|
# @param itemId [Integer] The item id
|
171
207
|
# @param id [Integer] The parameter id
|
@@ -186,6 +222,10 @@ module AvaTax
|
|
186
222
|
#
|
187
223
|
# Search for specific objects using the criteria in the `$filter` classification; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
188
224
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` classifications.
|
225
|
+
#
|
226
|
+
# ### Security Policies
|
227
|
+
#
|
228
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
189
229
|
# @param companyId [Integer] The company id.
|
190
230
|
# @param itemId [Integer] The item id.
|
191
231
|
# @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:* productCode, systemCode
|
@@ -211,6 +251,10 @@ module AvaTax
|
|
211
251
|
#
|
212
252
|
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
213
253
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
254
|
+
#
|
255
|
+
# ### Security Policies
|
256
|
+
#
|
257
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
214
258
|
# @param companyId [Integer] The company id
|
215
259
|
# @param itemId [Integer] The item id
|
216
260
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* name, unit
|
@@ -242,6 +286,10 @@ module AvaTax
|
|
242
286
|
#
|
243
287
|
# * Parameters
|
244
288
|
# * Classifications
|
289
|
+
#
|
290
|
+
# ### Security Policies
|
291
|
+
#
|
292
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
245
293
|
# @param companyId [Integer] The ID of the company that defined these items
|
246
294
|
# @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:* taxCode, classifications, parameters
|
247
295
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -268,6 +316,10 @@ module AvaTax
|
|
268
316
|
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
269
317
|
#
|
270
318
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
319
|
+
#
|
320
|
+
# ### Security Policies
|
321
|
+
#
|
322
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
271
323
|
# @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:* taxCode, classifications, parameters
|
272
324
|
# @param include [String] A comma separated list of additional data to retrieve.
|
273
325
|
# @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.
|
@@ -280,29 +332,6 @@ module AvaTax
|
|
280
332
|
end
|
281
333
|
|
282
334
|
|
283
|
-
# Sync items from a product catalog
|
284
|
-
#
|
285
|
-
# Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs
|
286
|
-
# with AvaTax.
|
287
|
-
#
|
288
|
-
# Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information.
|
289
|
-
#
|
290
|
-
# This API is currently limited to 1000 items per call (the limit is subject to change).
|
291
|
-
#
|
292
|
-
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
293
|
-
# can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
|
294
|
-
# and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
|
295
|
-
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
296
|
-
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
297
|
-
# @param companyId [Integer] The ID of the company that owns this item.
|
298
|
-
# @param model [Object] The request object.
|
299
|
-
# @return [Object]
|
300
|
-
def sync_items(companyId, model)
|
301
|
-
path = "/api/v2/companies/#{companyId}/items/sync"
|
302
|
-
post(path, model)
|
303
|
-
end
|
304
|
-
|
305
|
-
|
306
335
|
# Update a single item
|
307
336
|
#
|
308
337
|
# Replace the existing `Item` object at this URL with an updated object.
|
@@ -317,6 +346,10 @@ module AvaTax
|
|
317
346
|
# you may either set its value to null or omit that field from the object you post.
|
318
347
|
#
|
319
348
|
# The tax code takes precedence over the tax code id if both are provided.
|
349
|
+
#
|
350
|
+
# ### Security Policies
|
351
|
+
#
|
352
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
320
353
|
# @param companyId [Integer] The ID of the company that this item belongs to.
|
321
354
|
# @param id [Integer] The ID of the item you wish to update
|
322
355
|
# @param model [Object] The item object you wish to update.
|
@@ -336,6 +369,10 @@ module AvaTax
|
|
336
369
|
# When an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
|
337
370
|
#
|
338
371
|
# An item may only have one classification per tax system.
|
372
|
+
#
|
373
|
+
# ### Security Policies
|
374
|
+
#
|
375
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
339
376
|
# @param companyId [Integer] The company id.
|
340
377
|
# @param itemId [Integer] The item id.
|
341
378
|
# @param id [Integer] The item classification id.
|
@@ -356,6 +393,10 @@ module AvaTax
|
|
356
393
|
# A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
|
357
394
|
#
|
358
395
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
396
|
+
#
|
397
|
+
# ### Security Policies
|
398
|
+
#
|
399
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
359
400
|
# @param companyId [Integer] The company id.
|
360
401
|
# @param itemId [Integer] The item id
|
361
402
|
# @param id [Integer] The item parameter id
|
@@ -11,6 +11,10 @@ module AvaTax
|
|
11
11
|
# jurisdiction for a specific address. If you encounter an address that is on the boundary
|
12
12
|
# between two different jurisdictions, you can choose to set up a jurisdiction override
|
13
13
|
# to switch this address to use different taxing jurisdictions.
|
14
|
+
#
|
15
|
+
# ### Security Policies
|
16
|
+
#
|
17
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
14
18
|
# @param accountId [Integer] The ID of the account that owns this override
|
15
19
|
# @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
|
16
20
|
# @return [JurisdictionOverrideModel[]]
|
@@ -23,6 +27,10 @@ module AvaTax
|
|
23
27
|
# Delete a single override
|
24
28
|
#
|
25
29
|
# Marks the item object at this URL as deleted.
|
30
|
+
#
|
31
|
+
# ### Security Policies
|
32
|
+
#
|
33
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
26
34
|
# @param accountId [Integer] The ID of the account that owns this override
|
27
35
|
# @param id [Integer] The ID of the override you wish to delete
|
28
36
|
# @return [ErrorDetail[]]
|
@@ -40,6 +48,10 @@ module AvaTax
|
|
40
48
|
# jurisdiction for a specific address. If you encounter an address that is on the boundary
|
41
49
|
# between two different jurisdictions, you can choose to set up a jurisdiction override
|
42
50
|
# to switch this address to use different taxing jurisdictions.
|
51
|
+
#
|
52
|
+
# ### Security Policies
|
53
|
+
#
|
54
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
43
55
|
# @param accountId [Integer] The ID of the account that owns this override
|
44
56
|
# @param id [Integer] The primary key of this override
|
45
57
|
# @return [Object]
|
@@ -60,6 +72,10 @@ module AvaTax
|
|
60
72
|
#
|
61
73
|
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
62
74
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
75
|
+
#
|
76
|
+
# ### Security Policies
|
77
|
+
#
|
78
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
63
79
|
# @param accountId [Integer] The ID of the account that owns this override
|
64
80
|
# @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:* country, Jurisdictions
|
65
81
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -84,6 +100,10 @@ module AvaTax
|
|
84
100
|
#
|
85
101
|
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
86
102
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
103
|
+
#
|
104
|
+
# ### Security Policies
|
105
|
+
#
|
106
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
87
107
|
# @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:* country, Jurisdictions
|
88
108
|
# @param include [String] A comma separated list of additional data to retrieve.
|
89
109
|
# @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.
|
@@ -99,6 +119,10 @@ module AvaTax
|
|
99
119
|
# Update a single jurisdictionoverride
|
100
120
|
#
|
101
121
|
# Replace the existing jurisdictionoverride object at this URL with an updated object.
|
122
|
+
#
|
123
|
+
# ### Security Policies
|
124
|
+
#
|
125
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
102
126
|
# @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
|
103
127
|
# @param id [Integer] The ID of the jurisdictionoverride you wish to update
|
104
128
|
# @param model [Object] The jurisdictionoverride object you wish to update.
|
@@ -6,6 +6,10 @@ module AvaTax
|
|
6
6
|
# Create a new location
|
7
7
|
#
|
8
8
|
# Create one or more new location objects attached to this company.
|
9
|
+
#
|
10
|
+
# ### Security Policies
|
11
|
+
#
|
12
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
9
13
|
# @param companyId [Integer] The ID of the company that owns this location.
|
10
14
|
# @param model [LocationModel[]] The location you wish to create.
|
11
15
|
# @return [LocationModel[]]
|
@@ -18,6 +22,10 @@ module AvaTax
|
|
18
22
|
# Delete a single location
|
19
23
|
#
|
20
24
|
# Mark the location object at this URL as deleted.
|
25
|
+
#
|
26
|
+
# ### Security Policies
|
27
|
+
#
|
28
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
21
29
|
# @param companyId [Integer] The ID of the company that owns this location.
|
22
30
|
# @param id [Integer] The ID of the location you wish to delete.
|
23
31
|
# @return [ErrorDetail[]]
|
@@ -38,6 +46,10 @@ module AvaTax
|
|
38
46
|
# 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:
|
39
47
|
#
|
40
48
|
# * LocationSettings
|
49
|
+
#
|
50
|
+
# ### Security Policies
|
51
|
+
#
|
52
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
41
53
|
# @param companyId [Integer] The ID of the company that owns this location
|
42
54
|
# @param id [Integer] The primary key of this location
|
43
55
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
@@ -61,6 +73,10 @@ module AvaTax
|
|
61
73
|
# 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:
|
62
74
|
#
|
63
75
|
# * LocationSettings
|
76
|
+
#
|
77
|
+
# ### Security Policies
|
78
|
+
#
|
79
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
64
80
|
# @param companyId [Integer] The ID of the company that owns these locations
|
65
81
|
# @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:* settings
|
66
82
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
@@ -88,6 +104,10 @@ module AvaTax
|
|
88
104
|
# 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:
|
89
105
|
#
|
90
106
|
# * LocationSettings
|
107
|
+
#
|
108
|
+
# ### Security Policies
|
109
|
+
#
|
110
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
91
111
|
# @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:* settings
|
92
112
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
93
113
|
# @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.
|
@@ -105,6 +125,10 @@ module AvaTax
|
|
105
125
|
# Replace the existing location object at this URL with an updated object.
|
106
126
|
# All data from the existing object will be replaced with data in the object you PUT.
|
107
127
|
# To set a field's value to null, you may either set its value to null or omit that field from the object you post.
|
128
|
+
#
|
129
|
+
# ### Security Policies
|
130
|
+
#
|
131
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
108
132
|
# @param companyId [Integer] The ID of the company that this location belongs to.
|
109
133
|
# @param id [Integer] The ID of the location you wish to update
|
110
134
|
# @param model [Object] The location you wish to update.
|
@@ -120,6 +144,10 @@ module AvaTax
|
|
120
144
|
# Returns validation information for this location.
|
121
145
|
# This API call is intended to compare this location against the currently known taxing authority rules and regulations,
|
122
146
|
# and provide information about what additional work is required to completely setup this location.
|
147
|
+
#
|
148
|
+
# ### Security Policies
|
149
|
+
#
|
150
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
123
151
|
# @param companyId [Integer] The ID of the company that owns this location
|
124
152
|
# @param id [Integer] The primary key of this location
|
125
153
|
# @return [Object]
|
@@ -15,6 +15,11 @@ module AvaTax
|
|
15
15
|
# Both the revisions will be available for retrieval based on their code and ID numbers. Only transactions in Committed status can be reported on a tax filing by Avalara's Managed Returns Service.
|
16
16
|
#
|
17
17
|
# Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are no longer available for adjustments.
|
18
|
+
#
|
19
|
+
# ### Security Policies
|
20
|
+
#
|
21
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
22
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
18
23
|
# @param code [String] The transaction code for this MultiDocument transaction
|
19
24
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
20
25
|
# @param include [String] Specifies objects to include in this fetch call
|
@@ -42,6 +47,11 @@ module AvaTax
|
|
42
47
|
#
|
43
48
|
# A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
|
44
49
|
# sales, purchases, inventory transfer, and returns (also called refunds).
|
50
|
+
#
|
51
|
+
# ### Security Policies
|
52
|
+
#
|
53
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
54
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
45
55
|
# @param code [String] The transaction code for this MultiDocument transaction
|
46
56
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
47
57
|
# @return [Object]
|
@@ -61,6 +71,11 @@ module AvaTax
|
|
61
71
|
# sales, purchases, inventory transfer, and returns (also called refunds).
|
62
72
|
#
|
63
73
|
# Any changes made to a committed transaction will generate a transaction history.
|
74
|
+
#
|
75
|
+
# ### Security Policies
|
76
|
+
#
|
77
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
78
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
64
79
|
# @param model [Object] The commit request you wish to execute
|
65
80
|
# @return [Object]
|
66
81
|
def commit_multi_document_transaction(model)
|
@@ -103,6 +118,11 @@ module AvaTax
|
|
103
118
|
# * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.
|
104
119
|
#
|
105
120
|
# If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
|
121
|
+
#
|
122
|
+
# ### Security Policies
|
123
|
+
#
|
124
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
125
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
106
126
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
107
127
|
# @param model [Object] the multi document transaction model
|
108
128
|
# @return [Object]
|
@@ -126,6 +146,11 @@ module AvaTax
|
|
126
146
|
# * Addresses
|
127
147
|
# * SummaryOnly (omit lines and details - reduces API response size)
|
128
148
|
# * LinesOnly (omit details - reduces API response size)
|
149
|
+
#
|
150
|
+
# ### Security Policies
|
151
|
+
#
|
152
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
153
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
129
154
|
# @param code [String]
|
130
155
|
# @param type [String] (See DocumentType::* for a list of allowable values)
|
131
156
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
@@ -159,6 +184,11 @@ module AvaTax
|
|
159
184
|
# * Addresses
|
160
185
|
# * SummaryOnly (omit lines and details - reduces API response size)
|
161
186
|
# * LinesOnly (omit details - reduces API response size)
|
187
|
+
#
|
188
|
+
# ### Security Policies
|
189
|
+
#
|
190
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
191
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
162
192
|
# @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
|
163
193
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
164
194
|
# @return [Object]
|
@@ -189,6 +219,11 @@ module AvaTax
|
|
189
219
|
# * Addresses
|
190
220
|
# * SummaryOnly (omit lines and details - reduces API response size)
|
191
221
|
# * LinesOnly (omit details - reduces API response size)
|
222
|
+
#
|
223
|
+
# ### Security Policies
|
224
|
+
#
|
225
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
226
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
192
227
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* documents
|
193
228
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
194
229
|
# @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.
|
@@ -239,6 +274,11 @@ module AvaTax
|
|
239
274
|
# * LinesOnly (omit details - reduces API response size)
|
240
275
|
#
|
241
276
|
# If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
|
277
|
+
#
|
278
|
+
# ### Security Policies
|
279
|
+
#
|
280
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
281
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
242
282
|
# @param code [String] The code of this MultiDocument transaction
|
243
283
|
# @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
244
284
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
@@ -258,6 +298,11 @@ module AvaTax
|
|
258
298
|
#
|
259
299
|
# A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
|
260
300
|
# sales, purchases, inventory transfer, and returns (also called refunds).
|
301
|
+
#
|
302
|
+
# ### Security Policies
|
303
|
+
#
|
304
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
305
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
261
306
|
# @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
|
262
307
|
# @return [Object]
|
263
308
|
def verify_multi_document_transaction(model)
|
@@ -277,6 +322,11 @@ module AvaTax
|
|
277
322
|
#
|
278
323
|
# Transactions that have been previously reported to a tax authority by Avalara Managed Returns Service are considered `locked`,
|
279
324
|
# and they are no longer available to be voided.
|
325
|
+
#
|
326
|
+
# ### Security Policies
|
327
|
+
#
|
328
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
329
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
280
330
|
# @param code [String] The transaction code for this MultiDocument transaction
|
281
331
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
282
332
|
# @param model [Object] The void request you wish to execute
|