avatax 20.9.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/lib/avatax/client/addresses.rb +3 -3
- 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 +5 -5
- data/lib/avatax/client/customers.rb +61 -61
- data/lib/avatax/client/datasources.rb +6 -6
- data/lib/avatax/client/definitions.rb +3 -3
- data/lib/avatax/client/ecms.rb +26 -31
- data/lib/avatax/client/ecommercetoken.rb +1 -1
- data/lib/avatax/client/errortransactions.rb +27 -15
- data/lib/avatax/client/filingcalendars.rb +15 -0
- data/lib/avatax/client/filings.rb +2 -2
- data/lib/avatax/client/fundingrequests.rb +2 -2
- data/lib/avatax/client/locations.rb +2 -2
- data/lib/avatax/client/multidocument.rb +12 -12
- data/lib/avatax/client/notices.rb +47 -139
- data/lib/avatax/client/taxcontent.rb +2 -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/version.rb +1 -1
- metadata +2 -2
@@ -16,15 +16,15 @@ module AvaTax
|
|
16
16
|
# A nested object such as CustomFields could be specified and created along with the customer object. To fetch the
|
17
17
|
# nested object, please call 'GetCustomer' API with appropriate $include parameters.
|
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 recorded this customer
|
29
29
|
# @param model [CustomerModel[]] The list of customer objects to be created
|
30
30
|
# @return [CustomerModel[]]
|
@@ -41,15 +41,15 @@ module AvaTax
|
|
41
41
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
42
42
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
43
43
|
#
|
44
|
-
#
|
45
|
-
# Companies that do not have this storage system set up will
|
46
|
-
# certificate related APIs. To check if this
|
47
|
-
# storage for this company, call `RequestCertificateSetup`.
|
44
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
45
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
46
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
47
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
48
48
|
#
|
49
49
|
# ### Security Policies
|
50
50
|
#
|
51
51
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
52
|
-
# * This API depends on the following active services
|
52
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
53
53
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
54
54
|
# @param customerCode [String] The unique code representing this customer
|
55
55
|
# @return [Object]
|
@@ -72,15 +72,15 @@ module AvaTax
|
|
72
72
|
# * CustomFields - Fetch a list of custom fields associated to this customer.
|
73
73
|
# * attributes - Retrieves all attributes applied to the customer.
|
74
74
|
#
|
75
|
-
#
|
76
|
-
# Companies that do not have this storage system set up will
|
77
|
-
# certificate related APIs. To check if this
|
78
|
-
# storage for this company, call `RequestCertificateSetup`.
|
75
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
76
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
77
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
78
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
79
79
|
#
|
80
80
|
# ### Security Policies
|
81
81
|
#
|
82
82
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
83
|
-
# * This API depends on the following active services
|
83
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
84
84
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
85
85
|
# @param customerCode [String] The unique code representing this customer
|
86
86
|
# @param include [String] Specify optional additional objects to include in this fetch request
|
@@ -101,15 +101,15 @@ module AvaTax
|
|
101
101
|
# identify any certificates linked to this customer object. If any certificate applies to the transaction,
|
102
102
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
103
103
|
#
|
104
|
-
#
|
105
|
-
# Companies that do not have this storage system set up will
|
106
|
-
# certificate related APIs. To check if this
|
107
|
-
# storage for this company, call `RequestCertificateSetup`.
|
104
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
105
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
106
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
107
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
108
108
|
#
|
109
109
|
# ### Security Policies
|
110
110
|
#
|
111
111
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
112
|
-
# * This API depends on the following active services
|
112
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
113
113
|
# @param companyId [Integer] The unique ID number of the company that recorded the provided customer
|
114
114
|
# @param customerCode [String] The unique code representing the current customer
|
115
115
|
# @param model [CustomerAttributeModel[]] The list of attributes to link to the customer.
|
@@ -127,15 +127,15 @@ module AvaTax
|
|
127
127
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
128
128
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
129
129
|
#
|
130
|
-
#
|
131
|
-
# Companies that do not have this storage system set up will
|
132
|
-
# certificate related APIs. To check if this
|
133
|
-
# storage for this company, call `RequestCertificateSetup`.
|
130
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
131
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
132
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
133
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
134
134
|
#
|
135
135
|
# ### Security Policies
|
136
136
|
#
|
137
137
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
138
|
-
# * This API depends on the following active services
|
138
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
139
139
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
140
140
|
# @param customerCode [String] The unique code representing this customer
|
141
141
|
# @param model [Object] The list of certificates to link to this customer
|
@@ -162,7 +162,7 @@ module AvaTax
|
|
162
162
|
# ### Security Policies
|
163
163
|
#
|
164
164
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
165
|
-
# * This API depends on the following active services
|
165
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
166
166
|
# @param companyId [Integer] The unique ID number of the company defining customers.
|
167
167
|
# @param code [String] The code of the bill-to customer to link.
|
168
168
|
# @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
|
@@ -183,15 +183,15 @@ module AvaTax
|
|
183
183
|
# identify any certificates linked to this customer object. If any certificate applies to the transaction,
|
184
184
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
185
185
|
#
|
186
|
-
#
|
187
|
-
# Companies that do not have this storage system set up will
|
188
|
-
# certificate related APIs. To check if this
|
189
|
-
# storage for this company, call `RequestCertificateSetup`.
|
186
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
187
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
188
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
189
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
190
190
|
#
|
191
191
|
# ### Security Policies
|
192
192
|
#
|
193
193
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
194
|
-
# * This API depends on the following active services
|
194
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
195
195
|
# @param companyId [Integer] The unique ID number of the company that recorded the provided customer
|
196
196
|
# @param customerCode [String] The unique code representing the current customer
|
197
197
|
# @return [FetchResult]
|
@@ -208,15 +208,15 @@ module AvaTax
|
|
208
208
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
209
209
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
210
210
|
#
|
211
|
-
#
|
212
|
-
# Companies that do not have this storage system set up will
|
213
|
-
# certificate related APIs. To check if this
|
214
|
-
# storage for this company, call `RequestCertificateSetup`.
|
211
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
212
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
213
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
214
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
215
215
|
#
|
216
216
|
# ### Security Policies
|
217
217
|
#
|
218
218
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
219
|
-
# * This API depends on the following active services
|
219
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
220
220
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
221
221
|
# @param customerCode [String] The unique code representing this customer
|
222
222
|
# @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.
|
@@ -241,15 +241,15 @@ module AvaTax
|
|
241
241
|
# a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please
|
242
242
|
# see the `CreateCertExpressInvitation` API to create an invitation link for this customer.
|
243
243
|
#
|
244
|
-
#
|
245
|
-
# Companies that do not have this storage system set up will
|
246
|
-
# certificate related APIs. To check if this
|
247
|
-
# storage for this company, call `RequestCertificateSetup`.
|
244
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
245
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
246
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
247
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
248
248
|
#
|
249
249
|
# ### Security Policies
|
250
250
|
#
|
251
251
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
252
|
-
# * This API depends on the following active services
|
252
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
253
253
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
254
254
|
# @param customerCode [String] The unique code representing this customer
|
255
255
|
# @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
|
@@ -273,15 +273,15 @@ module AvaTax
|
|
273
273
|
# * Certificates - Fetch a list of certificates linked to this customer.
|
274
274
|
# * attributes - Retrieves all attributes applied to the customer.
|
275
275
|
#
|
276
|
-
#
|
277
|
-
# Companies that do not have this storage system set up will
|
278
|
-
# certificate related APIs. To check if this
|
279
|
-
# storage for this company, call `RequestCertificateSetup`.
|
276
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
277
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
278
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
279
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
280
280
|
#
|
281
281
|
# ### Security Policies
|
282
282
|
#
|
283
283
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
284
|
-
# * This API depends on the following active services
|
284
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
285
285
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
286
286
|
# @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
|
287
287
|
# @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:* shipTos
|
@@ -305,15 +305,15 @@ module AvaTax
|
|
305
305
|
# identify any certificates linked to this customer object. If any certificate applies to the transaction,
|
306
306
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
307
307
|
#
|
308
|
-
#
|
309
|
-
# Companies that do not have this storage system set up will
|
310
|
-
# certificate related APIs. To check if this
|
311
|
-
# storage for this company, call `RequestCertificateSetup`.
|
308
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
309
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
310
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
311
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
312
312
|
#
|
313
313
|
# ### Security Policies
|
314
314
|
#
|
315
315
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
316
|
-
# * This API depends on the following active services
|
316
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
317
317
|
# @param companyId [Integer] The unique ID number of the company that recorded the customer
|
318
318
|
# @param customerCode [String] The unique code representing the current customer
|
319
319
|
# @param model [CustomerAttributeModel[]] The list of attributes to unlink from the customer.
|
@@ -331,15 +331,15 @@ module AvaTax
|
|
331
331
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
332
332
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
333
333
|
#
|
334
|
-
#
|
335
|
-
# Companies that do not have this storage system set up will
|
336
|
-
# certificate related APIs. To check if this
|
337
|
-
# storage for this company, call `RequestCertificateSetup`.
|
334
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
335
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
336
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
337
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
338
338
|
#
|
339
339
|
# ### Security Policies
|
340
340
|
#
|
341
341
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
342
|
-
# * This API depends on the following active services
|
342
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
343
343
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
344
344
|
# @param customerCode [String] The unique code representing this customer
|
345
345
|
# @param model [Object] The list of certificates to link to this customer
|
@@ -357,15 +357,15 @@ module AvaTax
|
|
357
357
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
358
358
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
359
359
|
#
|
360
|
-
#
|
361
|
-
# Companies that do not have this storage system set up will
|
362
|
-
# certificate related APIs. To check if this
|
363
|
-
# storage for this company, call `RequestCertificateSetup`.
|
360
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
361
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
362
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
363
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
364
364
|
#
|
365
365
|
# ### Security Policies
|
366
366
|
#
|
367
367
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
368
|
-
# * This API depends on the following active services
|
368
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
369
369
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
370
370
|
# @param customerCode [String] The unique code representing this customer
|
371
371
|
# @param model [Object] The new customer model that will replace the existing record at this URL
|
@@ -10,7 +10,7 @@ module AvaTax
|
|
10
10
|
# ### Security Policies
|
11
11
|
#
|
12
12
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
13
|
-
# * This API depends on the following active services
|
13
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
14
14
|
# @param companyId [Integer] The id of the company you which to create the datasources
|
15
15
|
# @param model [DataSourceModel[]]
|
16
16
|
# @return [DataSourceModel[]]
|
@@ -24,7 +24,7 @@ module AvaTax
|
|
24
24
|
# ### Security Policies
|
25
25
|
#
|
26
26
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
27
|
-
# * This API depends on the following active services
|
27
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
28
28
|
# @param companyId [Integer] The id of the company the datasource belongs to.
|
29
29
|
# @param id [Integer] The id of the datasource you wish to delete.
|
30
30
|
# @return [ErrorDetail[]]
|
@@ -38,7 +38,7 @@ module AvaTax
|
|
38
38
|
# ### Security Policies
|
39
39
|
#
|
40
40
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
41
|
-
# * This API depends on the following active services
|
41
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
42
42
|
# @param companyId [Integer]
|
43
43
|
# @param id [Integer] data source id
|
44
44
|
# @return [Object]
|
@@ -52,7 +52,7 @@ module AvaTax
|
|
52
52
|
# ### Security Policies
|
53
53
|
#
|
54
54
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
55
|
-
# * This API depends on the following active services
|
55
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
56
56
|
# @param companyId [Integer] The id of the company you wish to retrieve the datasources.
|
57
57
|
# @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:* isEnabled, isSynced, isAuthorized, name, externalState
|
58
58
|
# @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.
|
@@ -72,7 +72,7 @@ module AvaTax
|
|
72
72
|
# ### Security Policies
|
73
73
|
#
|
74
74
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
75
|
-
# * This API depends on the following active services
|
75
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
76
76
|
# @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:* isEnabled, isSynced, isAuthorized, name, externalState
|
77
77
|
# @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.
|
78
78
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -88,7 +88,7 @@ module AvaTax
|
|
88
88
|
# ### Security Policies
|
89
89
|
#
|
90
90
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
91
|
-
# * This API depends on the following active services
|
91
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
92
92
|
# @param companyId [Integer] The id of the company the datasource belongs to.
|
93
93
|
# @param id [Integer] The id of the datasource you wish to delete.
|
94
94
|
# @param model [Object]
|
@@ -18,7 +18,7 @@ module AvaTax
|
|
18
18
|
#
|
19
19
|
# ### Security Policies
|
20
20
|
#
|
21
|
-
# * This API depends on the following active services
|
21
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
22
22
|
# @param country [String] The name or code of the destination country.
|
23
23
|
# @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
|
24
24
|
# @return [FetchResult]
|
@@ -186,7 +186,7 @@ module AvaTax
|
|
186
186
|
#
|
187
187
|
# ### Security Policies
|
188
188
|
#
|
189
|
-
# * This API depends on the following active services
|
189
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
190
190
|
# @param country [String] The name or code of the destination country.
|
191
191
|
# @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
|
192
192
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength
|
@@ -208,7 +208,7 @@ module AvaTax
|
|
208
208
|
#
|
209
209
|
# ### Security Policies
|
210
210
|
#
|
211
|
-
# * This API depends on the following active services
|
211
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
212
212
|
# @return [FetchResult]
|
213
213
|
def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
|
214
214
|
get(path) end
|
data/lib/avatax/client/ecms.rb
CHANGED
@@ -1,17 +1,6 @@
|
|
1
1
|
module AvaTax
|
2
2
|
class Client
|
3
|
-
module
|
4
|
-
|
5
|
-
|
6
|
-
# Bridge API for integration of validated certificates
|
7
|
-
#
|
8
|
-
# This API is for use by invitation only.
|
9
|
-
# @param model [EcmsModel[]] Either a single exempt certificate or an array of certificates to create
|
10
|
-
# @return [EcmsModel[]]
|
11
|
-
def cert_capture_bridge(model)
|
12
|
-
path = "/api/v2/certcapturebridge"
|
13
|
-
post(path, model)
|
14
|
-
end
|
3
|
+
module Ecms
|
15
4
|
|
16
5
|
|
17
6
|
# Get an ECMS identified by company id and ECMS id
|
@@ -22,15 +11,17 @@ module AvaTax
|
|
22
11
|
# You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
|
23
12
|
#
|
24
13
|
# * Details
|
14
|
+
#
|
15
|
+
# ### Security Policies
|
16
|
+
#
|
17
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
18
|
+
# * This API depends on the following active services<br />*Required* (all): AvaCert.
|
25
19
|
# @param companyId [Integer] company to retrieve exempt certificate for
|
26
20
|
# @param ecmsId [Integer] exempt certificate Id
|
27
21
|
# @param include [String]
|
28
22
|
# @return [Object]
|
29
|
-
def get_e_c_m_s_by_id(companyId, ecmsId, options={})
|
30
|
-
path
|
31
|
-
get(path, options)
|
32
|
-
end
|
33
|
-
|
23
|
+
def get_e_c_m_s_by_id(companyId, ecmsId, options={}) path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
|
24
|
+
get(path, options) end
|
34
25
|
|
35
26
|
# Get list of ECMS data for this company
|
36
27
|
#
|
@@ -40,18 +31,20 @@ module AvaTax
|
|
40
31
|
# You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
|
41
32
|
#
|
42
33
|
# * Details
|
34
|
+
#
|
35
|
+
# ### Security Policies
|
36
|
+
#
|
37
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
38
|
+
# * This API depends on the following active services<br />*Required* (all): AvaCert.
|
43
39
|
# @param companyId [Integer] which company to retrieve certificates from
|
44
|
-
# @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/)
|
40
|
+
# @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:* details
|
45
41
|
# @param include [String]
|
46
42
|
# @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.
|
47
43
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
48
44
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
49
|
-
# @return [
|
50
|
-
def list_e_c_m_s_by_company(companyId, options={})
|
51
|
-
path
|
52
|
-
get(path, options)
|
53
|
-
end
|
54
|
-
|
45
|
+
# @return [FetchResult]
|
46
|
+
def list_e_c_m_s_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/ecms"
|
47
|
+
get(path, options) end
|
55
48
|
|
56
49
|
# Get all exempt certificates
|
57
50
|
#
|
@@ -63,17 +56,19 @@ module AvaTax
|
|
63
56
|
# You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
|
64
57
|
#
|
65
58
|
# * Details
|
66
|
-
#
|
59
|
+
#
|
60
|
+
# ### Security Policies
|
61
|
+
#
|
62
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
63
|
+
# * This API depends on the following active services<br />*Required* (all): AvaCert.
|
64
|
+
# @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:* details
|
67
65
|
# @param include [String]
|
68
66
|
# @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.
|
69
67
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
70
68
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
71
|
-
# @return [
|
72
|
-
def query_e_c_m_s(options={})
|
73
|
-
path
|
74
|
-
get(path, options)
|
75
|
-
end
|
76
|
-
|
69
|
+
# @return [FetchResult]
|
70
|
+
def query_e_c_m_s(options={}) path = "/api/v2/ecms"
|
71
|
+
get(path, options) end
|
77
72
|
end
|
78
73
|
end
|
79
74
|
end
|
@@ -14,7 +14,7 @@ module AvaTax
|
|
14
14
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
15
15
|
# @param companyId [Integer] The company ID that will be issued this certificate.
|
16
16
|
# @param model [Object]
|
17
|
-
# @return [
|
17
|
+
# @return [Object]
|
18
18
|
def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
|
19
19
|
post(path, model) end
|
20
20
|
|
@@ -12,20 +12,35 @@ module AvaTax
|
|
12
12
|
# ### Security Policies
|
13
13
|
#
|
14
14
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
15
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
15
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
|
16
|
+
# @param companyId [Integer] ID number of the company to delete error transactions from.
|
16
17
|
# @param model [Object] The request that contains error transactions to be deleted
|
17
18
|
# @return [Object]
|
18
|
-
def delete_error_transactions(model)
|
19
|
-
path
|
20
|
-
delete(path, model)
|
21
|
-
end
|
19
|
+
def delete_error_transactions(companyId, model) path = "/api/v2/companies/#{companyId}/errortransactions"
|
20
|
+
delete(path, model) end
|
22
21
|
|
22
|
+
# Get a list of error transactions' error codes and its counts
|
23
|
+
#
|
24
|
+
# Get a list of error transactions' error codes and their counts
|
25
|
+
# When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,
|
26
|
+
# those errors with their count can be retrieved by this API.
|
27
|
+
#
|
28
|
+
# ### Security Policies
|
29
|
+
#
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
31
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
|
32
|
+
# @param companyId [Integer] ID number of the company to query from.
|
33
|
+
# @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.
|
34
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
35
|
+
# @return [CappedFetchResult]
|
36
|
+
def list_error_codes(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
|
37
|
+
get(path, options) end
|
23
38
|
|
24
39
|
# Retrieve list of error transactions
|
25
40
|
#
|
26
41
|
# List error transactions attached to this company. Results are dependent on `$filter` if provided.
|
27
42
|
#
|
28
|
-
# This endpoint is limited to returning
|
43
|
+
# This endpoint is limited to returning 1000 error transactions at a time maximum.
|
29
44
|
#
|
30
45
|
# 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/) .
|
31
46
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
@@ -33,18 +48,15 @@ module AvaTax
|
|
33
48
|
# ### Security Policies
|
34
49
|
#
|
35
50
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
36
|
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
37
|
-
# @param
|
38
|
-
# @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, avataxErrorJson, avataxCreateTransactionJson
|
51
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
|
52
|
+
# @param companyId [Integer] The company ID to filter error transactions on.
|
53
|
+
# @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, avataxErrorJson, avataxCreateTransactionJson, expiresAt
|
39
54
|
# @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.
|
40
55
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
41
56
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
42
|
-
# @return [
|
43
|
-
def list_error_transactions(options={})
|
44
|
-
path
|
45
|
-
get(path, options)
|
46
|
-
end
|
47
|
-
|
57
|
+
# @return [CappedFetchResult]
|
58
|
+
def list_error_transactions(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions"
|
59
|
+
get(path, options) end
|
48
60
|
end
|
49
61
|
end
|
50
62
|
end
|