avatax 18.1.2 → 18.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/certexpressinvites.rb +12 -6
- data/lib/avatax/client/certificates.rb +88 -26
- data/lib/avatax/client/customers.rb +36 -18
- data/lib/avatax/client/definitions.rb +47 -8
- data/lib/avatax/client/distancethresholds.rb +1 -1
- data/lib/avatax/client/taxcontent.rb +3 -1
- data/lib/avatax/client/transactions.rb +3 -2
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 355cf5ee71fbeb8b960cf1944d959ca8dc81a59d2f1917dc0021b38e939dccc8
|
|
4
|
+
data.tar.gz: f5599aa2d9cf2307f3e09ee6a006e0da035a5fe1681ed50699ab85bf7a07c074
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8a5efe0d12112e77085d9831a02051c65e76786e8d6846249ff0f81b78b28e3ea95935b38e4f98600968a2b5bbf340ebaf419aab30483c44f30a9a3c5d2c3ab2
|
|
7
|
+
data.tar.gz: cec459683d2a5431a1a3b8fe5fe4b442a85c1e8504d74c0ae1d935f27ac01fca5f58dfcbcb792bff883e17f3251fc7ce818ba11a90e3f6d4239fe2dc075a6dc4
|
|
@@ -16,8 +16,10 @@ 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
|
-
#
|
|
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`.
|
|
21
23
|
# @param companyId [Integer] The unique ID number of the company that will record certificates
|
|
22
24
|
# @param customerCode [String] The number of the customer where the request is sent to
|
|
23
25
|
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
|
|
@@ -41,8 +43,10 @@ module AvaTax
|
|
|
41
43
|
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
|
|
42
44
|
# your company so that they can be used for tax exemptions.
|
|
43
45
|
#
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
47
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
48
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
49
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
46
50
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
|
47
51
|
# @param customerCode [String] The number of the customer where the request is sent to
|
|
48
52
|
# @param id [Integer] The unique ID number of this CertExpress invitation
|
|
@@ -67,8 +71,10 @@ module AvaTax
|
|
|
67
71
|
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
|
|
68
72
|
# your company so that they can be used for tax exemptions.
|
|
69
73
|
#
|
|
70
|
-
#
|
|
71
|
-
#
|
|
74
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
75
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
76
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
77
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
72
78
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
|
73
79
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
|
74
80
|
# @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/) .
|
|
@@ -20,8 +20,10 @@ module AvaTax
|
|
|
20
20
|
# * A link to the customer that is allowed to use this certificate
|
|
21
21
|
# * Your tax transaction must contain the correct customer code
|
|
22
22
|
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
23
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
24
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
25
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
26
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
25
27
|
# @param companyId [Integer] The ID number of the company recording this certificate
|
|
26
28
|
# @param model [CertificateModel[]] Certificates to be created
|
|
27
29
|
# @return [CertificateModel[]]
|
|
@@ -42,8 +44,10 @@ module AvaTax
|
|
|
42
44
|
#
|
|
43
45
|
# Revoked certificates can no longer be used.
|
|
44
46
|
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
47
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
48
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
49
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
50
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
47
51
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
48
52
|
# @param id [Integer] The unique ID number of this certificate
|
|
49
53
|
# @return [Object]
|
|
@@ -65,8 +69,10 @@ module AvaTax
|
|
|
65
69
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
66
70
|
# log onto the administrative website for the product you purchased.
|
|
67
71
|
#
|
|
68
|
-
#
|
|
69
|
-
#
|
|
72
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
73
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
74
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
75
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
70
76
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
71
77
|
# @param id [Integer] The unique ID number of this certificate
|
|
72
78
|
# @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
|
|
@@ -93,8 +99,10 @@ module AvaTax
|
|
|
93
99
|
# * PoNumbers - Retrieves all PO numbers tied to the certificate.
|
|
94
100
|
# * Attributes - Retrieves all attributes applied to the certificate.
|
|
95
101
|
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
102
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
103
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
104
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
105
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
98
106
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
|
99
107
|
# @param id [Integer] The unique ID number of this certificate
|
|
100
108
|
# @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. * PoNumbers - Retrieves all PO numbers tied to the certificate. * Attributes - Retrieves all attributes applied to the certificate.
|
|
@@ -105,6 +113,23 @@ module AvaTax
|
|
|
105
113
|
end
|
|
106
114
|
|
|
107
115
|
|
|
116
|
+
# Check a company's exemption certificate status.
|
|
117
|
+
#
|
|
118
|
+
# Checks whether this company is configured to use exemption certificates in AvaTax.
|
|
119
|
+
#
|
|
120
|
+
# Exemption certificates are tracked through a different auditable data store than the one that
|
|
121
|
+
# holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call
|
|
122
|
+
# `GetCertificateSetup` to see if your company is configured to use the exemption certificate
|
|
123
|
+
# document store. To request setup, please call `RequestCertificateSetup` and your company will
|
|
124
|
+
# be configured with data storage in the auditable certificate system.
|
|
125
|
+
# @param companyId [Integer] The company ID to check
|
|
126
|
+
# @return [Object]
|
|
127
|
+
def get_certificate_setup(companyId)
|
|
128
|
+
path = "/api/v2/companies/#{companyId}/certificates/setup"
|
|
129
|
+
get(path)
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
|
|
108
133
|
# Link attributes to a certificate
|
|
109
134
|
#
|
|
110
135
|
# Link one or many attributes to a certificate.
|
|
@@ -117,8 +142,10 @@ module AvaTax
|
|
|
117
142
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
118
143
|
# log onto the administrative website for the product you purchased.
|
|
119
144
|
#
|
|
120
|
-
#
|
|
121
|
-
#
|
|
145
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
146
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
147
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
148
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
122
149
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
123
150
|
# @param id [Integer] The unique ID number of this certificate
|
|
124
151
|
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
|
|
@@ -142,8 +169,10 @@ module AvaTax
|
|
|
142
169
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
143
170
|
# log onto the administrative website for the product you purchased.
|
|
144
171
|
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
172
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
173
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
174
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
175
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
147
176
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
148
177
|
# @param id [Integer] The unique ID number of this certificate
|
|
149
178
|
# @param model [Object] The list of customers needed be added to the Certificate for exemption
|
|
@@ -166,8 +195,10 @@ module AvaTax
|
|
|
166
195
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
167
196
|
# log onto the administrative website for the product you purchased.
|
|
168
197
|
#
|
|
169
|
-
#
|
|
170
|
-
#
|
|
198
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
199
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
200
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
201
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
171
202
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
172
203
|
# @param id [Integer] The unique ID number of this certificate
|
|
173
204
|
# @return [FetchResult]
|
|
@@ -189,8 +220,10 @@ module AvaTax
|
|
|
189
220
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
190
221
|
# log onto the administrative website for the product you purchased.
|
|
191
222
|
#
|
|
192
|
-
#
|
|
193
|
-
#
|
|
223
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
224
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
225
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
226
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
194
227
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
195
228
|
# @param id [Integer] The unique ID number of this certificate
|
|
196
229
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
|
|
@@ -216,8 +249,10 @@ module AvaTax
|
|
|
216
249
|
# * PoNumbers - Retrieves all PO numbers tied to the certificate.
|
|
217
250
|
# * Attributes - Retrieves all attributes applied to the certificate.
|
|
218
251
|
#
|
|
219
|
-
#
|
|
220
|
-
#
|
|
252
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
253
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
254
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
255
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
221
256
|
# @param companyId [Integer] The ID number of the company to search
|
|
222
257
|
# @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. * PoNumbers - Retrieves all PO numbers tied to the certificate. * Attributes - Retrieves all attributes applied to the certificate.
|
|
223
258
|
# @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/) .
|
|
@@ -231,6 +266,25 @@ module AvaTax
|
|
|
231
266
|
end
|
|
232
267
|
|
|
233
268
|
|
|
269
|
+
# Request setup of exemption certificates for this company.
|
|
270
|
+
#
|
|
271
|
+
# Requests the setup of exemption certificates for this company.
|
|
272
|
+
#
|
|
273
|
+
# Exemption certificates are tracked through a different auditable data store than the one that
|
|
274
|
+
# holds AvaTax transactions. To use the AvaTax exemption certificate document store, please call
|
|
275
|
+
# `GetCertificateSetup` to see if your company is configured to use the exemption certificate
|
|
276
|
+
# document store. To request setup, please call `RequestCertificateSetup` and your company will
|
|
277
|
+
# be configured with data storage in the auditable certificate system.
|
|
278
|
+
#
|
|
279
|
+
# This API will return the current status of exemption certificate setup for this company.
|
|
280
|
+
# @param companyId [Integer]
|
|
281
|
+
# @return [Object]
|
|
282
|
+
def request_certificate_setup(companyId)
|
|
283
|
+
path = "/api/v2/companies/#{companyId}/certificates/setup"
|
|
284
|
+
post(path)
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
|
|
234
288
|
# Unlink attributes from a certificate
|
|
235
289
|
#
|
|
236
290
|
# Unlink one or many attributes from a certificate.
|
|
@@ -243,8 +297,10 @@ module AvaTax
|
|
|
243
297
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
244
298
|
# log onto the administrative website for the product you purchased.
|
|
245
299
|
#
|
|
246
|
-
#
|
|
247
|
-
#
|
|
300
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
301
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
302
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
303
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
248
304
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
249
305
|
# @param id [Integer] The unique ID number of this certificate
|
|
250
306
|
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
|
|
@@ -269,8 +325,10 @@ module AvaTax
|
|
|
269
325
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
270
326
|
# log onto the administrative website for the product you purchased.
|
|
271
327
|
#
|
|
272
|
-
#
|
|
273
|
-
#
|
|
328
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
329
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
330
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
331
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
274
332
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
275
333
|
# @param id [Integer] The unique ID number of this certificate
|
|
276
334
|
# @param model [Object] The list of customers to unlink from this certificate
|
|
@@ -290,8 +348,10 @@ module AvaTax
|
|
|
290
348
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
291
349
|
# log onto the administrative website for the product you purchased.
|
|
292
350
|
#
|
|
293
|
-
#
|
|
294
|
-
#
|
|
351
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
352
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
353
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
354
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
295
355
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
|
296
356
|
# @param id [Integer] The unique ID number of this certificate
|
|
297
357
|
# @param model [Object] The new certificate object that will replace the existing one
|
|
@@ -314,8 +374,10 @@ module AvaTax
|
|
|
314
374
|
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
315
375
|
# log onto the administrative website for the product you purchased.
|
|
316
376
|
#
|
|
317
|
-
#
|
|
318
|
-
#
|
|
377
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
378
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
379
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
380
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
319
381
|
# @param companyId [Integer] The unique ID number of the company that recorded this certificate
|
|
320
382
|
# @param id [Integer] The unique ID number of this certificate
|
|
321
383
|
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
|
|
@@ -13,8 +13,10 @@ module AvaTax
|
|
|
13
13
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
|
14
14
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
15
15
|
#
|
|
16
|
-
#
|
|
17
|
-
#
|
|
16
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
17
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
18
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
19
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
18
20
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
19
21
|
# @param model [CustomerModel[]] The list of customer objects to be created
|
|
20
22
|
# @return [CustomerModel[]]
|
|
@@ -34,8 +36,10 @@ module AvaTax
|
|
|
34
36
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
|
35
37
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
36
38
|
#
|
|
37
|
-
#
|
|
38
|
-
#
|
|
39
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
40
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
41
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
42
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
39
43
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
40
44
|
# @param customerCode [String] The unique code representing this customer
|
|
41
45
|
# @return [Object]
|
|
@@ -59,8 +63,10 @@ module AvaTax
|
|
|
59
63
|
#
|
|
60
64
|
# * Certificates - Fetch a list of certificates linked to this customer.
|
|
61
65
|
#
|
|
62
|
-
#
|
|
63
|
-
#
|
|
66
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
67
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
68
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
69
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
64
70
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
65
71
|
# @param customerCode [String] The unique code representing this customer
|
|
66
72
|
# @param include [String] Specify optional additional objects to include in this fetch request
|
|
@@ -81,8 +87,10 @@ module AvaTax
|
|
|
81
87
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
|
82
88
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
83
89
|
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
90
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
91
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
92
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
93
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
86
94
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
87
95
|
# @param customerCode [String] The unique code representing this customer
|
|
88
96
|
# @param model [Object] The list of certificates to link to this customer
|
|
@@ -103,8 +111,10 @@ module AvaTax
|
|
|
103
111
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
|
104
112
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
105
113
|
#
|
|
106
|
-
#
|
|
107
|
-
#
|
|
114
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
115
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
116
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
117
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
108
118
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
109
119
|
# @param customerCode [String] The unique code representing this customer
|
|
110
120
|
# @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. * PoNumbers - Retrieves all PO numbers tied to the certificate. * Attributes - Retrieves all attributes applied to the certificate.
|
|
@@ -132,8 +142,10 @@ module AvaTax
|
|
|
132
142
|
# a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please
|
|
133
143
|
# see the `CreateCertExpressInvitation` API to create an invitation link for this customer.
|
|
134
144
|
#
|
|
135
|
-
#
|
|
136
|
-
#
|
|
145
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
146
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
147
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
148
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
137
149
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
138
150
|
# @param customerCode [String] The unique code representing this customer
|
|
139
151
|
# @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
|
|
@@ -159,8 +171,10 @@ module AvaTax
|
|
|
159
171
|
#
|
|
160
172
|
# * Certificates - Fetch a list of certificates linked to this customer.
|
|
161
173
|
#
|
|
162
|
-
#
|
|
163
|
-
#
|
|
174
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
175
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
176
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
177
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
164
178
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
165
179
|
# @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
|
|
166
180
|
# @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/) .
|
|
@@ -184,8 +198,10 @@ module AvaTax
|
|
|
184
198
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
|
185
199
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
186
200
|
#
|
|
187
|
-
#
|
|
188
|
-
#
|
|
201
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
202
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
203
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
204
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
189
205
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
190
206
|
# @param customerCode [String] The unique code representing this customer
|
|
191
207
|
# @param model [Object] The list of certificates to link to this customer
|
|
@@ -206,8 +222,10 @@ module AvaTax
|
|
|
206
222
|
# identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
|
|
207
223
|
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
208
224
|
#
|
|
209
|
-
#
|
|
210
|
-
#
|
|
225
|
+
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
|
|
226
|
+
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
|
|
227
|
+
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
|
|
228
|
+
# storage for this company, call `RequestCertificateSetup`.
|
|
211
229
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
212
230
|
# @param customerCode [String] The unique code representing this customer
|
|
213
231
|
# @param model [Object] The new customer model that will replace the existing record at this URL
|
|
@@ -66,8 +66,8 @@ module AvaTax
|
|
|
66
66
|
# A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
|
|
67
67
|
# certificate at any time.
|
|
68
68
|
#
|
|
69
|
-
#
|
|
70
|
-
#
|
|
69
|
+
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
|
70
|
+
# check and provision account.
|
|
71
71
|
# @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/) .
|
|
72
72
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
|
73
73
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
|
@@ -86,8 +86,8 @@ module AvaTax
|
|
|
86
86
|
# An exemption reason defines why a certificate allows a customer to be exempt
|
|
87
87
|
# for purposes of tax calculation.
|
|
88
88
|
#
|
|
89
|
-
#
|
|
90
|
-
#
|
|
89
|
+
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
|
90
|
+
# check and provision account.
|
|
91
91
|
# @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/) .
|
|
92
92
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
|
93
93
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
|
@@ -106,8 +106,8 @@ module AvaTax
|
|
|
106
106
|
# An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
|
|
107
107
|
# authority or other legal entity to which a certificate may apply.
|
|
108
108
|
#
|
|
109
|
-
#
|
|
110
|
-
#
|
|
109
|
+
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
|
110
|
+
# check and provision account.
|
|
111
111
|
# @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/) .
|
|
112
112
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
|
113
113
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
|
@@ -189,8 +189,8 @@ module AvaTax
|
|
|
189
189
|
# upload certificates. An invitation allows customers to use CertExpress to upload their exemption
|
|
190
190
|
# certificates directly; this cover letter explains why the invitation was sent.
|
|
191
191
|
#
|
|
192
|
-
#
|
|
193
|
-
#
|
|
192
|
+
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
|
193
|
+
# check and provision account.
|
|
194
194
|
# @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/) .
|
|
195
195
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
|
196
196
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
|
@@ -236,6 +236,23 @@ module AvaTax
|
|
|
236
236
|
end
|
|
237
237
|
|
|
238
238
|
|
|
239
|
+
# List all ISO 4217 currencies supported by AvaTax.
|
|
240
|
+
#
|
|
241
|
+
# Lists all ISO 4217 currencies supported by AvaTax.
|
|
242
|
+
#
|
|
243
|
+
# This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the
|
|
244
|
+
# `currencyCode` field in a `CreateTransactionModel`.
|
|
245
|
+
# @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/) .
|
|
246
|
+
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
|
247
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
|
248
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
249
|
+
# @return [FetchResult]
|
|
250
|
+
def list_currencies(options={})
|
|
251
|
+
path = "/api/v2/definitions/currencies"
|
|
252
|
+
get(path, options)
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
|
|
239
256
|
# Retrieve the full list of Avalara-supported entity use codes
|
|
240
257
|
#
|
|
241
258
|
# Returns the full list of Avalara-supported entity use codes.
|
|
@@ -653,6 +670,28 @@ module AvaTax
|
|
|
653
670
|
end
|
|
654
671
|
|
|
655
672
|
|
|
673
|
+
# List all customs duty programs recognized by AvaTax
|
|
674
|
+
#
|
|
675
|
+
# List all preferred customs duty programs recognized by AvaTax.
|
|
676
|
+
#
|
|
677
|
+
# A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
|
|
678
|
+
# An example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring
|
|
679
|
+
# countries.
|
|
680
|
+
#
|
|
681
|
+
# To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
|
|
682
|
+
# preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
|
|
683
|
+
# the program.
|
|
684
|
+
# @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/) .
|
|
685
|
+
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
|
686
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
|
687
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
688
|
+
# @return [FetchResult]
|
|
689
|
+
def list_preferred_programs(options={})
|
|
690
|
+
path = "/api/v2/definitions/preferredprograms"
|
|
691
|
+
get(path, options)
|
|
692
|
+
end
|
|
693
|
+
|
|
694
|
+
|
|
656
695
|
# Retrieve the full list of rate types for each country
|
|
657
696
|
#
|
|
658
697
|
# Returns the full list of Avalara-supported rate type file types
|
|
@@ -73,7 +73,7 @@ module AvaTax
|
|
|
73
73
|
|
|
74
74
|
# Retrieve all DistanceThreshold objects
|
|
75
75
|
#
|
|
76
|
-
# Lists all DistanceThreshold objects that belong to this
|
|
76
|
+
# Lists all DistanceThreshold objects that belong to this account.
|
|
77
77
|
#
|
|
78
78
|
# A company-distance-threshold model indicates the distance between a company
|
|
79
79
|
# and the taxing borders of various countries. Distance thresholds are necessary
|
|
@@ -63,7 +63,7 @@ module AvaTax
|
|
|
63
63
|
# call the `CreateTransaction` API call. When using this file, your software will be unable to
|
|
64
64
|
# handle complex tax rules such as:
|
|
65
65
|
#
|
|
66
|
-
# * Zip+
|
|
66
|
+
# * Zip+4 - This tax file contains five digit zip codes only.
|
|
67
67
|
# * Different product types - This tax file contains tangible personal property tax rates only.
|
|
68
68
|
# * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes.
|
|
69
69
|
# * Threshold-based taxes - This tax file does not contain information about thresholds.
|
|
@@ -71,6 +71,8 @@ module AvaTax
|
|
|
71
71
|
# If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction`
|
|
72
72
|
# to reconcile the actual transaction and determine the difference between the estimated general tax
|
|
73
73
|
# rate and the final transaction tax.
|
|
74
|
+
#
|
|
75
|
+
# For more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations.
|
|
74
76
|
# @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
|
|
75
77
|
# @return [Object]
|
|
76
78
|
def download_tax_rates_by_zip_code(date)
|
|
@@ -49,11 +49,12 @@ module AvaTax
|
|
|
49
49
|
# no longer available for adjustments.
|
|
50
50
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
|
51
51
|
# @param transactionCode [String] The transaction code to adjust
|
|
52
|
+
# @param documentType [String] (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)
|
|
52
53
|
# @param model [Object] The adjustment you wish to make
|
|
53
54
|
# @return [Object]
|
|
54
|
-
def adjust_transaction(companyCode, transactionCode, model)
|
|
55
|
+
def adjust_transaction(companyCode, transactionCode, model, options={})
|
|
55
56
|
path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
|
|
56
|
-
post(path, model)
|
|
57
|
+
post(path, model, options)
|
|
57
58
|
end
|
|
58
59
|
|
|
59
60
|
|
data/lib/avatax/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: avatax
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 18.
|
|
4
|
+
version: 18.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Marcus Vorwaller
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-
|
|
11
|
+
date: 2018-03-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|