avatax 19.12.0 → 20.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +5 -5
  2. data/avatax.gemspec +0 -1
  3. data/lib/avatax/client/accounts.rb +269 -193
  4. data/lib/avatax/client/addresses.rb +60 -60
  5. data/lib/avatax/client/advancedrules.rb +81 -162
  6. data/lib/avatax/client/avafileforms.rb +93 -93
  7. data/lib/avatax/client/batches.rb +247 -188
  8. data/lib/avatax/client/certexpressinvites.rb +106 -106
  9. data/lib/avatax/client/certificates.rb +469 -469
  10. data/lib/avatax/client/companies.rb +400 -398
  11. data/lib/avatax/client/compliance.rb +18 -18
  12. data/lib/avatax/client/contacts.rb +124 -124
  13. data/lib/avatax/client/customers.rb +415 -415
  14. data/lib/avatax/client/datasources.rb +117 -117
  15. data/lib/avatax/client/definitions.rb +1039 -1007
  16. data/lib/avatax/client/distancethresholds.rb +140 -140
  17. data/lib/avatax/client/filingcalendars.rb +23 -508
  18. data/lib/avatax/client/filings.rb +29 -29
  19. data/lib/avatax/client/firmclientlinkages.rb +150 -150
  20. data/lib/avatax/client/free.rb +109 -109
  21. data/lib/avatax/client/fundingrequests.rb +58 -58
  22. data/lib/avatax/client/items.rb +480 -480
  23. data/lib/avatax/client/jurisdictionoverrides.rb +136 -136
  24. data/lib/avatax/client/locations.rb +163 -160
  25. data/lib/avatax/client/multidocument.rb +420 -340
  26. data/lib/avatax/client/nexus.rb +240 -225
  27. data/lib/avatax/client/notifications.rb +84 -84
  28. data/lib/avatax/client/provisioning.rb +55 -55
  29. data/lib/avatax/client/registrar.rb +228 -228
  30. data/lib/avatax/client/reports.rb +109 -109
  31. data/lib/avatax/client/settings.rb +174 -174
  32. data/lib/avatax/client/subscriptions.rb +71 -71
  33. data/lib/avatax/client/taxcodes.rb +138 -138
  34. data/lib/avatax/client/taxcontent.rb +142 -142
  35. data/lib/avatax/client/taxrules.rb +188 -188
  36. data/lib/avatax/client/transactions.rb +899 -854
  37. data/lib/avatax/client/upcs.rb +129 -129
  38. data/lib/avatax/client/users.rb +207 -207
  39. data/lib/avatax/client/utilities.rb +70 -70
  40. data/lib/avatax/connection.rb +3 -3
  41. data/lib/avatax/request.rb +2 -0
  42. data/lib/avatax/version.rb +1 -1
  43. metadata +4 -25
