avatax 20.9.0 → 21.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.vs/slnx.sqlite +0 -0
  3. data/lib/avatax/client/accounts.rb +83 -83
  4. data/lib/avatax/client/addresses.rb +21 -21
  5. data/lib/avatax/client/advancedrules.rb +41 -51
  6. data/lib/avatax/client/avafileforms.rb +41 -41
  7. data/lib/avatax/client/batches.rb +62 -62
  8. data/lib/avatax/client/certexpressinvites.rb +39 -39
  9. data/lib/avatax/client/certificates.rb +163 -163
  10. data/lib/avatax/client/companies.rb +157 -156
  11. data/lib/avatax/client/contacts.rb +48 -48
  12. data/lib/avatax/client/customers.rb +145 -145
  13. data/lib/avatax/client/datasources.rb +48 -48
  14. data/lib/avatax/client/definitions.rb +591 -422
  15. data/lib/avatax/client/distancethresholds.rb +48 -48
  16. data/lib/avatax/client/ecms.rb +26 -31
  17. data/lib/avatax/client/ecommercetoken.rb +17 -17
  18. data/lib/avatax/client/errortransactions.rb +27 -15
  19. data/lib/avatax/client/filingcalendars.rb +48 -12
  20. data/lib/avatax/client/filings.rb +23 -21
  21. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  22. data/lib/avatax/client/free.rb +13 -86
  23. data/lib/avatax/client/fundingrequests.rb +20 -20
  24. data/lib/avatax/client/items.rb +255 -137
  25. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  26. data/lib/avatax/client/locations.rb +92 -92
  27. data/lib/avatax/client/multidocument.rb +78 -78
  28. data/lib/avatax/client/nexus.rb +133 -105
  29. data/lib/avatax/client/notices.rb +43 -504
  30. data/lib/avatax/client/notifications.rb +27 -27
  31. data/lib/avatax/client/provisioning.rb +20 -20
  32. data/lib/avatax/client/registrar.rb +85 -75
  33. data/lib/avatax/client/reports.rb +44 -35
  34. data/lib/avatax/client/settings.rb +55 -50
  35. data/lib/avatax/client/subscriptions.rb +27 -27
  36. data/lib/avatax/client/taxcodes.rb +48 -48
  37. data/lib/avatax/client/taxcontent.rb +90 -27
  38. data/lib/avatax/client/taxprofiles.rb +14 -10
  39. data/lib/avatax/client/taxrules.rb +50 -50
  40. data/lib/avatax/client/transactions.rb +155 -155
  41. data/lib/avatax/client/upcs.rb +48 -48
  42. data/lib/avatax/client/users.rb +64 -64
  43. data/lib/avatax/client/utilities.rb +27 -27
  44. data/lib/avatax/configuration.rb +1 -1
  45. data/lib/avatax/request.rb +11 -5
  46. data/lib/avatax/version.rb +1 -1
  47. data/spec/avatax/request_spec.rb +25 -0
  48. metadata +12 -4
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Certificates
4
-
5
-
6
- # Create certificates for this company
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Certificates
4
+
5
+
6
+ # Create certificates for this company
7
+ #
8
8
  # Record one or more certificates document for this company.
9
9
  #
10
10
  # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
@@ -20,26 +20,26 @@ 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
- # 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`.
23
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
24
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
25
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
26
+ # certificate storage for this company, call `RequestCertificateSetup`.
27
27
  #
28
28
  # If the users specified in the certificates do not exist, the API will create the user and link them to the certificate
29
29
  #
30
30
  # ### Security Policies
31
31
  #
32
32
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
33
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
33
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
34
34
  # @param companyId [Integer] The ID number of the company recording this certificate
35
35
  # @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
36
36
  # @param model [CertificateModel[]] Certificates to be created
