avatax 20.5.0 → 20.12.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/avatax.gemspec +0 -1
- data/lib/avatax/client/accounts.rb +83 -83
- data/lib/avatax/client/addresses.rb +21 -21
- data/lib/avatax/client/advancedrules.rb +51 -41
- data/lib/avatax/client/avafileforms.rb +41 -41
- data/lib/avatax/client/batches.rb +101 -48
- data/lib/avatax/client/certexpressinvites.rb +39 -39
- data/lib/avatax/client/certificates.rb +163 -163
- data/lib/avatax/client/companies.rb +226 -121
- data/lib/avatax/client/compliance.rb +13 -13
- data/lib/avatax/client/contacts.rb +48 -48
- data/lib/avatax/client/customers.rb +145 -145
- data/lib/avatax/client/datasources.rb +48 -48
- data/lib/avatax/client/definitions.rb +422 -420
- data/lib/avatax/client/distancethresholds.rb +48 -48
- 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 +28 -13
- data/lib/avatax/client/filings.rb +25 -14
- data/lib/avatax/client/firmclientlinkages.rb +69 -69
- data/lib/avatax/client/free.rb +27 -27
- data/lib/avatax/client/fundingrequests.rb +20 -20
- data/lib/avatax/client/items.rb +139 -139
- data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
- data/lib/avatax/client/locations.rb +168 -57
- data/lib/avatax/client/multidocument.rb +98 -78
- data/lib/avatax/client/nexus.rb +104 -104
- data/lib/avatax/client/notices.rb +47 -139
- data/lib/avatax/client/notifications.rb +27 -27
- data/lib/avatax/client/provisioning.rb +20 -20
- data/lib/avatax/client/registrar.rb +76 -76
- data/lib/avatax/client/reports.rb +34 -34
- data/lib/avatax/client/settings.rb +48 -48
- data/lib/avatax/client/subscriptions.rb +27 -27
- data/lib/avatax/client/taxcodes.rb +48 -48
- data/lib/avatax/client/taxcontent.rb +27 -27
- data/lib/avatax/client/taxprofiles.rb +14 -10
- data/lib/avatax/client/taxrules.rb +48 -48
- data/lib/avatax/client/transactions.rb +185 -155
- data/lib/avatax/client/upcs.rb +48 -48
- data/lib/avatax/client/users.rb +62 -62
- data/lib/avatax/client/utilities.rb +27 -27
- data/lib/avatax/connection.rb +2 -2
- data/lib/avatax/version.rb +1 -1
- metadata +3 -16
@@ -1,79 +1,79 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module AvaFileForms
|
4
|
-
|
5
|
-
|
6
|
-
# Create a new AvaFileForm
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module AvaFileForms
|
4
|
+
|
5
|
+
|
6
|
+
# Create a new AvaFileForm
|
7
|
+
#
|
8
8
|
# Create one or more AvaFileForms
|
9
9
|
# A 'AvaFileForm' represents a form supported by our returns team
|
10
10
|
#
|
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
|
-
# @return [AvaFileFormModel[]]
|
17
|
-
def create_ava_file_forms(model) path = "/api/v2/avafileforms"
|
18
|
-
post(path, model) end
|
19
|
-
|
20
|
-
# Delete a single AvaFileForm
|
21
|
-
#
|
16
|
+
# @return [AvaFileFormModel[]]
|
17
|
+
def create_ava_file_forms(model) path = "/api/v2/avafileforms"
|
18
|
+
post(path, model) end
|
19
|
+
|
20
|
+
# Delete a single AvaFileForm
|
21
|
+
#
|
22
22
|
# Marks the existing AvaFileForm object at this URL as deleted.
|
23
23
|
#
|
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
|
-
# @return [ErrorDetail[]]
|
30
|
-
def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
31
|
-
delete(path) end
|
32
|
-
|
33
|
-
# Retrieve a single AvaFileForm
|
34
|
-
#
|
29
|
+
# @return [ErrorDetail[]]
|
30
|
+
def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
31
|
+
delete(path) end
|
32
|
+
|
33
|
+
# Retrieve a single AvaFileForm
|
34
|
+
#
|
35
35
|
# Get the AvaFileForm object identified by this URL.
|
36
36
|
#
|
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
|
-
# @return [Object]
|
43
|
-
def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
44
|
-
get(path) end
|
45
|
-
|
46
|
-
# Retrieve all AvaFileForms
|
47
|
-
#
|
42
|
+
# @return [Object]
|
43
|
+
def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
44
|
+
get(path) end
|
45
|
+
|
46
|
+
# Retrieve all AvaFileForms
|
47
|
+
#
|
48
48
|
# 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/) .
|
49
49
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
50
50
|
#
|
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.
|
58
58
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
59
|
-
# @return [FetchResult]
|
60
|
-
def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
|
61
|
-
get(path, options) end
|
62
|
-
|
63
|
-
# Update a AvaFileForm
|
64
|
-
#
|
59
|
+
# @return [FetchResult]
|
60
|
+
def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
|
61
|
+
get(path, options) end
|
62
|
+
|
63
|
+
# Update a AvaFileForm
|
64
|
+
#
|
65
65
|
# All data from the existing object will be replaced with data in the object you PUT.
|
66
66
|
# 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.
|
67
67
|
#
|
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
|
-
# @return [Object]
|
75
|
-
def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
|
76
|
-
put(path, model) end
|
77
|
-
end
|
78
|
-
end
|
74
|
+
# @return [Object]
|
75
|
+
def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
|
76
|
+
put(path, model) end
|
77
|
+
end
|
78
|
+
end
|
79
79
|
end
|
@@ -1,10 +1,34 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Batches
|
4
|
-
|
5
|
-
|
6
|
-
#
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Batches
|
4
|
+
|
5
|
+
|
6
|
+
# Cancel an in progress batch
|
7
|
+
#
|
8
|
+
# Marks the in progress batch identified by this URL as cancelled.
|
9
|
+
#
|
10
|
+
# Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message.
|
11
|
+
#
|
12
|
+
# Only in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message.
|
13
|
+
# Cancelling an in progress batch does not delete any transactions that were created before the cancellation.
|
14
|
+
#
|
15
|
+
# Because the batch system processes with a degree of concurrency, and
|
16
|
+
# because of batch sizes in the queue vary, AvaTax API is unable to accurately
|
17
|
+
# predict when a batch will complete. If high performance processing is
|
18
|
+
# required, please use the
|
19
|
+
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
20
|
+
#
|
21
|
+
# ### Security Policies
|
22
|
+
#
|
23
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
24
|
+
# @param companyId [Integer] The ID of the company that owns this batch.
|
25
|
+
# @param id [Integer] The ID of the batch to cancel.
|
26
|
+
# @return [Object]
|
27
|
+
def cancel_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
|
28
|
+
post(path) end
|
29
|
+
|
30
|
+
# Create a new batch
|
31
|
+
#
|
8
32
|
# Create one or more new batch objects attached to this company.
|
9
33
|
#
|
10
34
|
# Each batch object may have one or more file objects (currently only one file is supported).
|
@@ -27,15 +51,44 @@ module AvaTax
|
|
27
51
|
#
|
28
52
|
# ### Security Policies
|
29
53
|
#
|
30
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
54
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
31
55
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
32
56
|
# @param model [BatchModel[]] The batch you wish to create.
|
33
|
-
# @return [BatchModel[]]
|
34
|
-
def create_batches(companyId, model) path = "/api/v2/companies/#{companyId}/batches"
|
35
|
-
post(path, model) end
|
36
|
-
|
37
|
-
#
|
38
|
-
#
|
57
|
+
# @return [BatchModel[]]
|
58
|
+
def create_batches(companyId, model) path = "/api/v2/companies/#{companyId}/batches"
|
59
|
+
post(path, model) end
|
60
|
+
|
61
|
+
# Create a new transaction batch
|
62
|
+
#
|
63
|
+
# Create a new transaction batch objects attached to this company.
|
64
|
+
#
|
65
|
+
# When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be
|
66
|
+
# processed as quickly as possible in the order it was received. To check the
|
67
|
+
# status of a batch, fetch the batch and retrieve the results of the batch
|
68
|
+
# operation.
|
69
|
+
#
|
70
|
+
# Because the batch system processes with a degree of concurrency, and
|
71
|
+
# because of batch sizes in the queue vary, AvaTax API is unable to accurately
|
72
|
+
# predict when a batch will complete. If high performance processing is
|
73
|
+
# required, please use the
|
74
|
+
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
75
|
+
#
|
76
|
+
# The maximum content length of the request body is limited to 28.6 MB. If this limit
|
77
|
+
# is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
|
78
|
+
# the API is called from a browser). In this situation, please split the request into
|
79
|
+
# smaller batches.
|
80
|
+
#
|
81
|
+
# ### Security Policies
|
82
|
+
#
|
83
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
84
|
+
# @param companyId [Integer] The ID of the company that owns this batch.
|
85
|
+
# @param model [Object] The transaction batch you wish to create.
|
86
|
+
# @return [Object]
|
87
|
+
def create_transaction_batch(companyId, model) path = "/api/v2/companies/#{companyId}/batches/transactions"
|
88
|
+
post(path, model) end
|
89
|
+
|
90
|
+
# Delete a single batch
|
91
|
+
#
|
39
92
|
# Marks the batch identified by this URL as deleted.
|
40
93
|
#
|
41
94
|
# If you attempt to delete a batch that is being processed, you will receive an error message.
|
@@ -49,29 +102,29 @@ module AvaTax
|
|
49
102
|
#
|
50
103
|
# ### Security Policies
|
51
104
|
#
|
52
|
-
# * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
105
|
+
# * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
|
53
106
|
# @param companyId [Integer] The ID of the company that owns this batch.
|
54
107
|
# @param id [Integer] The ID of the batch to delete.
|
55
|
-
# @return [ErrorDetail[]]
|
56
|
-
def delete_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
57
|
-
delete(path) end
|
58
|
-
|
59
|
-
# Download a single batch file
|
60
|
-
#
|
108
|
+
# @return [ErrorDetail[]]
|
109
|
+
def delete_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
110
|
+
delete(path) end
|
111
|
+
|
112
|
+
# Download a single batch file
|
113
|
+
#
|
61
114
|
# Download a single batch file identified by this URL.
|
62
115
|
#
|
63
116
|
# ### Security Policies
|
64
117
|
#
|
65
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
118
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
66
119
|
# @param companyId [Integer] The ID of the company that owns this batch
|
67
120
|
# @param batchId [Integer] The ID of the batch object
|
68
121
|
# @param id [Integer] The primary key of this batch file object
|
69
|
-
# @return [Object]
|
70
|
-
def download_batch(companyId, batchId, id) path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
|
71
|
-
get(path) end
|
72
|
-
|
73
|
-
# Retrieve a single batch
|
74
|
-
#
|
122
|
+
# @return [Object]
|
123
|
+
def download_batch(companyId, batchId, id) path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
|
124
|
+
get(path) end
|
125
|
+
|
126
|
+
# Retrieve a single batch
|
127
|
+
#
|
75
128
|
# Get the batch object identified by this URL. A batch object is a large
|
76
129
|
# collection of API calls stored in a compact file.
|
77
130
|
#
|
@@ -90,15 +143,15 @@ module AvaTax
|
|
90
143
|
#
|
91
144
|
# ### Security Policies
|
92
145
|
#
|
93
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
146
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
94
147
|
# @param companyId [Integer] The ID of the company that owns this batch
|
95
148
|
# @param id [Integer] The primary key of this batch
|
96
|
-
# @return [Object]
|
97
|
-
def get_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
98
|
-
get(path) end
|
99
|
-
|
100
|
-
# Retrieve all batches for this company
|
101
|
-
#
|
149
|
+
# @return [Object]
|
150
|
+
def get_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
151
|
+
get(path) end
|
152
|
+
|
153
|
+
# Retrieve all batches for this company
|
154
|
+
#
|
102
155
|
# List all batch objects attached to the specified company.
|
103
156
|
#
|
104
157
|
# A batch object is a large collection of API calls stored in a compact file.
|
@@ -123,19 +176,19 @@ module AvaTax
|
|
123
176
|
#
|
124
177
|
# ### Security Policies
|
125
178
|
#
|
126
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
179
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
127
180
|
# @param companyId [Integer] The ID of the company that owns these batches
|
128
181
|
# @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
|
129
182
|
# @param include [String] A comma separated list of additional data to retrieve.
|
130
183
|
# @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.
|
131
184
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
132
185
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
133
|
-
# @return [FetchResult]
|
134
|
-
def list_batches_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/batches"
|
135
|
-
get(path, options) end
|
136
|
-
|
137
|
-
# Retrieve all batches
|
138
|
-
#
|
186
|
+
# @return [FetchResult]
|
187
|
+
def list_batches_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/batches"
|
188
|
+
get(path, options) end
|
189
|
+
|
190
|
+
# Retrieve all batches
|
191
|
+
#
|
139
192
|
# Get multiple batch objects across all companies.
|
140
193
|
#
|
141
194
|
# A batch object is a large collection of API calls stored in a compact file.
|
@@ -157,15 +210,15 @@ module AvaTax
|
|
157
210
|
#
|
158
211
|
# ### Security Policies
|
159
212
|
#
|
160
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
213
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
|
161
214
|
# @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
|
162
215
|
# @param include [String] A comma separated list of additional data to retrieve.
|
163
216
|
# @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.
|
164
217
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
165
218
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
166
|
-
# @return [FetchResult]
|
167
|
-
def query_batches(options={}) path = "/api/v2/batches"
|
168
|
-
get(path, options) end
|
169
|
-
end
|
170
|
-
end
|
219
|
+
# @return [FetchResult]
|
220
|
+
def query_batches(options={}) path = "/api/v2/batches"
|
221
|
+
get(path, options) end
|
222
|
+
end
|
223
|
+
end
|
171
224
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module CertExpressInvites
|
4
|
-
|
5
|
-
|
6
|
-
# Create a CertExpress invitation
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module CertExpressInvites
|
4
|
+
|
5
|
+
|
6
|
+
# Create a CertExpress invitation
|
7
|
+
#
|
8
8
|
# Creates an invitation for a customer to self-report certificates using the CertExpress website.
|
9
9
|
#
|
10
10
|
# This invitation is delivered by your choice of method, or you can present a hyperlink to the user
|
@@ -16,24 +16,24 @@ 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
|
31
|
-
# @return [CertExpressInvitationStatusModel[]]
|
32
|
-
def create_cert_express_invitation(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
|
33
|
-
post(path, model) end
|
34
|
-
|
35
|
-
# Retrieve a single CertExpress invitation
|
36
|
-
#
|
31
|
+
# @return [CertExpressInvitationStatusModel[]]
|
32
|
+
def create_cert_express_invitation(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
|
33
|
+
post(path, model) end
|
34
|
+
|
35
|
+
# Retrieve a single CertExpress invitation
|
36
|
+
#
|
37
37
|
# Retrieve an existing CertExpress invitation sent to a customer.
|
38
38
|
#
|
39
39
|
# A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
|
@@ -45,25 +45,25 @@ 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
|
60
60
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
61
|
-
# @return [Object]
|
62
|
-
def get_cert_express_invitation(companyId, customerCode, id, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
|
63
|
-
get(path, options) end
|
64
|
-
|
65
|
-
# List CertExpress invitations
|
66
|
-
#
|
61
|
+
# @return [Object]
|
62
|
+
def get_cert_express_invitation(companyId, customerCode, id, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
|
63
|
+
get(path, options) end
|
64
|
+
|
65
|
+
# List CertExpress invitations
|
66
|
+
#
|
67
67
|
# Retrieve CertExpress invitations sent by this company.
|
68
68
|
#
|
69
69
|
# A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
|
@@ -75,24 +75,24 @@ 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
|
90
90
|
# @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.
|
91
91
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
92
92
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
93
|
-
# @return [FetchResult]
|
94
|
-
def list_cert_express_invitations(companyId, options={}) path = "/api/v2/companies/#{companyId}/certexpressinvites"
|
95
|
-
get(path, options) end
|
96
|
-
end
|
97
|
-
end
|
93
|
+
# @return [FetchResult]
|
94
|
+
def list_cert_express_invitations(companyId, options={}) path = "/api/v2/companies/#{companyId}/certexpressinvites"
|
95
|
+
get(path, options) end
|
96
|
+
end
|
97
|
+
end
|
98
98
|
end
|