@@ -1,189 +1,248 @@
1
- module AvaTax
2
- class Client
3
- module Batches
4
-
5
-
6
- # Create a new batch
7
- #
8
- # Create one or more new batch objects attached to this company.
9
- #
10
- # Each batch object may have one or more file objects (currently only one file is supported).
11
- #
12
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
13
- # processed as quickly as possible in the order it was received. To check the
14
- # status of a batch, fetch the batch and retrieve the results of the batch
15
- # operation.
16
- #
17
- # Because the batch system processes with a degree of concurrency, and
18
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
19
- # predict when a batch will complete. If high performance processing is
20
- # required, please use the
21
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
22
- #
23
- # The maximum content length of the request body is limited to 28.6 MB. If this limit
24
- # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
25
- # the API is called from a browser). In this situation, please split the request into
26
- # smaller batches.
27
- #
28
- # ### Security Policies
29
- #
30
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
31
- # @param companyId [Integer] The ID of the company that owns this batch.
32
- # @param model [BatchModel[]] The batch you wish to create.
33
- # @return [BatchModel[]]
34
- def create_batches(companyId, model)
35
- path = "/api/v2/companies/#{companyId}/batches"
36
- post(path, model)
37
- end
38
-
39
-
40
- # Delete a single batch
41
- #
42
- # Marks the batch identified by this URL as deleted.
43
- #
44
- # If you attempt to delete a batch that is being processed, you will receive an error message.
45
- # Deleting a batch does not delete any transactions that were created by importing the batch.
46
- #
47
- # Because the batch system processes with a degree of concurrency, and
48
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
49
- # predict when a batch will complete. If high performance processing is
50
- # required, please use the
51
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
52
- #
53
- # ### Security Policies
54
- #
55
- # * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
56
- # @param companyId [Integer] The ID of the company that owns this batch.
57
- # @param id [Integer] The ID of the batch to delete.
58
- # @return [ErrorDetail[]]
59
- def delete_batch(companyId, id)
60
- path = "/api/v2/companies/#{companyId}/batches/#{id}"
61
- delete(path)
62
- end
63
-
64
-
65
- # Download a single batch file
66
- #
67
- # Download a single batch file identified by this URL.
68
- #
69
- # ### Security Policies
70
- #
71
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
72
- # @param companyId [Integer] The ID of the company that owns this batch
73
- # @param batchId [Integer] The ID of the batch object
74
- # @param id [Integer] The primary key of this batch file object
75
- # @return [Object]
76
- def download_batch(companyId, batchId, id)
77
- path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
78
- get(path)
79
- end
80
-
81
-
82
- # Retrieve a single batch
83
- #
84
- # Get the batch object identified by this URL. A batch object is a large
85
- # collection of API calls stored in a compact file.
86
- #
87
- # Use this endpoint to retrieve the results or check the status of a batch.
88
- #
89
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
90
- # processed as quickly as possible in the order it was received. To check the
91
- # status of a batch, fetch the batch and retrieve the results of the batch
92
- # operation.
93
- #
94
- # Because the batch system processes with a degree of concurrency, and
95
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
96
- # predict when a batch will complete. If high performance processing is
97
- # required, please use the
98
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
99
- #
100
- # ### Security Policies
101
- #
102
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
103
- # @param companyId [Integer] The ID of the company that owns this batch
104
- # @param id [Integer] The primary key of this batch
105
- # @return [Object]
106
- def get_batch(companyId, id)
107
- path = "/api/v2/companies/#{companyId}/batches/#{id}"
108
- get(path)
109
- end
110
-
111
-
112
- # Retrieve all batches for this company
113
- #
114
- # List all batch objects attached to the specified company.
115
- #
116
- # A batch object is a large collection of API calls stored in a compact file.
117
- #
118
- # Search for specific objects using the criteria in the `$filter` parameter;
119
- # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
120
- # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
121
- #
122
- # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
123
- # to retrieve the results, or check the status, of an individual batch.
124
- #
125
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
126
- # processed as quickly as possible in the order it was received. To check the
127
- # status of a batch, fetch the batch and retrieve the results of the batch
128
- # operation.
129
- #
130
- # Because the batch system processes with a degree of concurrency, and
131
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
132
- # predict when a batch will complete. If high performance processing is
133
- # required, please use the
134
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
135
- #
136
- # ### Security Policies
137
- #
138
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
139
- # @param companyId [Integer] The ID of the company that owns these batches
140
- # @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
141
- # @param include [String] A comma separated list of additional data to retrieve.
142
- # @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.
143
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
144
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
145
- # @return [FetchResult]
146
- def list_batches_by_company(companyId, options={})
147
- path = "/api/v2/companies/#{companyId}/batches"
148
- get(path, options)
149
- end
150
-
151
-
152
- # Retrieve all batches
153
- #
154
- # Get multiple batch objects across all companies.
155
- #
156
- # A batch object is a large collection of API calls stored in a compact file.
157
- #
158
- # Search for specific objects using the criteria in the `$filter` parameter;
159
- # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
160
- # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
161
- #
162
- # When a batch is created, it is added to the AvaTax Batch Queue and will be
163
- # processed as quickly as possible in the order it was received. To check the
164
- # status of a batch, fetch the batch and retrieve the results of the batch
165
- # operation.
166
- #
167
- # Because the batch system processes with a degree of concurrency, and
168
- # because of batch sizes in the queue vary, AvaTax API is unable to accurately
169
- # predict when a batch will complete. If high performance processing is
170
- # required, please use the
171
- # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
172
- #
173
- # ### Security Policies
174
- #
175
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
176
- # @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
177
- # @param include [String] A comma separated list of additional data to retrieve.
178
- # @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.
179
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
180
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
181
- # @return [FetchResult]
182
- def query_batches(options={})
183
- path = "/api/v2/batches"
184
- get(path, options)
185
- end
186
-
187
- end
188
- end
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)
28
+ path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
29
+ post(path)
30
+ end
31
+
32
+
33
+ # Create a new batch
34
+ #
35
+ # Create one or more new batch objects attached to this company.
36
+ #
37
+ # Each batch object may have one or more file objects (currently only one file is supported).
38
+ #
39
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
40
+ # processed as quickly as possible in the order it was received. To check the
41
+ # status of a batch, fetch the batch and retrieve the results of the batch
42
+ # operation.
43
+ #
44
+ # Because the batch system processes with a degree of concurrency, and
45
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
46
+ # predict when a batch will complete. If high performance processing is
47
+ # required, please use the
48
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
49
+ #
50
+ # The maximum content length of the request body is limited to 28.6 MB. If this limit
51
+ # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
52
+ # the API is called from a browser). In this situation, please split the request into
53
+ # smaller batches.
54
+ #
55
+ # ### Security Policies
56
+ #
57
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
58
+ # @param companyId [Integer] The ID of the company that owns this batch.
59
+ # @param model [BatchModel[]] The batch you wish to create.
60
+ # @return [BatchModel[]]
61
+ def create_batches(companyId, model)
62
+ path = "/api/v2/companies/#{companyId}/batches"
63
+ post(path, model)
64
+ end
65
+
66
+
67
+ # Create a new transaction batch
68
+ #
69
+ # Create a new transaction batch objects attached to this company.
70
+ #
71
+ # When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be
72
+ # processed as quickly as possible in the order it was received. To check the
73
+ # status of a batch, fetch the batch and retrieve the results of the batch
74
+ # operation.
75
+ #
76
+ # Because the batch system processes with a degree of concurrency, and
77
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
78
+ # predict when a batch will complete. If high performance processing is
79
+ # required, please use the
80
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
81
+ #
82
+ # The maximum content length of the request body is limited to 28.6 MB. If this limit
83
+ # is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if
84
+ # the API is called from a browser). In this situation, please split the request into
85
+ # smaller batches.
86
+ #
87
+ # ### Security Policies
88
+ #
89
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
90
+ # @param companyId [Integer] The ID of the company that owns this batch.
91
+ # @param model [Object] The transaction batch you wish to create.
92
+ # @return [Object]
93
+ def create_transaction_batch(companyId, model)
94
+ path = "/api/v2/companies/#{companyId}/batches/transactions"
95
+ post(path, model)
96
+ end
97
+
98
+
99
+ # Delete a single batch
100
+ #
101
+ # Marks the batch identified by this URL as deleted.
102
+ #
103
+ # If you attempt to delete a batch that is being processed, you will receive an error message.
104
+ # Deleting a batch does not delete any transactions that were created by importing the batch.
105
+ #
106
+ # Because the batch system processes with a degree of concurrency, and
107
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
108
+ # predict when a batch will complete. If high performance processing is
109
+ # required, please use the
110
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
111
+ #
112
+ # ### Security Policies
113
+ #
114
+ # * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
115
+ # @param companyId [Integer] The ID of the company that owns this batch.
116
+ # @param id [Integer] The ID of the batch to delete.
117
+ # @return [ErrorDetail[]]
118
+ def delete_batch(companyId, id)
119
+ path = "/api/v2/companies/#{companyId}/batches/#{id}"
120
+ delete(path)
121
+ end
122
+
123
+
124
+ # Download a single batch file
125
+ #
126
+ # Download a single batch file identified by this URL.
127
+ #
128
+ # ### Security Policies
129
+ #
130
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
131
+ # @param companyId [Integer] The ID of the company that owns this batch
132
+ # @param batchId [Integer] The ID of the batch object
133
+ # @param id [Integer] The primary key of this batch file object
134
+ # @return [Object]
135
+ def download_batch(companyId, batchId, id)
136
+ path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
137
+ get(path)
138
+ end
139
+
140
+
141
+ # Retrieve a single batch
142
+ #
143
+ # Get the batch object identified by this URL. A batch object is a large
144
+ # collection of API calls stored in a compact file.
145
+ #
146
+ # Use this endpoint to retrieve the results or check the status of a batch.
147
+ #
148
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
149
+ # processed as quickly as possible in the order it was received. To check the
150
+ # status of a batch, fetch the batch and retrieve the results of the batch
151
+ # operation.
152
+ #
153
+ # Because the batch system processes with a degree of concurrency, and
154
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
155
+ # predict when a batch will complete. If high performance processing is
156
+ # required, please use the
157
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
158
+ #
159
+ # ### Security Policies
160
+ #
161
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
162
+ # @param companyId [Integer] The ID of the company that owns this batch
163
+ # @param id [Integer] The primary key of this batch
164
+ # @return [Object]
165
+ def get_batch(companyId, id)
166
+ path = "/api/v2/companies/#{companyId}/batches/#{id}"
167
+ get(path)
168
+ end
169
+
170
+
171
+ # Retrieve all batches for this company
172
+ #
173
+ # List all batch objects attached to the specified company.
174
+ #
175
+ # A batch object is a large collection of API calls stored in a compact file.
176
+ #
177
+ # Search for specific objects using the criteria in the `$filter` parameter;
178
+ # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
179
+ # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
180
+ #
181
+ # Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)
182
+ # to retrieve the results, or check the status, of an individual batch.
183
+ #
184
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
185
+ # processed as quickly as possible in the order it was received. To check the
186
+ # status of a batch, fetch the batch and retrieve the results of the batch
187
+ # operation.
188
+ #
189
+ # Because the batch system processes with a degree of concurrency, and
190
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
191
+ # predict when a batch will complete. If high performance processing is
192
+ # required, please use the
193
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
194
+ #
195
+ # ### Security Policies
196
+ #
197
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
198
+ # @param companyId [Integer] The ID of the company that owns these batches
199
+ # @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
200
+ # @param include [String] A comma separated list of additional data to retrieve.
201
+ # @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.
202
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
203
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
204
+ # @return [FetchResult]
205
+ def list_batches_by_company(companyId, options={})
206
+ path = "/api/v2/companies/#{companyId}/batches"
207
+ get(path, options)
208
+ end
209
+
210
+
211
+ # Retrieve all batches
212
+ #
213
+ # Get multiple batch objects across all companies.
214
+ #
215
+ # A batch object is a large collection of API calls stored in a compact file.
216
+ #
217
+ # Search for specific objects using the criteria in the `$filter` parameter;
218
+ # full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
219
+ # Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
220
+ #
221
+ # When a batch is created, it is added to the AvaTax Batch Queue and will be
222
+ # processed as quickly as possible in the order it was received. To check the
223
+ # status of a batch, fetch the batch and retrieve the results of the batch
224
+ # operation.
225
+ #
226
+ # Because the batch system processes with a degree of concurrency, and
227
+ # because of batch sizes in the queue vary, AvaTax API is unable to accurately
228
+ # predict when a batch will complete. If high performance processing is
229
+ # required, please use the
230
+ # [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
231
+ #
232
+ # ### Security Policies
233
+ #
234
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
235
+ # @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
236
+ # @param include [String] A comma separated list of additional data to retrieve.
237
+ # @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.
238
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
239
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
240
+ # @return [FetchResult]
241
+ def query_batches(options={})
242
+ path = "/api/v2/batches"
243
+ get(path, options)
244
+ end
245
+
246
+ end
247
+ end
189
248
  end