37
- # @return [CertificateModel[]]
38
- def create_certificates(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/certificates"
39
- post(path, model, options) end
40
-
41
- # Revoke and delete a certificate
42
- #
37
+ # @return [CertificateModel[]]
38
+ def create_certificates(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/certificates"
39
+ post(path, model, options) end
40
+
41
+ # Revoke and delete a certificate
42
+ #
43
43
  # Revoke the certificate identified by this URL, then delete it.
44
44
  #
45
45
  # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
@@ -49,23 +49,23 @@ module AvaTax
49
49
  #
50
50
  # Revoked certificates can no longer be used.
51
51
  #
52
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
53
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
54
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
55
- # storage for this company, call `RequestCertificateSetup`.
52
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
53
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
54
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
55
+ # certificate storage for this company, call `RequestCertificateSetup`.
56
56
  #
57
57
  # ### Security Policies
58
58
  #
59
59
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
60
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
60
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
61
61
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
62
62
  # @param id [Integer] The unique ID number of this certificate
63
- # @return [ErrorDetail[]]
64
- def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
65
- delete(path) end
66
-
67
- # Download an image for this certificate
68
- #
63
+ # @return [ErrorDetail[]]
64
+ def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
65
+ delete(path) end
66
+
67
+ # Download an image for this certificate
68
+ #
69
69
  # Download an image or PDF file for this certificate.
70
70
  #
71
71
  # This API can be used to download either a single-page preview of the certificate or a full PDF document.
@@ -76,25 +76,25 @@ module AvaTax
76
76
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
77
77
  # log onto the administrative website for the product you purchased.
78
78
  #
79
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
80
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
81
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
82
- # storage for this company, call `RequestCertificateSetup`.
79
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
80
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
81
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
82
+ # certificate storage for this company, call `RequestCertificateSetup`.
83
83
  #
84
84
  # ### Security Policies
85
85
  #
86
86
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
87
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
87
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
88
88
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
89
89
  # @param id [Integer] The unique ID number of this certificate
90
90
  # @param page [Integer] If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.
91
91
  # @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
92
- # @return [Object]
93
- def download_certificate_image(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
94
- get(path, options) end
95
-
96
- # Retrieve a single certificate
97
- #
92
+ # @return [Object]
93
+ def download_certificate_image(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
94
+ get(path, options) end
95
+
96
+ # Retrieve a single certificate
97
+ #
98
98
  # Get the current certificate identified by this URL.
99
99
  #
100
100
  # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
@@ -108,24 +108,24 @@ module AvaTax
108
108
  # * po_numbers - Retrieves all PO numbers tied to the certificate.
109
109
  # * attributes - Retrieves all attributes applied to the certificate.
110
110
  #
111
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
112
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
113
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
114
- # storage for this company, call `RequestCertificateSetup`.
111
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
112
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
113
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
114
+ # certificate storage for this company, call `RequestCertificateSetup`.
115
115
  #
116
116
  # ### Security Policies
117
117
  #
118
118
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
119
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
119
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
120
120
  # @param companyId [Integer] The ID number of the company that recorded this certificate
121
121
  # @param id [Integer] The unique ID number of this certificate
122
122
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
123
- # @return [Object]
124
- def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
125
- get(path, options) end
126
-
127
- # Check a company's exemption certificate status.
128
- #
123
+ # @return [Object]
124
+ def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
125
+ get(path, options) end
126
+
127
+ # Check a company's exemption certificate status.
128
+ #
129
129
  # Checks whether this company is configured to use exemption certificates in AvaTax.
130
130
  #
131
131
  # Exemption certificates are tracked through a different auditable data store than the one that
@@ -137,14 +137,14 @@ module AvaTax
137
137
  # ### Security Policies
138
138
  #
139
139
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
140
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
140
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
141
141
  # @param companyId [Integer] The company ID to check
142
- # @return [Object]
143
- def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
144
- get(path) end
145
-
146
- # Link attributes to a certificate
147
- #
142
+ # @return [Object]
143
+ def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
144
+ get(path) end
145
+
146
+ # Link attributes to a certificate
147
+ #
148
148
  # Link one or many attributes to a certificate.
149
149
  #
150
150
  # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
@@ -155,24 +155,24 @@ module AvaTax
155
155
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
156
156
  # log onto the administrative website for the product you purchased.
157
157
  #
158
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
159
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
160
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
161
- # storage for this company, call `RequestCertificateSetup`.
158
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
159
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
160
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
161
+ # certificate storage for this company, call `RequestCertificateSetup`.
162
162
  #
163
163
  # ### Security Policies
164
164
  #
165
165
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
166
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
166
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
167
167
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
168
168
  # @param id [Integer] The unique ID number of this certificate
169
169
  # @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
170
- # @return [FetchResult]
171
- def link_attributes_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
172
- post(path, model) end
173
-
174
- # Link customers to a certificate
175
- #
170
+ # @return [FetchResult]
171
+ def link_attributes_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
172
+ post(path, model) end
173
+
174
+ # Link customers to a certificate
175
+ #
176
176
  # Link one or more customers to an existing certificate.
177
177
  #
178
178
  # Customers and certificates must be linked before a customer can make use of a certificate to obtain
@@ -184,24 +184,24 @@ module AvaTax
184
184
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
185
185
  # log onto the administrative website for the product you purchased.
186
186
  #
187
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
188
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
189
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
190
- # storage for this company, call `RequestCertificateSetup`.
187
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
188
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
189
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
190
+ # certificate storage for this company, call `RequestCertificateSetup`.
191
191
  #
192
192
  # ### Security Policies
193
193
  #
194
194
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
195
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
195
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
196
196
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
197
197
  # @param id [Integer] The unique ID number of this certificate
198
198
  # @param model [Object] The list of customers needed be added to the Certificate for exemption
199
- # @return [FetchResult]
200
- def link_customers_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
201
- post(path, model) end
202
-
203
- # List all attributes applied to this certificate
204
- #
199
+ # @return [FetchResult]
200
+ def link_customers_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
201
+ post(path, model) end
202
+
203
+ # List all attributes applied to this certificate
204
+ #
205
205
  # Retrieve the list of attributes that are linked to this certificate.
206
206
  #
207
207
  # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
@@ -212,23 +212,23 @@ module AvaTax
212
212
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
213
213
  # log onto the administrative website for the product you purchased.
214
214
  #
215
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
216
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
217
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
218
- # storage for this company, call `RequestCertificateSetup`.
215
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
216
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
217
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
218
+ # certificate storage for this company, call `RequestCertificateSetup`.
219
219
  #
220
220
  # ### Security Policies
221
221
  #
222
222
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
223
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
223
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
224
224
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
225
225
  # @param id [Integer] The unique ID number of this certificate
226
- # @return [FetchResult]
227
- def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
228
- get(path) end
229
-
230
- # List customers linked to this certificate
231
- #
226
+ # @return [FetchResult]
227
+ def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
228
+ get(path) end
229
+
230
+ # List customers linked to this certificate
231
+ #
232
232
  # List all customers linked to this certificate.
233
233
  #
234
234
  # Customers must be linked to a certificate in order to make use of its tax exemption features. You
@@ -239,24 +239,24 @@ module AvaTax
239
239
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
240
240
  # log onto the administrative website for the product you purchased.
241
241
  #
242
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
243
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
244
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
245
- # storage for this company, call `RequestCertificateSetup`.
242
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
243
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
244
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
245
+ # certificate storage for this company, call `RequestCertificateSetup`.
246
246
  #
247
247
  # ### Security Policies
248
248
  #
249
249
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
250
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
250
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
251
251
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
252
252
  # @param id [Integer] The unique ID number of this certificate
253
253
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
254
- # @return [FetchResult]
255
- def list_customers_for_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
256
- get(path, options) end
257
-
258
- # List all certificates for a company
259
- #
254
+ # @return [FetchResult]
255
+ def list_customers_for_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
256
+ get(path, options) end
257
+
258
+ # List all certificates for a company
259
+ #
260
260
  # List all certificates recorded by a company
261
261
  #
262
262
  # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
@@ -270,27 +270,27 @@ module AvaTax
270
270
  # * po_numbers - Retrieves all PO numbers tied to the certificate.
271
271
  # * attributes - Retrieves all attributes applied to the certificate.
272
272
  #
273
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
274
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
275
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
276
- # storage for this company, call `RequestCertificateSetup`.
273
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
274
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
275
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
276
+ # certificate storage for this company, call `RequestCertificateSetup`.
277
277
  #
278
278
  # ### Security Policies
279
279
  #
280
280
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
281
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
281
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
282
282
  # @param companyId [Integer] The ID number of the company to search
283
283
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
284
284
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
285
285
  # @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.
286
286
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
287
287
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
288
- # @return [FetchResult]
289
- def query_certificates(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates"
290
- get(path, options) end
291
-
292
- # Request setup of exemption certificates for this company.
293
- #
288
+ # @return [FetchResult]
289
+ def query_certificates(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates"
290
+ get(path, options) end
291
+
292
+ # Request setup of exemption certificates for this company.
293
+ #
294
294
  # Requests the setup of exemption certificates for this company.
295
295
  #
296
296
  # Exemption certificates are tracked through a different auditable data store than the one that
@@ -304,14 +304,14 @@ module AvaTax
304
304
  # ### Security Policies
305
305
  #
306
306
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
307
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
307
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
308
308
  # @param companyId [Integer]
309
- # @return [Object]
310
- def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
311
- post(path) end
312
-
313
- # Unlink attributes from a certificate
314
- #
309
+ # @return [Object]
310
+ def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
311
+ post(path) end
312
+
313
+ # Unlink attributes from a certificate
314
+ #
315
315
  # Unlink one or many attributes from a certificate.
316
316
  #
317
317
  # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
@@ -322,24 +322,24 @@ module AvaTax
322
322
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
323
323
  # log onto the administrative website for the product you purchased.
324
324
  #
325
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
326
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
327
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
328
- # storage for this company, call `RequestCertificateSetup`.
325
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
326
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
327
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
328
+ # certificate storage for this company, call `RequestCertificateSetup`.
329
329
  #
330
330
  # ### Security Policies
331
331
  #
332
332
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
333
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
333
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
334
334
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
335
335
  # @param id [Integer] The unique ID number of this certificate
336
336
  # @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
337
- # @return [FetchResult]
338
- def unlink_attributes_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
339
- post(path, model) end
340
-
341
- # Unlink customers from a certificate
342
- #
337
+ # @return [FetchResult]
338
+ def unlink_attributes_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
339
+ post(path, model) end
340
+
341
+ # Unlink customers from a certificate
342
+ #
343
343
  # Unlinks one or more customers from a certificate.
344
344
  #
345
345
  # Unlinking a certificate from a customer will prevent the certificate from being used to generate
@@ -352,24 +352,24 @@ module AvaTax
352
352
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
353
353
  # log onto the administrative website for the product you purchased.
354
354
  #
355
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
356
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
357
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
358
- # storage for this company, call `RequestCertificateSetup`.
355
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
356
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
357
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
358
+ # certificate storage for this company, call `RequestCertificateSetup`.
359
359
  #
360
360
  # ### Security Policies
361
361
  #
362
362
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
363
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
363
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
364
364
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
365
365
  # @param id [Integer] The unique ID number of this certificate
366
366
  # @param model [Object] The list of customers to unlink from this certificate
367
- # @return [FetchResult]
368
- def unlink_customers_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
369
- post(path, model) end
370
-
371
- # Update a single certificate
372
- #
367
+ # @return [FetchResult]
368
+ def unlink_customers_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
369
+ post(path, model) end
370
+
371
+ # Update a single certificate
372
+ #
373
373
  # Replace the certificate identified by this URL with a new one.
374
374
  #
375
375
  # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
@@ -377,24 +377,24 @@ module AvaTax
377
377
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
378
378
  # log onto the administrative website for the product you purchased.
379
379
  #
380
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
381
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
382
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
383
- # storage for this company, call `RequestCertificateSetup`.
380
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
381
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
382
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
383
+ # certificate storage for this company, call `RequestCertificateSetup`.
384
384
  #
385
385
  # ### Security Policies
386
386
  #
387
387
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
388
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
388
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
389
389
  # @param companyId [Integer] The ID number of the company that recorded this certificate
390
390
  # @param id [Integer] The unique ID number of this certificate
391
391
  # @param model [Object] The new certificate object that will replace the existing one
392
- # @return [Object]
393
- def update_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
394
- put(path, model) end
395
-
396
- # Upload an image or PDF attachment for this certificate
397
- #
392
+ # @return [Object]
393
+ def update_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
394
+ put(path, model) end
395
+
396
+ # Upload an image or PDF attachment for this certificate
397
+ #
398
398
  # Upload an image or PDF attachment for this certificate.
399
399
  #
400
400
  # Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please
@@ -405,21 +405,21 @@ module AvaTax
405
405
  # criteria you specify when you store the certificate. To view or manage your certificates directly, please
406
406
  # log onto the administrative website for the product you purchased.
407
407
  #
408
- # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
409
- # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
410
- # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
411
- # storage for this company, call `RequestCertificateSetup`.
408
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
409
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
410
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
411
+ # certificate storage for this company, call `RequestCertificateSetup`.
412
412
  #
413
413
  # ### Security Policies
414
414
  #
415
415
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
416
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
416
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
417
417
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
418
418
  # @param id [Integer] The unique ID number of this certificate
419
419
  # @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
420
- # @return [String]
421
- def upload_certificate_image(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
422
- post(path) end
423
- end
424
- end
420
+ # @return [String]
421
+ def upload_certificate_image(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
422
+ post(path) end
423
+ end
424
+ end
425
425
  end