avatax 20.7.1 → 20.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/avatax/client/companies.rb +105 -0
- data/lib/avatax/client/definitions.rb +1 -1
- data/lib/avatax/client/ecommercetoken.rb +37 -0
- data/lib/avatax/client/filings.rb +11 -0
- data/lib/avatax/client/locations.rb +115 -4
- data/lib/avatax/client/nexus.rb +125 -0
- data/lib/avatax/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c08d7f2d60ccec52c65e15e8378aae00107bf689f85616977c26ba80d52a7e31
|
4
|
+
data.tar.gz: 941810e2bbaca8285c4e92e990a3484cf40305a232096dc7b6f3bd3cbdeeee4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ba3e6760464cb115a26cc3c546d237336b8a29001f746f20f0feea89aaa89be664fe474bc05eac0110190736f9d73dcfdef74efe4cdfc4f46a5de00939b856ed
|
7
|
+
data.tar.gz: 26bbf0e85b649d41e2a590bd4c03e6ce720cd4ef8e5f63f5fdc6515a81b2e6503a8d1585a772d9f2f2e1f9f64a5595aae847a9862dea8923392e055af4fec6dd
|
@@ -101,6 +101,29 @@ module AvaTax
|
|
101
101
|
def create_companies(model) path = "/api/v2/companies"
|
102
102
|
post(path, model) end
|
103
103
|
|
104
|
+
# Add parameters to a company.
|
105
|
+
#
|
106
|
+
# Add parameters to a company.
|
107
|
+
#
|
108
|
+
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
109
|
+
#
|
110
|
+
# A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
|
111
|
+
#
|
112
|
+
# A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
|
113
|
+
#
|
114
|
+
# To see available parameters for this company, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`
|
115
|
+
#
|
116
|
+
# 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.
|
117
|
+
#
|
118
|
+
# ### Security Policies
|
119
|
+
#
|
120
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
121
|
+
# @param companyId [Integer] The ID of the company that owns this company parameter.
|
122
|
+
# @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
|
123
|
+
# @return [CompanyParameterDetailModel[]]
|
124
|
+
def create_company_parameters(companyId, model) path = "/api/v2/companies/#{companyId}/parameters"
|
125
|
+
post(path, model) end
|
126
|
+
|
104
127
|
# Request managed returns funding setup for a company
|
105
128
|
#
|
106
129
|
# This API is available by invitation only.
|
@@ -136,6 +159,24 @@ module AvaTax
|
|
136
159
|
def delete_company(id) path = "/api/v2/companies/#{id}"
|
137
160
|
delete(path) end
|
138
161
|
|
162
|
+
# Delete a single company parameter
|
163
|
+
#
|
164
|
+
# Delete a parameter of a company.
|
165
|
+
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
166
|
+
#
|
167
|
+
# A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
|
168
|
+
#
|
169
|
+
# A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
|
170
|
+
#
|
171
|
+
# ### Security Policies
|
172
|
+
#
|
173
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
174
|
+
# @param companyId [Integer] The company id
|
175
|
+
# @param id [Integer] The parameter id
|
176
|
+
# @return [ErrorDetail[]]
|
177
|
+
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
178
|
+
delete(path) end
|
179
|
+
|
139
180
|
# Check the funding configuration of a company
|
140
181
|
#
|
141
182
|
# This API is available by invitation only.
|
@@ -217,6 +258,25 @@ module AvaTax
|
|
217
258
|
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
218
259
|
get(path) end
|
219
260
|
|
261
|
+
# Retrieve a single company parameter
|
262
|
+
#
|
263
|
+
# Retrieves a single parameter of a company.
|
264
|
+
#
|
265
|
+
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
266
|
+
#
|
267
|
+
# A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
|
268
|
+
#
|
269
|
+
# A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
|
270
|
+
#
|
271
|
+
# ### Security Policies
|
272
|
+
#
|
273
|
+
# * 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.
|
274
|
+
# @param companyId [Integer]
|
275
|
+
# @param id [Integer]
|
276
|
+
# @return [Object]
|
277
|
+
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
278
|
+
get(path) end
|
279
|
+
|
220
280
|
# Get this company's filing status
|
221
281
|
#
|
222
282
|
# Retrieve the current filing status of this company.
|
@@ -241,6 +301,31 @@ module AvaTax
|
|
241
301
|
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
242
302
|
get(path) end
|
243
303
|
|
304
|
+
# Retrieve parameters for a company
|
305
|
+
#
|
306
|
+
# Retrieve all parameters of a company.
|
307
|
+
#
|
308
|
+
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
309
|
+
#
|
310
|
+
# A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
|
311
|
+
#
|
312
|
+
# A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
|
313
|
+
#
|
314
|
+
# 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/) .
|
315
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
316
|
+
#
|
317
|
+
# ### Security Policies
|
318
|
+
#
|
319
|
+
# * 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.
|
320
|
+
# @param companyId [Integer] The company id
|
321
|
+
# @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
|
322
|
+
# @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.
|
323
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
324
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
325
|
+
# @return [FetchResult]
|
326
|
+
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
327
|
+
get(path, options) end
|
328
|
+
|
244
329
|
# Check managed returns funding status for a company
|
245
330
|
#
|
246
331
|
# This API is available by invitation only.
|
@@ -348,6 +433,26 @@ module AvaTax
|
|
348
433
|
# @return [Object]
|
349
434
|
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
350
435
|
put(path, model) end
|
436
|
+
|
437
|
+
# Update a company parameter
|
438
|
+
#
|
439
|
+
# Update a parameter of a company.
|
440
|
+
#
|
441
|
+
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
442
|
+
#
|
443
|
+
# A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
|
444
|
+
#
|
445
|
+
# A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
|
446
|
+
#
|
447
|
+
# ### Security Policies
|
448
|
+
#
|
449
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
450
|
+
# @param companyId [Integer] The company id.
|
451
|
+
# @param id [Integer] The company parameter id
|
452
|
+
# @param model [Object] The company parameter object you wish to update.
|
453
|
+
# @return [Object]
|
454
|
+
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
455
|
+
put(path, model) end
|
351
456
|
end
|
352
457
|
end
|
353
458
|
end
|
@@ -259,7 +259,7 @@ module AvaTax
|
|
259
259
|
# Returns a list of all Avalara-supported taxing jurisdictions.
|
260
260
|
#
|
261
261
|
# This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
|
262
|
-
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate
|
262
|
+
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
|
263
263
|
#
|
264
264
|
# The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
|
265
265
|
# @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:* rate, salesRate, signatureCode, useRate
|
@@ -0,0 +1,37 @@
|
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module ECommerceToken
|
4
|
+
|
5
|
+
|
6
|
+
# Create a new eCommerce token.
|
7
|
+
#
|
8
|
+
# Creates a new eCommerce token.
|
9
|
+
#
|
10
|
+
# This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
|
11
|
+
#
|
12
|
+
# ### Security Policies
|
13
|
+
#
|
14
|
+
# * 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.
|
15
|
+
# @param companyId [Integer] The company ID that will be issued this certificate.
|
16
|
+
# @param model [Object]
|
17
|
+
# @return [FetchResult]
|
18
|
+
def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
|
19
|
+
post(path, model) end
|
20
|
+
|
21
|
+
# Refresh an eCommerce token.
|
22
|
+
#
|
23
|
+
# Refresh an eCommerce token.
|
24
|
+
#
|
25
|
+
# CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
|
26
|
+
#
|
27
|
+
# ### Security Policies
|
28
|
+
#
|
29
|
+
# * 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.
|
30
|
+
# @param companyId [Integer] The company ID that the refreshed certificate belongs to.
|
31
|
+
# @param model [Object]
|
32
|
+
# @return [FetchResult]
|
33
|
+
def refresh_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
|
34
|
+
put(path, model) end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -3,6 +3,17 @@ module AvaTax
|
|
3
3
|
module Filings
|
4
4
|
|
5
5
|
|
6
|
+
# Retrieve a filing containing the return and all its accrual returns.
|
7
|
+
#
|
8
|
+
# ### Security Policies
|
9
|
+
#
|
10
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
11
|
+
# @param companyId [Integer] The ID of the company that owns these returns
|
12
|
+
# @param filingReturnId [Integer] The ID of the filing return
|
13
|
+
# @return [FetchResult]
|
14
|
+
def get_accrual_filings(companyId, filingReturnId) path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
|
15
|
+
get(path) end
|
16
|
+
|
6
17
|
# Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
|
7
18
|
#
|
8
19
|
# ### Security Policies
|
@@ -3,6 +3,30 @@ module AvaTax
|
|
3
3
|
module Locations
|
4
4
|
|
5
5
|
|
6
|
+
# Add parameters to a location.
|
7
|
+
#
|
8
|
+
# Add parameters to a location.
|
9
|
+
#
|
10
|
+
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
11
|
+
#
|
12
|
+
# A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
|
13
|
+
#
|
14
|
+
# A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
|
15
|
+
#
|
16
|
+
# To see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`
|
17
|
+
#
|
18
|
+
# 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.
|
19
|
+
#
|
20
|
+
# ### Security Policies
|
21
|
+
#
|
22
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
23
|
+
# @param companyId [Integer] The ID of the company that owns this location parameter.
|
24
|
+
# @param locationId [Integer] The location id.
|
25
|
+
# @param model [LocationParameterModel[]] The location parameters you wish to create.
|
26
|
+
# @return [LocationParameterModel[]]
|
27
|
+
def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
28
|
+
post(path, model) end
|
29
|
+
|
6
30
|
# Create a new location
|
7
31
|
#
|
8
32
|
# Create one or more new location objects attached to this company.
|
@@ -29,6 +53,26 @@ module AvaTax
|
|
29
53
|
def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
30
54
|
delete(path) end
|
31
55
|
|
56
|
+
# Delete a single location parameter
|
57
|
+
#
|
58
|
+
# Delete a single location parameter.
|
59
|
+
#
|
60
|
+
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
61
|
+
#
|
62
|
+
# A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
|
63
|
+
#
|
64
|
+
# A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
|
65
|
+
#
|
66
|
+
# ### Security Policies
|
67
|
+
#
|
68
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
69
|
+
# @param companyId [Integer] The company id
|
70
|
+
# @param locationId [Integer] The location id
|
71
|
+
# @param id [Integer] The parameter id
|
72
|
+
# @return [ErrorDetail[]]
|
73
|
+
def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
74
|
+
delete(path) end
|
75
|
+
|
32
76
|
# Retrieve a single location
|
33
77
|
#
|
34
78
|
# Get the location object identified by this URL.
|
@@ -44,7 +88,7 @@ module AvaTax
|
|
44
88
|
#
|
45
89
|
# ### Security Policies
|
46
90
|
#
|
47
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
91
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
48
92
|
# @param companyId [Integer] The ID of the company that owns this location
|
49
93
|
# @param id [Integer] The primary key of this location
|
50
94
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -52,6 +96,52 @@ module AvaTax
|
|
52
96
|
def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
53
97
|
get(path, options) end
|
54
98
|
|
99
|
+
# Retrieve a single company location parameter
|
100
|
+
#
|
101
|
+
# Retrieve a single location parameter.
|
102
|
+
#
|
103
|
+
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
104
|
+
#
|
105
|
+
# A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
|
106
|
+
#
|
107
|
+
# A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
|
108
|
+
#
|
109
|
+
# ### Security Policies
|
110
|
+
#
|
111
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
112
|
+
# @param companyId [Integer] The company id
|
113
|
+
# @param locationId [Integer] The location id
|
114
|
+
# @param id [Integer] The parameter id
|
115
|
+
# @return [Object]
|
116
|
+
def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
117
|
+
get(path) end
|
118
|
+
|
119
|
+
# Retrieve parameters for a location
|
120
|
+
#
|
121
|
+
# List parameters for a location.
|
122
|
+
#
|
123
|
+
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
124
|
+
#
|
125
|
+
# A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
|
126
|
+
#
|
127
|
+
# A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
|
128
|
+
#
|
129
|
+
# 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/) .
|
130
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
131
|
+
#
|
132
|
+
# ### Security Policies
|
133
|
+
#
|
134
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
135
|
+
# @param companyId [Integer] The company id
|
136
|
+
# @param locationId [Integer] The ID of the location
|
137
|
+
# @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
|
138
|
+
# @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.
|
139
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
140
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
141
|
+
# @return [FetchResult]
|
142
|
+
def list_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
143
|
+
get(path, options) end
|
144
|
+
|
55
145
|
# Retrieve locations for this company
|
56
146
|
#
|
57
147
|
# List all location objects defined for this company.
|
@@ -69,7 +159,7 @@ module AvaTax
|
|
69
159
|
#
|
70
160
|
# ### Security Policies
|
71
161
|
#
|
72
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
162
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
73
163
|
# @param companyId [Integer] The ID of the company that owns these locations
|
74
164
|
# @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, parameters
|
75
165
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -98,7 +188,7 @@ module AvaTax
|
|
98
188
|
#
|
99
189
|
# ### Security Policies
|
100
190
|
#
|
101
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
191
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
102
192
|
# @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, parameters
|
103
193
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
104
194
|
# @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.
|
@@ -124,6 +214,27 @@ module AvaTax
|
|
124
214
|
def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
125
215
|
put(path, model) end
|
126
216
|
|
217
|
+
# Update a location parameter
|
218
|
+
#
|
219
|
+
# Update a location parameter.
|
220
|
+
#
|
221
|
+
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
222
|
+
#
|
223
|
+
# A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
|
224
|
+
#
|
225
|
+
# A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
|
226
|
+
#
|
227
|
+
# ### Security Policies
|
228
|
+
#
|
229
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
230
|
+
# @param companyId [Integer] The company id.
|
231
|
+
# @param locationId [Integer] The location id
|
232
|
+
# @param id [Integer] The location parameter id
|
233
|
+
# @param model [Object] The location parameter object you wish to update.
|
234
|
+
# @return [Object]
|
235
|
+
def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
236
|
+
put(path, model) end
|
237
|
+
|
127
238
|
# Validate the location against local requirements
|
128
239
|
#
|
129
240
|
# Returns validation information for this location.
|
@@ -132,7 +243,7 @@ module AvaTax
|
|
132
243
|
#
|
133
244
|
# ### Security Policies
|
134
245
|
#
|
135
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
246
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
136
247
|
# @param companyId [Integer] The ID of the company that owns this location
|
137
248
|
# @param id [Integer] The primary key of this location
|
138
249
|
# @return [Object]
|
data/lib/avatax/client/nexus.rb
CHANGED
@@ -34,6 +34,29 @@ module AvaTax
|
|
34
34
|
def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
|
35
35
|
post(path, model) end
|
36
36
|
|
37
|
+
# Add parameters to a nexus.
|
38
|
+
#
|
39
|
+
# Add parameters to the nexus.
|
40
|
+
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
41
|
+
#
|
42
|
+
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
43
|
+
#
|
44
|
+
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
45
|
+
#
|
46
|
+
# To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus`
|
47
|
+
#
|
48
|
+
# 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.
|
49
|
+
#
|
50
|
+
# ### Security Policies
|
51
|
+
#
|
52
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
53
|
+
# @param companyId [Integer] The ID of the company that owns this nexus parameter.
|
54
|
+
# @param nexusId [Integer] The nexus id.
|
55
|
+
# @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
|
56
|
+
# @return [NexusParameterDetailModel[]]
|
57
|
+
def create_nexus_parameters(companyId, nexusId, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
58
|
+
post(path, model) end
|
59
|
+
|
37
60
|
# Creates nexus for a list of addresses.
|
38
61
|
#
|
39
62
|
# This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
|
@@ -82,6 +105,43 @@ module AvaTax
|
|
82
105
|
def delete_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
83
106
|
delete(path, options) end
|
84
107
|
|
108
|
+
# Delete a single nexus parameter
|
109
|
+
#
|
110
|
+
# Delete a single nexus parameter.
|
111
|
+
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
112
|
+
#
|
113
|
+
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
114
|
+
#
|
115
|
+
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
116
|
+
#
|
117
|
+
# ### Security Policies
|
118
|
+
#
|
119
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
120
|
+
# @param companyId [Integer] The company id
|
121
|
+
# @param nexusId [Integer] The nexus id
|
122
|
+
# @param id [Integer] The parameter id
|
123
|
+
# @return [ErrorDetail[]]
|
124
|
+
def delete_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
125
|
+
delete(path) end
|
126
|
+
|
127
|
+
# Delete all parameters for an nexus
|
128
|
+
#
|
129
|
+
# Delete all the parameters for a given nexus.
|
130
|
+
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
131
|
+
#
|
132
|
+
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
133
|
+
#
|
134
|
+
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
135
|
+
#
|
136
|
+
# ### Security Policies
|
137
|
+
#
|
138
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
139
|
+
# @param companyId [Integer] The ID of the company that owns this nexus.
|
140
|
+
# @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
|
141
|
+
# @return [ErrorDetail[]]
|
142
|
+
def delete_nexus_parameters(companyId, nexusId) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
143
|
+
delete(path) end
|
144
|
+
|
85
145
|
# Retrieve a single nexus
|
86
146
|
#
|
87
147
|
# Get the nexus object identified by this URL.
|
@@ -128,6 +188,25 @@ module AvaTax
|
|
128
188
|
def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
129
189
|
get(path, options) end
|
130
190
|
|
191
|
+
# Retrieve a single nexus parameter
|
192
|
+
#
|
193
|
+
# Retrieve a single nexus parameter.
|
194
|
+
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters".
|
195
|
+
#
|
196
|
+
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
197
|
+
#
|
198
|
+
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
199
|
+
#
|
200
|
+
# ### Security Policies
|
201
|
+
#
|
202
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
203
|
+
# @param companyId [Integer] The company id
|
204
|
+
# @param nexusId [Integer] The nexus id
|
205
|
+
# @param id [Integer] The parameter id
|
206
|
+
# @return [Object]
|
207
|
+
def get_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
208
|
+
get(path) end
|
209
|
+
|
131
210
|
# Retrieve nexus for this company
|
132
211
|
#
|
133
212
|
# List all nexus objects defined for this company.
|
@@ -155,6 +234,31 @@ module AvaTax
|
|
155
234
|
def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
|
156
235
|
get(path, options) end
|
157
236
|
|
237
|
+
# Retrieve parameters for a nexus
|
238
|
+
#
|
239
|
+
# List parameters for a nexus.
|
240
|
+
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
241
|
+
#
|
242
|
+
# A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
|
243
|
+
#
|
244
|
+
# A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
|
245
|
+
#
|
246
|
+
# 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/) .
|
247
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
248
|
+
#
|
249
|
+
# ### Security Policies
|
250
|
+
#
|
251
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
252
|
+
# @param companyId [Integer] The company id
|
253
|
+
# @param nexusId [Integer] The nexus id
|
254
|
+
# @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
|
255
|
+
# @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.
|
256
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
257
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
258
|
+
# @return [FetchResult]
|
259
|
+
def list_nexus_parameters(companyId, nexusId, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
|
260
|
+
get(path, options) end
|
261
|
+
|
158
262
|
# Retrieve all nexus
|
159
263
|
#
|
160
264
|
# Get multiple nexus objects across all companies.
|
@@ -212,6 +316,27 @@ module AvaTax
|
|
212
316
|
# @return [Object]
|
213
317
|
def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
214
318
|
put(path, model) end
|
319
|
+
|
320
|
+
# Update an nexus parameter
|
321
|
+
#
|
322
|
+
# Update an nexus parameter.
|
323
|
+
#
|
324
|
+
# Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
|
325
|
+
#
|
326
|
+
# A parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added.
|
327
|
+
#
|
328
|
+
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this?
|
329
|
+
#
|
330
|
+
# ### Security Policies
|
331
|
+
#
|
332
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
333
|
+
# @param companyId [Integer] The company id.
|
334
|
+
# @param nexusId [Integer] The nexus id
|
335
|
+
# @param id [Integer] The nexus parameter id
|
336
|
+
# @param model [Object] The nexus object you wish to update.
|
337
|
+
# @return [Object]
|
338
|
+
def update_nexus_parameter(companyId, nexusId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
|
339
|
+
put(path, model) end
|
215
340
|
end
|
216
341
|
end
|
217
342
|
end
|
data/lib/avatax/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: avatax
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 20.
|
4
|
+
version: 20.9.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: 2020-
|
11
|
+
date: 2020-09-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rake
|
@@ -133,6 +133,7 @@ files:
|
|
133
133
|
- lib/avatax/client/definitions.rb
|
134
134
|
- lib/avatax/client/distancethresholds.rb
|
135
135
|
- lib/avatax/client/ecms.rb
|
136
|
+
- lib/avatax/client/ecommercetoken.rb
|
136
137
|
- lib/avatax/client/errortransactions.rb
|
137
138
|
- lib/avatax/client/filingcalendars.rb
|
138
139
|
- lib/avatax/client/filings.rb
|