@@ -1,107 +1,107 @@
1
- module AvaTax
2
- class Client
3
- module CertExpressInvites
4
-
5
-
6
- # Create a CertExpress invitation
7
- #
8
- # Creates an invitation for a customer to self-report certificates using the CertExpress website.
9
- #
10
- # This invitation is delivered by your choice of method, or you can present a hyperlink to the user
11
- # directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where
12
- # they can follow a step-by-step guide to enter information about their exemption certificates. The
13
- # certificates entered will be recorded and automatically linked to their customer record.
14
- #
15
- # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
16
- # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
17
- # your company so that they can be used for tax exemptions.
18
- #
19
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
20
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
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.
28
- # @param companyId [Integer] The unique ID number of the company that will record certificates
29
- # @param customerCode [String] The number of the customer where the request is sent to
30
- # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
31
- # @return [CertExpressInvitationStatusModel[]]
32
- def create_cert_express_invitation(companyId, customerCode, model)
33
- path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
34
- post(path, model)
35
- end
36
-
37
-
38
- # Retrieve a single CertExpress invitation
39
- #
40
- # Retrieve an existing CertExpress invitation sent to a customer.
41
- #
42
- # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
43
- # about their certificates. This step by step guide allows the customer to complete and upload the full
44
- # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
45
- # they will automatically be recorded to your company and linked to the customer record.
46
- #
47
- # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
48
- # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
49
- # your company so that they can be used for tax exemptions.
50
- #
51
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
52
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
53
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
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.
60
- # @param companyId [Integer] The unique ID number of the company that issued this invitation
61
- # @param customerCode [String] The number of the customer where the request is sent to
62
- # @param id [Integer] The unique ID number of this CertExpress invitation
63
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
64
- # @return [Object]
65
- def get_cert_express_invitation(companyId, customerCode, id, options={})
66
- path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
67
- get(path, options)
68
- end
69
-
70
-
71
- # List CertExpress invitations
72
- #
73
- # Retrieve CertExpress invitations sent by this company.
74
- #
75
- # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
76
- # about their certificates. This step by step guide allows the customer to complete and upload the full
77
- # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
78
- # they will automatically be recorded to your company and linked to the customer record.
79
- #
80
- # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
81
- # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
82
- # your company so that they can be used for tax exemptions.
83
- #
84
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
85
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
86
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
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.
93
- # @param companyId [Integer] The unique ID number of the company that issued this invitation
94
- # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
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
96
- # @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.
97
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
98
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
99
- # @return [FetchResult]
100
- def list_cert_express_invitations(companyId, options={})
101
- path = "/api/v2/companies/#{companyId}/certexpressinvites"
102
- get(path, options)
103
- end
104
-
105
- end
106
- end
1
+ module AvaTax
2
+ class Client
3
+ module CertExpressInvites
4
+
5
+
6
+ # Create a CertExpress invitation
7
+ #
8
+ # Creates an invitation for a customer to self-report certificates using the CertExpress website.
9
+ #
10
+ # This invitation is delivered by your choice of method, or you can present a hyperlink to the user
11
+ # directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where
12
+ # they can follow a step-by-step guide to enter information about their exemption certificates. The
13
+ # certificates entered will be recorded and automatically linked to their customer record.
14
+ #
15
+ # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
16
+ # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
17
+ # your company so that they can be used for tax exemptions.
18
+ #
19
+ # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
20
+ # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21
+ # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
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.
28
+ # @param companyId [Integer] The unique ID number of the company that will record certificates
29
+ # @param customerCode [String] The number of the customer where the request is sent to
30
+ # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
31
+ # @return [CertExpressInvitationStatusModel[]]
32
+ def create_cert_express_invitation(companyId, customerCode, model)
33
+ path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
34
+ post(path, model)
35
+ end
36
+
37
+
38
+ # Retrieve a single CertExpress invitation
39
+ #
40
+ # Retrieve an existing CertExpress invitation sent to a customer.
41
+ #
42
+ # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
43
+ # about their certificates. This step by step guide allows the customer to complete and upload the full
44
+ # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
45
+ # they will automatically be recorded to your company and linked to the customer record.
46
+ #
47
+ # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
48
+ # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
49
+ # your company so that they can be used for tax exemptions.
50
+ #
51
+ # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
52
+ # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
53
+ # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
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.
60
+ # @param companyId [Integer] The unique ID number of the company that issued this invitation
61
+ # @param customerCode [String] The number of the customer where the request is sent to
62
+ # @param id [Integer] The unique ID number of this CertExpress invitation
63
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
64
+ # @return [Object]
65
+ def get_cert_express_invitation(companyId, customerCode, id, options={})
66
+ path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
67
+ get(path, options)
68
+ end
69
+
70
+
71
+ # List CertExpress invitations
72
+ #
73
+ # Retrieve CertExpress invitations sent by this company.
74
+ #
75
+ # A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information
76
+ # about their certificates. This step by step guide allows the customer to complete and upload the full
77
+ # certificate in a convenient, friendly web browser experience. When the customer completes their certificates,
78
+ # they will automatically be recorded to your company and linked to the customer record.
79
+ #
80
+ # The [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.
81
+ # Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
82
+ # your company so that they can be used for tax exemptions.
83
+ #
84
+ # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
85
+ # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
86
+ # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
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.
93
+ # @param companyId [Integer] The unique ID number of the company that issued this invitation
94
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
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
96
+ # @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.
97
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
98
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
99
+ # @return [FetchResult]
100
+ def list_cert_express_invitations(companyId, options={})
101
+ path = "/api/v2/companies/#{companyId}/certexpressinvites"
102
+ get(path, options)
103
+ end
104
+
105
+ end
106
+ end
107
107
  end