avatax 20.7.1 → 21.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.vs/slnx.sqlite +0 -0
- data/lib/avatax/client/addresses.rb +3 -3
- data/lib/avatax/client/advancedrules.rb +0 -10
- data/lib/avatax/client/avafileforms.rb +5 -5
- data/lib/avatax/client/certexpressinvites.rb +15 -15
- data/lib/avatax/client/certificates.rb +67 -67
- data/lib/avatax/client/companies.rb +111 -5
- data/lib/avatax/client/customers.rb +61 -61
- data/lib/avatax/client/datasources.rb +6 -6
- data/lib/avatax/client/definitions.rb +8 -8
- data/lib/avatax/client/ecms.rb +26 -31
- data/lib/avatax/client/ecommercetoken.rb +37 -0
- data/lib/avatax/client/errortransactions.rb +27 -15
- data/lib/avatax/client/filingcalendars.rb +15 -0
- data/lib/avatax/client/filings.rb +13 -2
- data/lib/avatax/client/free.rb +0 -73
- data/lib/avatax/client/fundingrequests.rb +2 -2
- data/lib/avatax/client/locations.rb +117 -6
- data/lib/avatax/client/multidocument.rb +12 -12
- data/lib/avatax/client/nexus.rb +127 -2
- data/lib/avatax/client/notices.rb +47 -139
- data/lib/avatax/client/reports.rb +9 -0
- data/lib/avatax/client/taxcontent.rb +65 -2
- data/lib/avatax/client/taxprofiles.rb +14 -10
- data/lib/avatax/client/transactions.rb +21 -21
- data/lib/avatax/client/upcs.rb +6 -6
- data/lib/avatax/configuration.rb +1 -1
- data/lib/avatax/request.rb +0 -2
- data/lib/avatax/version.rb +1 -1
- data/spec/avatax/request_spec.rb +25 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f954acc262e0f93e75cfa135773ab4ba008c032d396499c4550109efb59114b8
|
4
|
+
data.tar.gz: 2cdc43d59f4efe0f6a6d4ceca7922f549a67c3a1318a5513390564f4f67ccab1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 79ed773916600f4ff09733e1d04d892f738da10ffddfa50357f01ba929333636d7430afb40496b956e27cd3e65736f5490d958e7c749b8c111fcb702a6b7c4db
|
7
|
+
data.tar.gz: 49cbe74ffdba0cd4bafe3eff81c6c28621d4e1ae599feea50741d382ae82a8138c04a2dc0ab322153317b84871279c96bc5fff1a8076aa4f4c7b7393b1342dc7
|
data/.vs/slnx.sqlite
CHANGED
Binary file
|
@@ -12,7 +12,7 @@ module AvaTax
|
|
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
14
|
#
|
15
|
-
#
|
15
|
+
# In order to get any evaluation for an address, please provide at least one of the following fields/pairs:
|
16
16
|
# 1. postal code
|
17
17
|
# 2. line1 + city + region
|
18
18
|
# 3. line1 + postal code
|
@@ -20,7 +20,7 @@ module AvaTax
|
|
20
20
|
# ### Security Policies
|
21
21
|
#
|
22
22
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
23
|
-
# * This API depends on the following active services
|
23
|
+
# * This API depends on the following active services:*Required* (all): AutoAddress.
|
24
24
|
# @param line1 [String] Line 1
|
25
25
|
# @param line2 [String] Line 2
|
26
26
|
# @param line3 [String] Line 3
|
@@ -45,7 +45,7 @@ module AvaTax
|
|
45
45
|
# ### Security Policies
|
46
46
|
#
|
47
47
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
48
|
-
# * This API depends on the following active services
|
48
|
+
# * This API depends on the following active services:*Required* (all): AutoAddress.
|
49
49
|
# @param model [Object] The address to resolve
|
50
50
|
# @return [Object]
|
51
51
|
def resolve_address_post(model) path = "/api/v2/addresses/resolve"
|
@@ -22,16 +22,6 @@ module AvaTax
|
|
22
22
|
def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
23
23
|
delete(path) end
|
24
24
|
|
25
|
-
# Get audit records by account id and date range.
|
26
|
-
#
|
27
|
-
#
|
28
|
-
# @param accountId [Integer] The ID of the account
|
29
|
-
# @param fromDate [String] Date
|
30
|
-
# @param toDate [String] Date
|
31
|
-
# @return [Object]
|
32
|
-
def get_audit_records(accountId, fromDate, toDate) path = "/api/v2/advancedrules/audits/accounts/#{accountId}/from/#{fromDate}/to/#{toDate}"
|
33
|
-
get(path) end
|
34
|
-
|
35
25
|
# Get the lookup files for a company
|
36
26
|
#
|
37
27
|
#
|
@@ -11,7 +11,7 @@ module AvaTax
|
|
11
11
|
# ### Security Policies
|
12
12
|
#
|
13
13
|
# * This API requires the user role Compliance Root User.
|
14
|
-
# * This API depends on the following active services
|
14
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
15
15
|
# @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
|
16
16
|
# @return [AvaFileFormModel[]]
|
17
17
|
def create_ava_file_forms(model) path = "/api/v2/avafileforms"
|
@@ -24,7 +24,7 @@ module AvaTax
|
|
24
24
|
# ### Security Policies
|
25
25
|
#
|
26
26
|
# * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
|
27
|
-
# * This API depends on the following active services
|
27
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
28
28
|
# @param id [Integer] The ID of the AvaFileForm you wish to delete.
|
29
29
|
# @return [ErrorDetail[]]
|
30
30
|
def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
@@ -37,7 +37,7 @@ module AvaTax
|
|
37
37
|
# ### Security Policies
|
38
38
|
#
|
39
39
|
# * 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.
|
40
|
-
# * This API depends on the following active services
|
40
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
41
41
|
# @param id [Integer] The primary key of this AvaFileForm
|
42
42
|
# @return [Object]
|
43
43
|
def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
@@ -51,7 +51,7 @@ module AvaTax
|
|
51
51
|
# ### Security Policies
|
52
52
|
#
|
53
53
|
# * 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.
|
54
|
-
# * This API depends on the following active services
|
54
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
55
55
|
# @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
|
56
56
|
# @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
57
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -68,7 +68,7 @@ module AvaTax
|
|
68
68
|
# ### Security Policies
|
69
69
|
#
|
70
70
|
# * This API requires the user role Compliance Root User.
|
71
|
-
# * This API depends on the following active services
|
71
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
72
72
|
# @param id [Integer] The ID of the AvaFileForm you wish to update
|
73
73
|
# @param model [Object] The AvaFileForm model you wish to update.
|
74
74
|
# @return [Object]
|
@@ -16,15 +16,15 @@ module AvaTax
|
|
16
16
|
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
|
17
17
|
# your company so that they can be used for tax exemptions.
|
18
18
|
#
|
19
|
-
#
|
20
|
-
# Companies that do not have this storage system set up will
|
21
|
-
# certificate related APIs. To check if this
|
22
|
-
# storage for this company, call `RequestCertificateSetup`.
|
19
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
20
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
21
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
22
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
23
23
|
#
|
24
24
|
# ### Security Policies
|
25
25
|
#
|
26
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
|
27
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
28
28
|
# @param companyId [Integer] The unique ID number of the company that will record certificates
|
29
29
|
# @param customerCode [String] The number of the customer where the request is sent to
|
30
30
|
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
|
@@ -45,15 +45,15 @@ module AvaTax
|
|
45
45
|
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
|
46
46
|
# your company so that they can be used for tax exemptions.
|
47
47
|
#
|
48
|
-
#
|
49
|
-
# Companies that do not have this storage system set up will
|
50
|
-
# certificate related APIs. To check if this
|
51
|
-
# storage for this company, call `RequestCertificateSetup`.
|
48
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
49
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
50
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
51
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
52
52
|
#
|
53
53
|
# ### Security Policies
|
54
54
|
#
|
55
55
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
56
|
-
# * This API depends on the following active services
|
56
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
57
57
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
58
58
|
# @param customerCode [String] The number of the customer where the request is sent to
|
59
59
|
# @param id [Integer] The unique ID number of this CertExpress invitation
|
@@ -75,15 +75,15 @@ module AvaTax
|
|
75
75
|
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
|
76
76
|
# your company so that they can be used for tax exemptions.
|
77
77
|
#
|
78
|
-
#
|
79
|
-
# Companies that do not have this storage system set up will
|
80
|
-
# certificate related APIs. To check if this
|
81
|
-
# storage for this company, call `RequestCertificateSetup`.
|
78
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
79
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
80
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
81
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
82
82
|
#
|
83
83
|
# ### Security Policies
|
84
84
|
#
|
85
85
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
86
|
-
# * This API depends on the following active services
|
86
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
87
87
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
88
88
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
89
89
|
# @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
|
@@ -20,17 +20,17 @@ module AvaTax
|
|
20
20
|
# * A link to the customer that is allowed to use this certificate
|
21
21
|
# * Your tax transaction must contain the correct customer code
|
22
22
|
#
|
23
|
-
#
|
24
|
-
# Companies that do not have this storage system set up will
|
25
|
-
# certificate related APIs. To check if this
|
26
|
-
# storage for this company, call `RequestCertificateSetup`.
|
23
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
24
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
25
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
26
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
27
27
|
#
|
28
28
|
# If the users specified in the certificates do not exist, the API will create the user and link them to the certificate
|
29
29
|
#
|
30
30
|
# ### Security Policies
|
31
31
|
#
|
32
32
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
33
|
-
# * This API depends on the following active services
|
33
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
34
34
|
# @param companyId [Integer] The ID number of the company recording this certificate
|
35
35
|
# @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
|
36
36
|
# @param model [CertificateModel[]] Certificates to be created
|
@@ -49,15 +49,15 @@ module AvaTax
|
|
49
49
|
#
|
50
50
|
# Revoked certificates can no longer be used.
|
51
51
|
#
|
52
|
-
#
|
53
|
-
# Companies that do not have this storage system set up will
|
54
|
-
# certificate related APIs. To check if this
|
55
|
-
# storage for this company, call `RequestCertificateSetup`.
|
52
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
53
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
54
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
55
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
56
56
|
#
|
57
57
|
# ### Security Policies
|
58
58
|
#
|
59
59
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
60
|
-
# * This API depends on the following active services
|
60
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
61
61
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
62
62
|
# @param id [Integer] The unique ID number of this certificate
|
63
63
|
# @return [ErrorDetail[]]
|
@@ -76,15 +76,15 @@ module AvaTax
|
|
76
76
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
77
77
|
# log onto the administrative website for the product you purchased.
|
78
78
|
#
|
79
|
-
#
|
80
|
-
# Companies that do not have this storage system set up will
|
81
|
-
# certificate related APIs. To check if this
|
82
|
-
# storage for this company, call `RequestCertificateSetup`.
|
79
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
80
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
81
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
82
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
83
83
|
#
|
84
84
|
# ### Security Policies
|
85
85
|
#
|
86
86
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
87
|
-
# * This API depends on the following active services
|
87
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
88
88
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
89
89
|
# @param id [Integer] The unique ID number of this certificate
|
90
90
|
# @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
|
@@ -108,15 +108,15 @@ module AvaTax
|
|
108
108
|
# * po_numbers - Retrieves all PO numbers tied to the certificate.
|
109
109
|
# * attributes - Retrieves all attributes applied to the certificate.
|
110
110
|
#
|
111
|
-
#
|
112
|
-
# Companies that do not have this storage system set up will
|
113
|
-
# certificate related APIs. To check if this
|
114
|
-
# storage for this company, call `RequestCertificateSetup`.
|
111
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
112
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
113
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
114
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
115
115
|
#
|
116
116
|
# ### Security Policies
|
117
117
|
#
|
118
118
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
119
|
-
# * This API depends on the following active services
|
119
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
120
120
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
121
121
|
# @param id [Integer] The unique ID number of this certificate
|
122
122
|
# @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.
|
@@ -137,7 +137,7 @@ module AvaTax
|
|
137
137
|
# ### Security Policies
|
138
138
|
#
|
139
139
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
140
|
-
# * This API depends on the following active services
|
140
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
141
141
|
# @param companyId [Integer] The company ID to check
|
142
142
|
# @return [Object]
|
143
143
|
def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
|
@@ -155,15 +155,15 @@ module AvaTax
|
|
155
155
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
156
156
|
# log onto the administrative website for the product you purchased.
|
157
157
|
#
|
158
|
-
#
|
159
|
-
# Companies that do not have this storage system set up will
|
160
|
-
# certificate related APIs. To check if this
|
161
|
-
# storage for this company, call `RequestCertificateSetup`.
|
158
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
159
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
160
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
161
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
162
162
|
#
|
163
163
|
# ### Security Policies
|
164
164
|
#
|
165
165
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
166
|
-
# * This API depends on the following active services
|
166
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
167
167
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
168
168
|
# @param id [Integer] The unique ID number of this certificate
|
169
169
|
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
|
@@ -184,15 +184,15 @@ module AvaTax
|
|
184
184
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
185
185
|
# log onto the administrative website for the product you purchased.
|
186
186
|
#
|
187
|
-
#
|
188
|
-
# Companies that do not have this storage system set up will
|
189
|
-
# certificate related APIs. To check if this
|
190
|
-
# storage for this company, call `RequestCertificateSetup`.
|
187
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
188
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
189
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
190
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
191
191
|
#
|
192
192
|
# ### Security Policies
|
193
193
|
#
|
194
194
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
195
|
-
# * This API depends on the following active services
|
195
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
196
196
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
197
197
|
# @param id [Integer] The unique ID number of this certificate
|
198
198
|
# @param model [Object] The list of customers needed be added to the Certificate for exemption
|
@@ -212,15 +212,15 @@ module AvaTax
|
|
212
212
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
213
213
|
# log onto the administrative website for the product you purchased.
|
214
214
|
#
|
215
|
-
#
|
216
|
-
# Companies that do not have this storage system set up will
|
217
|
-
# certificate related APIs. To check if this
|
218
|
-
# storage for this company, call `RequestCertificateSetup`.
|
215
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
216
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
217
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
218
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
219
219
|
#
|
220
220
|
# ### Security Policies
|
221
221
|
#
|
222
222
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
223
|
-
# * This API depends on the following active services
|
223
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
224
224
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
225
225
|
# @param id [Integer] The unique ID number of this certificate
|
226
226
|
# @return [FetchResult]
|
@@ -239,15 +239,15 @@ module AvaTax
|
|
239
239
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
240
240
|
# log onto the administrative website for the product you purchased.
|
241
241
|
#
|
242
|
-
#
|
243
|
-
# Companies that do not have this storage system set up will
|
244
|
-
# certificate related APIs. To check if this
|
245
|
-
# storage for this company, call `RequestCertificateSetup`.
|
242
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
243
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
244
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
245
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
246
246
|
#
|
247
247
|
# ### Security Policies
|
248
248
|
#
|
249
249
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
250
|
-
# * This API depends on the following active services
|
250
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
251
251
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
252
252
|
# @param id [Integer] The unique ID number of this certificate
|
253
253
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
|
@@ -270,15 +270,15 @@ module AvaTax
|
|
270
270
|
# * po_numbers - Retrieves all PO numbers tied to the certificate.
|
271
271
|
# * attributes - Retrieves all attributes applied to the certificate.
|
272
272
|
#
|
273
|
-
#
|
274
|
-
# Companies that do not have this storage system set up will
|
275
|
-
# certificate related APIs. To check if this
|
276
|
-
# storage for this company, call `RequestCertificateSetup`.
|
273
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
274
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
275
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
276
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
277
277
|
#
|
278
278
|
# ### Security Policies
|
279
279
|
#
|
280
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
|
281
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
282
282
|
# @param companyId [Integer] The ID number of the company to search
|
283
283
|
# @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.
|
284
284
|
# @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
|
@@ -304,7 +304,7 @@ module AvaTax
|
|
304
304
|
# ### Security Policies
|
305
305
|
#
|
306
306
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
307
|
-
# * This API depends on the following active services
|
307
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
308
308
|
# @param companyId [Integer]
|
309
309
|
# @return [Object]
|
310
310
|
def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
|
@@ -322,15 +322,15 @@ module AvaTax
|
|
322
322
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
323
323
|
# log onto the administrative website for the product you purchased.
|
324
324
|
#
|
325
|
-
#
|
326
|
-
# Companies that do not have this storage system set up will
|
327
|
-
# certificate related APIs. To check if this
|
328
|
-
# storage for this company, call `RequestCertificateSetup`.
|
325
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
326
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
327
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
328
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
329
329
|
#
|
330
330
|
# ### Security Policies
|
331
331
|
#
|
332
332
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
333
|
-
# * This API depends on the following active services
|
333
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
334
334
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
335
335
|
# @param id [Integer] The unique ID number of this certificate
|
336
336
|
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
|
@@ -352,15 +352,15 @@ module AvaTax
|
|
352
352
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
353
353
|
# log onto the administrative website for the product you purchased.
|
354
354
|
#
|
355
|
-
#
|
356
|
-
# Companies that do not have this storage system set up will
|
357
|
-
# certificate related APIs. To check if this
|
358
|
-
# storage for this company, call `RequestCertificateSetup`.
|
355
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
356
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
357
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
358
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
359
359
|
#
|
360
360
|
# ### Security Policies
|
361
361
|
#
|
362
362
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
363
|
-
# * This API depends on the following active services
|
363
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
364
364
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
365
365
|
# @param id [Integer] The unique ID number of this certificate
|
366
366
|
# @param model [Object] The list of customers to unlink from this certificate
|
@@ -377,15 +377,15 @@ module AvaTax
|
|
377
377
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
378
378
|
# log onto the administrative website for the product you purchased.
|
379
379
|
#
|
380
|
-
#
|
381
|
-
# Companies that do not have this storage system set up will
|
382
|
-
# certificate related APIs. To check if this
|
383
|
-
# storage for this company, call `RequestCertificateSetup`.
|
380
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
381
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
382
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
383
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
384
384
|
#
|
385
385
|
# ### Security Policies
|
386
386
|
#
|
387
387
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
388
|
-
# * This API depends on the following active services
|
388
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
389
389
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
390
390
|
# @param id [Integer] The unique ID number of this certificate
|
391
391
|
# @param model [Object] The new certificate object that will replace the existing one
|
@@ -405,15 +405,15 @@ module AvaTax
|
|
405
405
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
406
406
|
# log onto the administrative website for the product you purchased.
|
407
407
|
#
|
408
|
-
#
|
409
|
-
# Companies that do not have this storage system set up will
|
410
|
-
# certificate related APIs. To check if this
|
411
|
-
# storage for this company, call `RequestCertificateSetup`.
|
408
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
409
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
410
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
411
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
412
412
|
#
|
413
413
|
# ### Security Policies
|
414
414
|
#
|
415
415
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
416
|
-
# * This API depends on the following active services
|
416
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
417
417
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
418
418
|
# @param id [Integer] The unique ID number of this certificate
|
419
419
|
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
|