avatax 19.3.0 → 19.4.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/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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f278d32009a90ac41c3c23927fda86722ecab67e4f17d520f582a2a2e13fbd75
|
4
|
+
data.tar.gz: 1b9b0d495f4d3d5c9fa0ac8c179e190ff21ec3e08065e725f77db20c20cd7bc8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b59549e1462c8a29eb01bc8e0ca4fe373bf3d1f2f4a9ad24965277b10ee50a9c9cda026c6129541c94b421d5904926b376805eff5fe23bf5cb3b2f725b8bf934
|
7
|
+
data.tar.gz: f921e4de25133cdddfad050c8ec27ad15ca63b320eb471edacbf5b967b8850904fb21c4d188ab0ee4fbd3b8a4edc67673a945ce41f875c1243f9c56ebf2da2a2
|
@@ -17,6 +17,10 @@ module AvaTax
|
|
17
17
|
#
|
18
18
|
# When you call this API, all account administrators for this account will receive an email with the newly updated license key.
|
19
19
|
# The email will specify which user reset the license key and it will contain the new key to use to update your connectors.
|
20
|
+
#
|
21
|
+
# ### Security Policies
|
22
|
+
#
|
23
|
+
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
20
24
|
# @param id [Integer] The ID of the account you wish to update.
|
21
25
|
# @param model [Object] A request confirming that you wish to reset the license key of this account.
|
22
26
|
# @return [Object]
|
@@ -38,6 +42,10 @@ module AvaTax
|
|
38
42
|
#
|
39
43
|
# If you have not read or accepted the terms and conditions, this API call will return the
|
40
44
|
# unchanged account model.
|
45
|
+
#
|
46
|
+
# ### Security Policies
|
47
|
+
#
|
48
|
+
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
49
|
# @param id [Integer] The ID of the account to activate
|
42
50
|
# @param model [Object] The activation request
|
43
51
|
# @return [Object]
|
@@ -63,6 +71,10 @@ module AvaTax
|
|
63
71
|
# * The amount of data and number of API calls returned by this API are limited and may be adjusted at any time.
|
64
72
|
# * Old records may be migrated out of immediately available storage. To request older data, please contact your account manager.
|
65
73
|
# * New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched.
|
74
|
+
#
|
75
|
+
# ### Security Policies
|
76
|
+
#
|
77
|
+
# * 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.
|
66
78
|
# @param id [Integer] The ID of the account you wish to audit.
|
67
79
|
# @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
|
68
80
|
# @param end [DateTime] The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
|
@@ -82,6 +94,10 @@ module AvaTax
|
|
82
94
|
#
|
83
95
|
# * Subscriptions
|
84
96
|
# * Users
|
97
|
+
#
|
98
|
+
# ### Security Policies
|
99
|
+
#
|
100
|
+
# * 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.
|
85
101
|
# @param id [Integer] The ID of the account to retrieve
|
86
102
|
# @param include [String] A comma separated list of special fetch options
|
87
103
|
# @return [Object]
|
@@ -105,6 +121,10 @@ module AvaTax
|
|
105
121
|
#
|
106
122
|
# Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
|
107
123
|
# tax calculation and address resolution, and should only be changed with care.
|
124
|
+
#
|
125
|
+
# ### Security Policies
|
126
|
+
#
|
127
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
108
128
|
# @param id [Integer]
|
109
129
|
# @return [AccountConfigurationModel[]]
|
110
130
|
def get_account_configuration(id)
|
@@ -127,6 +147,10 @@ module AvaTax
|
|
127
147
|
# * Users
|
128
148
|
#
|
129
149
|
# For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
|
150
|
+
#
|
151
|
+
# ### Security Policies
|
152
|
+
#
|
153
|
+
# * 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.
|
130
154
|
# @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
|
131
155
|
# @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:* subscriptions, users
|
132
156
|
# @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.
|
@@ -153,6 +177,10 @@ module AvaTax
|
|
153
177
|
#
|
154
178
|
# Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
|
155
179
|
# tax calculation and address resolution, and should only be changed with care.
|
180
|
+
#
|
181
|
+
# ### Security Policies
|
182
|
+
#
|
183
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
156
184
|
# @param id [Integer]
|
157
185
|
# @param model [AccountConfigurationModel[]]
|
158
186
|
# @return [AccountConfigurationModel[]]
|
@@ -11,6 +11,11 @@ module AvaTax
|
|
11
11
|
# 'messages' structure to learn more about problems with this address.
|
12
12
|
# This is the same API as the POST /api/v2/addresses/resolve endpoint.
|
13
13
|
# Both verbs are supported to provide for flexible implementation.
|
14
|
+
#
|
15
|
+
# ### Security Policies
|
16
|
+
#
|
17
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
18
|
+
# * This API depends on the following active services<br />*Required* (all): AutoAddress.
|
14
19
|
# @param line1 [String] Line 1
|
15
20
|
# @param line2 [String] Line 2
|
16
21
|
# @param line3 [String] Line 3
|
@@ -34,6 +39,11 @@ module AvaTax
|
|
34
39
|
# 'messages' structure to learn more about problems with this address.
|
35
40
|
# This is the same API as the GET /api/v2/addresses/resolve endpoint.
|
36
41
|
# Both verbs are supported to provide for flexible implementation.
|
42
|
+
#
|
43
|
+
# ### Security Policies
|
44
|
+
#
|
45
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
46
|
+
# * This API depends on the following active services<br />*Required* (all): AutoAddress.
|
37
47
|
# @param model [Object] The address to resolve
|
38
48
|
# @return [Object]
|
39
49
|
def resolve_address_post(model)
|
@@ -7,6 +7,12 @@ module AvaTax
|
|
7
7
|
#
|
8
8
|
# Create one or more AvaFileForms
|
9
9
|
# A 'AvaFileForm' represents a form supported by our returns team
|
10
|
+
#
|
11
|
+
# ### Security Policies
|
12
|
+
#
|
13
|
+
# * This API requires the user role Compliance Root User.
|
14
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
15
|
+
# * 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.
|
10
16
|
# @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
|
11
17
|
# @return [AvaFileFormModel[]]
|
12
18
|
def create_ava_file_forms(model)
|
@@ -18,6 +24,12 @@ module AvaTax
|
|
18
24
|
# Delete a single AvaFileForm
|
19
25
|
#
|
20
26
|
# Marks the existing AvaFileForm object at this URL as deleted.
|
27
|
+
#
|
28
|
+
# ### Security Policies
|
29
|
+
#
|
30
|
+
# * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
|
31
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
32
|
+
# * 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
33
|
# @param id [Integer] The ID of the AvaFileForm you wish to delete.
|
22
34
|
# @return [ErrorDetail[]]
|
23
35
|
def delete_ava_file_form(id)
|
@@ -29,6 +41,12 @@ module AvaTax
|
|
29
41
|
# Retrieve a single AvaFileForm
|
30
42
|
#
|
31
43
|
# Get the AvaFileForm object identified by this URL.
|
44
|
+
#
|
45
|
+
# ### Security Policies
|
46
|
+
#
|
47
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
|
48
|
+
# * 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.
|
49
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
32
50
|
# @param id [Integer] The primary key of this AvaFileForm
|
33
51
|
# @return [Object]
|
34
52
|
def get_ava_file_form(id)
|
@@ -41,6 +59,12 @@ module AvaTax
|
|
41
59
|
#
|
42
60
|
# 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/) .
|
43
61
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
62
|
+
#
|
63
|
+
# ### Security Policies
|
64
|
+
#
|
65
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
|
66
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
67
|
+
# * 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.
|
44
68
|
# @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:* outletTypeId
|
45
69
|
# @param include [String] A comma separated list of additional data to retrieve.
|
46
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.
|
@@ -57,6 +81,12 @@ module AvaTax
|
|
57
81
|
#
|
58
82
|
# All data from the existing object will be replaced with data in the object you PUT.
|
59
83
|
# 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.
|
84
|
+
#
|
85
|
+
# ### Security Policies
|
86
|
+
#
|
87
|
+
# * This API requires the user role Compliance Root User.
|
88
|
+
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
89
|
+
# * 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.
|
60
90
|
# @param id [Integer] The ID of the AvaFileForm you wish to update
|
61
91
|
# @param model [Object] The AvaFileForm model you wish to update.
|
62
92
|
# @return [Object]
|
@@ -19,6 +19,10 @@ module AvaTax
|
|
19
19
|
# predict when a batch will complete. If high performance processing is
|
20
20
|
# required, please use the
|
21
21
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
22
|
+
#
|
23
|
+
# ### Security Policies
|
24
|
+
#
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
22
26
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
23
27
|
# @param model [BatchModel[]] The batch you wish to create.
|
24
28
|
# @return [BatchModel[]]
|
@@ -40,6 +44,10 @@ module AvaTax
|
|
40
44
|
# predict when a batch will complete. If high performance processing is
|
41
45
|
# required, please use the
|
42
46
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
47
|
+
#
|
48
|
+
# ### Security Policies
|
49
|
+
#
|
50
|
+
# * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
43
51
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
44
52
|
# @param id [Integer] The ID of the batch to delete.
|
45
53
|
# @return [ErrorDetail[]]
|
@@ -52,6 +60,10 @@ module AvaTax
|
|
52
60
|
# Download a single batch file
|
53
61
|
#
|
54
62
|
# Download a single batch file identified by this URL.
|
63
|
+
#
|
64
|
+
# ### Security Policies
|
65
|
+
#
|
66
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
55
67
|
# @param companyId [Integer] The ID of the company that owns this batch
|
56
68
|
# @param batchId [Integer] The ID of the batch object
|
57
69
|
# @param id [Integer] The primary key of this batch file object
|
@@ -79,6 +91,10 @@ module AvaTax
|
|
79
91
|
# predict when a batch will complete. If high performance processing is
|
80
92
|
# required, please use the
|
81
93
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
94
|
+
#
|
95
|
+
# ### Security Policies
|
96
|
+
#
|
97
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
82
98
|
# @param companyId [Integer] The ID of the company that owns this batch
|
83
99
|
# @param id [Integer] The primary key of this batch
|
84
100
|
# @return [Object]
|
@@ -111,6 +127,10 @@ module AvaTax
|
|
111
127
|
# predict when a batch will complete. If high performance processing is
|
112
128
|
# required, please use the
|
113
129
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
130
|
+
#
|
131
|
+
# ### Security Policies
|
132
|
+
#
|
133
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
114
134
|
# @param companyId [Integer] The ID of the company that owns these batches
|
115
135
|
# @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:* files
|
116
136
|
# @param include [String] A comma separated list of additional data to retrieve.
|
@@ -144,6 +164,10 @@ module AvaTax
|
|
144
164
|
# predict when a batch will complete. If high performance processing is
|
145
165
|
# required, please use the
|
146
166
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
167
|
+
#
|
168
|
+
# ### Security Policies
|
169
|
+
#
|
170
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
147
171
|
# @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:* files
|
148
172
|
# @param include [String] A comma separated list of additional data to retrieve.
|
149
173
|
# @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.
|
@@ -20,6 +20,11 @@ module AvaTax
|
|
20
20
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
21
21
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
22
22
|
# storage for this company, call `RequestCertificateSetup`.
|
23
|
+
#
|
24
|
+
# ### Security Policies
|
25
|
+
#
|
26
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
27
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
23
28
|
# @param companyId [Integer] The unique ID number of the company that will record certificates
|
24
29
|
# @param customerCode [String] The number of the customer where the request is sent to
|
25
30
|
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
|
@@ -47,6 +52,11 @@ module AvaTax
|
|
47
52
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
48
53
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
49
54
|
# storage for this company, call `RequestCertificateSetup`.
|
55
|
+
#
|
56
|
+
# ### Security Policies
|
57
|
+
#
|
58
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
59
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
50
60
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
51
61
|
# @param customerCode [String] The number of the customer where the request is sent to
|
52
62
|
# @param id [Integer] The unique ID number of this CertExpress invitation
|
@@ -75,6 +85,11 @@ module AvaTax
|
|
75
85
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
76
86
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
77
87
|
# storage for this company, call `RequestCertificateSetup`.
|
88
|
+
#
|
89
|
+
# ### Security Policies
|
90
|
+
#
|
91
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
92
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
78
93
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
79
94
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
80
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
|
@@ -24,6 +24,11 @@ module AvaTax
|
|
24
24
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
25
25
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
26
26
|
# storage for this company, call `RequestCertificateSetup`.
|
27
|
+
#
|
28
|
+
# ### Security Policies
|
29
|
+
#
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
31
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
27
32
|
# @param companyId [Integer] The ID number of the company recording this certificate
|
28
33
|
# @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
|
29
34
|
# @param model [CertificateModel[]] Certificates to be created
|
@@ -49,6 +54,11 @@ module AvaTax
|
|
49
54
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
50
55
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
51
56
|
# storage for this company, call `RequestCertificateSetup`.
|
57
|
+
#
|
58
|
+
# ### Security Policies
|
59
|
+
#
|
60
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
61
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
52
62
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
53
63
|
# @param id [Integer] The unique ID number of this certificate
|
54
64
|
# @return [Object]
|
@@ -74,6 +84,11 @@ module AvaTax
|
|
74
84
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
75
85
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
76
86
|
# storage for this company, call `RequestCertificateSetup`.
|
87
|
+
#
|
88
|
+
# ### Security Policies
|
89
|
+
#
|
90
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
91
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
77
92
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
78
93
|
# @param id [Integer] The unique ID number of this certificate
|
79
94
|
# @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
|
@@ -104,6 +119,11 @@ module AvaTax
|
|
104
119
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
105
120
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
106
121
|
# storage for this company, call `RequestCertificateSetup`.
|
122
|
+
#
|
123
|
+
# ### Security Policies
|
124
|
+
#
|
125
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
126
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
107
127
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
108
128
|
# @param id [Integer] The unique ID number of this certificate
|
109
129
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
@@ -123,6 +143,11 @@ module AvaTax
|
|
123
143
|
# `GetCertificateSetup` to see if your company is configured to use the exemption certificate
|
124
144
|
# document store. To request setup, please call `RequestCertificateSetup` and your company will
|
125
145
|
# be configured with data storage in the auditable certificate system.
|
146
|
+
#
|
147
|
+
# ### Security Policies
|
148
|
+
#
|
149
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
150
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
126
151
|
# @param companyId [Integer] The company ID to check
|
127
152
|
# @return [Object]
|
128
153
|
def get_certificate_setup(companyId)
|
@@ -147,6 +172,11 @@ module AvaTax
|
|
147
172
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
148
173
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
149
174
|
# storage for this company, call `RequestCertificateSetup`.
|
175
|
+
#
|
176
|
+
# ### Security Policies
|
177
|
+
#
|
178
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
179
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
150
180
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
151
181
|
# @param id [Integer] The unique ID number of this certificate
|
152
182
|
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
|
@@ -174,6 +204,11 @@ module AvaTax
|
|
174
204
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
175
205
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
176
206
|
# storage for this company, call `RequestCertificateSetup`.
|
207
|
+
#
|
208
|
+
# ### Security Policies
|
209
|
+
#
|
210
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
211
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
177
212
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
178
213
|
# @param id [Integer] The unique ID number of this certificate
|
179
214
|
# @param model [Object] The list of customers needed be added to the Certificate for exemption
|
@@ -200,6 +235,11 @@ module AvaTax
|
|
200
235
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
201
236
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
202
237
|
# storage for this company, call `RequestCertificateSetup`.
|
238
|
+
#
|
239
|
+
# ### Security Policies
|
240
|
+
#
|
241
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
242
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
203
243
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
204
244
|
# @param id [Integer] The unique ID number of this certificate
|
205
245
|
# @return [FetchResult]
|
@@ -225,9 +265,14 @@ module AvaTax
|
|
225
265
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
226
266
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
227
267
|
# storage for this company, call `RequestCertificateSetup`.
|
268
|
+
#
|
269
|
+
# ### Security Policies
|
270
|
+
#
|
271
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
272
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
228
273
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
229
274
|
# @param id [Integer] The unique ID number of this certificate
|
230
|
-
# @param include [String] OPTIONAL: A comma separated list of special fetch options.
|
275
|
+
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
|
231
276
|
# @return [FetchResult]
|
232
277
|
def list_customers_for_certificate(companyId, id, options={})
|
233
278
|
path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
|
@@ -254,6 +299,11 @@ module AvaTax
|
|
254
299
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
255
300
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
256
301
|
# storage for this company, call `RequestCertificateSetup`.
|
302
|
+
#
|
303
|
+
# ### Security Policies
|
304
|
+
#
|
305
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
306
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
257
307
|
# @param companyId [Integer] The ID number of the company to search
|
258
308
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
259
309
|
# @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, pdf, pages
|
@@ -278,6 +328,11 @@ module AvaTax
|
|
278
328
|
# be configured with data storage in the auditable certificate system.
|
279
329
|
#
|
280
330
|
# This API will return the current status of exemption certificate setup for this company.
|
331
|
+
#
|
332
|
+
# ### Security Policies
|
333
|
+
#
|
334
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
335
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
281
336
|
# @param companyId [Integer]
|
282
337
|
# @return [Object]
|
283
338
|
def request_certificate_setup(companyId)
|
@@ -302,6 +357,11 @@ module AvaTax
|
|
302
357
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
303
358
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
304
359
|
# storage for this company, call `RequestCertificateSetup`.
|
360
|
+
#
|
361
|
+
# ### Security Policies
|
362
|
+
#
|
363
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
364
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
305
365
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
306
366
|
# @param id [Integer] The unique ID number of this certificate
|
307
367
|
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
|
@@ -330,6 +390,11 @@ module AvaTax
|
|
330
390
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
331
391
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
332
392
|
# storage for this company, call `RequestCertificateSetup`.
|
393
|
+
#
|
394
|
+
# ### Security Policies
|
395
|
+
#
|
396
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
397
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
333
398
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
334
399
|
# @param id [Integer] The unique ID number of this certificate
|
335
400
|
# @param model [Object] The list of customers to unlink from this certificate
|
@@ -353,6 +418,11 @@ module AvaTax
|
|
353
418
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
354
419
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
355
420
|
# storage for this company, call `RequestCertificateSetup`.
|
421
|
+
#
|
422
|
+
# ### Security Policies
|
423
|
+
#
|
424
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
425
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
356
426
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
357
427
|
# @param id [Integer] The unique ID number of this certificate
|
358
428
|
# @param model [Object] The new certificate object that will replace the existing one
|
@@ -379,6 +449,11 @@ module AvaTax
|
|
379
449
|
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
380
450
|
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
381
451
|
# storage for this company, call `RequestCertificateSetup`.
|
452
|
+
#
|
453
|
+
# ### Security Policies
|
454
|
+
#
|
455
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
456
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
382
457
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
383
458
|
# @param id [Integer] The unique ID number of this certificate
|
384
459
|
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
|