avatax 26.4.0 → 26.6.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/certificates.rb +33 -2
- data/lib/avatax/client/companies.rb +126 -0
- data/lib/avatax/client/customers.rb +1 -1
- data/lib/avatax/client/definitions.rb +38 -28
- data/lib/avatax/client/econexusthreshold.rb +37 -0
- data/lib/avatax/client/formtypemapping.rb +19 -0
- data/lib/avatax/client/items.rb +79 -0
- data/lib/avatax/client/itemsreversesync.rb +82 -0
- data/lib/avatax/client/registrar.rb +1 -1
- data/lib/avatax/client/reports.rb +40 -0
- data/lib/avatax/client/users.rb +8 -8
- data/lib/avatax/client/vendors.rb +51 -1
- data/lib/avatax/version.rb +1 -1
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bb79a9f4603321ed83713aa67ec0e32e37f649d8a13eb5d7a57f5b97c001c55f
|
|
4
|
+
data.tar.gz: fe20a61f2dfcef13b8fe611c40778b3d31933dcbfc7128fb6c4c9ad42b155f72
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2bbc3af857171c4380fd509e5e95f66a8a6c6cc4b0d23757e7dca79e29e48fcb56a72b969918341a987fa59599fc28d399b2163cbc50ede94862bf639fefa7be
|
|
7
|
+
data.tar.gz: d1c3d9e022a9a6c9aaf5c32a7762633b868a9157537f5b7b546831d3aef59813c2ed0c00ee8fdac824ad350b1c2c0190e533c38317bb29df4f36646ded7093e0
|
|
@@ -136,6 +136,7 @@ module AvaTax
|
|
|
136
136
|
# * logs - Retrieves the certificate log
|
|
137
137
|
# * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
|
|
138
138
|
# * custom_fields - Retrieves custom fields set for this certificate
|
|
139
|
+
# * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
|
|
139
140
|
#
|
|
140
141
|
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
141
142
|
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
@@ -149,7 +150,7 @@ module AvaTax
|
|
|
149
150
|
# Swagger Name: AvaTaxClient
|
|
150
151
|
# @param companyId [Integer] The ID number of the company that recorded this certificate
|
|
151
152
|
# @param id [Integer] The unique ID number of this certificate
|
|
152
|
-
# @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
|
|
153
|
+
# @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
|
|
153
154
|
# @return [Object]
|
|
154
155
|
def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
|
155
156
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -309,6 +310,35 @@ module AvaTax
|
|
|
309
310
|
def list_custom_fields_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
|
|
310
311
|
get(path, {}, AvaTax::VERSION) end
|
|
311
312
|
|
|
313
|
+
# List local exempt jurisdictions for a given exposure zone and tax code
|
|
314
|
+
#
|
|
315
|
+
# Returns the list of jurisdictions that are valid for a given combination of exposure zone
|
|
316
|
+
# and exemption tax code. The returned jurisdictions can be used to add valid jurisdictions
|
|
317
|
+
# to a certificate.
|
|
318
|
+
#
|
|
319
|
+
# Both `exposureZone` and `taxCode` are mandatory query parameters.
|
|
320
|
+
#
|
|
321
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
322
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
323
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
324
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
325
|
+
#
|
|
326
|
+
# ### Security Policies
|
|
327
|
+
#
|
|
328
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
329
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
330
|
+
# Swagger Name: AvaTaxClient
|
|
331
|
+
# @param companyId [Integer] The ID number of the company
|
|
332
|
+
# @param exposureZone [String] Required. The exposure zone name used to filter valid jurisdictions (e.g., "California").
|
|
333
|
+
# @param taxCode [String] Required. The exemption tax code used to filter valid jurisdictions (e.g., "RESALE").
|
|
334
|
+
# @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:* region, country, customerUsageType
|
|
335
|
+
# @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.
|
|
336
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
337
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
338
|
+
# @return [FetchResult]
|
|
339
|
+
def list_local_exempt_jurisdictions(companyId, options={}) path = "/api/v2/companies/#{companyId}/jurisdictions"
|
|
340
|
+
get(path, options, AvaTax::VERSION) end
|
|
341
|
+
|
|
312
342
|
# List all certificates for a company
|
|
313
343
|
#
|
|
314
344
|
# List all certificates recorded by a company
|
|
@@ -328,6 +358,7 @@ module AvaTax
|
|
|
328
358
|
# * logs - Retrieves the certificate log
|
|
329
359
|
# * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
|
|
330
360
|
# * custom_fields - Retrieves custom fields set for this certificate
|
|
361
|
+
# * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
|
|
331
362
|
#
|
|
332
363
|
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
333
364
|
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
@@ -340,7 +371,7 @@ module AvaTax
|
|
|
340
371
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
341
372
|
# Swagger Name: AvaTaxClient
|
|
342
373
|
# @param companyId [Integer] The ID number of the company to search
|
|
343
|
-
# @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
|
|
374
|
+
# @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
|
|
344
375
|
# @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, ecmsId, ecmsStatus, pdf, pages
|
|
345
376
|
# @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.
|
|
346
377
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -155,6 +155,24 @@ module AvaTax
|
|
|
155
155
|
def create_funding_request(id, model, options={}) path = "/api/v2/companies/#{id}/funding/setup"
|
|
156
156
|
post(path, model, options, AvaTax::VERSION) end
|
|
157
157
|
|
|
158
|
+
# Create VAT Numbers for a company
|
|
159
|
+
#
|
|
160
|
+
# Create one or more VAT number records for a company.
|
|
161
|
+
# Each record is validated synchronously against the ELR / Directory Search service
|
|
162
|
+
# (which proxies VIES). The response includes validation results:
|
|
163
|
+
# `vatNumberStatus`, `registeredBusinessName`, `businessNameStatus`, `validationDate`,
|
|
164
|
+
# and `validationSource`.
|
|
165
|
+
#
|
|
166
|
+
# ### Security Policies
|
|
167
|
+
#
|
|
168
|
+
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
|
169
|
+
# Swagger Name: AvaTaxClient
|
|
170
|
+
# @param companyId [Integer] The ID of the company that owns these VAT numbers
|
|
171
|
+
# @param model [CustomerVatNumberModel[]] The VAT number records you wish to create
|
|
172
|
+
# @return [CustomerVatNumberModel[]]
|
|
173
|
+
def create_vat_numbers(companyId, model) path = "/api/v2/companies/#{companyId}/vatnumbers"
|
|
174
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
175
|
+
|
|
158
176
|
# Delete a single company
|
|
159
177
|
#
|
|
160
178
|
# Deleting a company will delete all child companies, and all users attached to this company.
|
|
@@ -187,6 +205,20 @@ module AvaTax
|
|
|
187
205
|
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
|
188
206
|
delete(path, {}, AvaTax::VERSION) end
|
|
189
207
|
|
|
208
|
+
# Delete a single VAT Number
|
|
209
|
+
#
|
|
210
|
+
# Marks the VAT number record identified by this URL as deleted.
|
|
211
|
+
#
|
|
212
|
+
# ### Security Policies
|
|
213
|
+
#
|
|
214
|
+
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
|
215
|
+
# Swagger Name: AvaTaxClient
|
|
216
|
+
# @param companyId [Integer] The ID of the company that owns this VAT number
|
|
217
|
+
# @param id [Integer] The unique ID of the VAT number record to delete
|
|
218
|
+
# @return [ErrorDetail[]]
|
|
219
|
+
def delete_vat_number(companyId, id) path = "/api/v2/companies/#{companyId}/vatnumbers/#{id}"
|
|
220
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
221
|
+
|
|
190
222
|
# Check the funding configuration of a company
|
|
191
223
|
#
|
|
192
224
|
# This API is available by invitation only.
|
|
@@ -336,6 +368,20 @@ module AvaTax
|
|
|
336
368
|
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
|
337
369
|
get(path, {}, AvaTax::VERSION) end
|
|
338
370
|
|
|
371
|
+
# Retrieve a single VAT Number
|
|
372
|
+
#
|
|
373
|
+
# Retrieve a single VAT Number record by its unique ID.
|
|
374
|
+
#
|
|
375
|
+
# ### Security Policies
|
|
376
|
+
#
|
|
377
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
378
|
+
# Swagger Name: AvaTaxClient
|
|
379
|
+
# @param companyId [Integer] The ID of the company that owns this VAT number
|
|
380
|
+
# @param id [Integer] The unique ID of the VAT number record
|
|
381
|
+
# @return [Object]
|
|
382
|
+
def get_vat_number(companyId, id) path = "/api/v2/companies/#{companyId}/vatnumbers/#{id}"
|
|
383
|
+
get(path, {}, AvaTax::VERSION) end
|
|
384
|
+
|
|
339
385
|
# Get ACH entry detail report for company and period
|
|
340
386
|
#
|
|
341
387
|
# This API is available by invitation only.
|
|
@@ -412,6 +458,42 @@ module AvaTax
|
|
|
412
458
|
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
|
413
459
|
get(path, {}, AvaTax::VERSION) end
|
|
414
460
|
|
|
461
|
+
# Retrieve VAT Numbers for a company
|
|
462
|
+
#
|
|
463
|
+
# Retrieve all VAT Numbers associated with this company.
|
|
464
|
+
#
|
|
465
|
+
# A VAT Number represents a customer's VAT identification number that has been validated
|
|
466
|
+
# against VIES (VAT Information Exchange System).
|
|
467
|
+
#
|
|
468
|
+
# Search for specific records using the `$filter` parameter. Supported filters include:
|
|
469
|
+
# * `vatNumber` - Filter by VAT number
|
|
470
|
+
# * `country` - Filter by country code (e.g., "GB", "DE")
|
|
471
|
+
# * `vatNumberStatus` - Filter by VAT number validation status (0=NotValidated, 1=Valid, 2=Invalid, 3=Error)
|
|
472
|
+
# * `businessNameStatus` - Filter by business name comparison status (0=NotValidated, 1=Valid, 2=Invalid, 3=Error)
|
|
473
|
+
# * `businessName` - Filter by business name
|
|
474
|
+
# * `validationSource` - Filter by validation source ('VIES' or 'ELR')
|
|
475
|
+
# * `validationDate` - Filter by last validation timestamp (e.g., `validationDate gt 2026-01-01`)
|
|
476
|
+
# * `createdDate` - Filter by record creation timestamp (e.g., `createdDate ge 2026-01-01`)
|
|
477
|
+
# * `modifiedDate` - Filter by record modification timestamp (e.g., `modifiedDate gt 2026-05-01T00:00:00Z`)
|
|
478
|
+
#
|
|
479
|
+
# Order results using `$orderBy`. Common orderings:
|
|
480
|
+
# * `vatNumber ASC` - Order by VAT number ascending
|
|
481
|
+
# * `validationDate DESC` - Order by most recently validated first
|
|
482
|
+
# * `modifiedDate DESC` - Order by most recently modified first
|
|
483
|
+
#
|
|
484
|
+
# ### Security Policies
|
|
485
|
+
#
|
|
486
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
487
|
+
# Swagger Name: AvaTaxClient
|
|
488
|
+
# @param companyId [Integer] The ID of the company
|
|
489
|
+
# @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/).
|
|
490
|
+
# @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.
|
|
491
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
492
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
493
|
+
# @return [FetchResult]
|
|
494
|
+
def list_vat_numbers(companyId, options={}) path = "/api/v2/companies/#{companyId}/vatnumbers"
|
|
495
|
+
get(path, options, AvaTax::VERSION) end
|
|
496
|
+
|
|
415
497
|
# Retrieve all companies
|
|
416
498
|
#
|
|
417
499
|
# Get multiple company objects.
|
|
@@ -514,6 +596,50 @@ module AvaTax
|
|
|
514
596
|
# @return [Object]
|
|
515
597
|
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
|
516
598
|
put(path, model, {}, AvaTax::VERSION) end
|
|
599
|
+
|
|
600
|
+
# Update a single VAT Number
|
|
601
|
+
#
|
|
602
|
+
# Replace the existing VAT number record with the data in the object you PUT.
|
|
603
|
+
#
|
|
604
|
+
# Only `vatNumber`, `businessName`, and `country` fields can be updated. The
|
|
605
|
+
# validation-related fields (`vatNumberStatus`, `registeredBusinessName`,
|
|
606
|
+
# `businessNameStatus`, `validationDate`, `validationSource`) are managed by the
|
|
607
|
+
# system and are refreshed automatically: every successful PUT re-triggers a
|
|
608
|
+
# synchronous VAT validation against the ELR / Directory Search service (which
|
|
609
|
+
# proxies VIES). This makes "Fix" flows work as expected — correcting an
|
|
610
|
+
# invalid VAT number immediately updates its status.
|
|
611
|
+
#
|
|
612
|
+
# ### Security Policies
|
|
613
|
+
#
|
|
614
|
+
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
|
615
|
+
# Swagger Name: AvaTaxClient
|
|
616
|
+
# @param companyId [Integer] The ID of the company that owns this VAT number
|
|
617
|
+
# @param id [Integer] The unique ID of the VAT number record to update
|
|
618
|
+
# @param model [Object] The VAT number object you wish to update
|
|
619
|
+
# @return [Object]
|
|
620
|
+
def update_vat_number(companyId, id, model) path = "/api/v2/companies/#{companyId}/vatnumbers/#{id}"
|
|
621
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
622
|
+
|
|
623
|
+
# Validate a VAT Number without storing it
|
|
624
|
+
#
|
|
625
|
+
# Performs a synchronous VAT number validation against the ELR / Directory Search service
|
|
626
|
+
# (which proxies VIES) without persisting any record in the `CustomerVatNumber` table.
|
|
627
|
+
#
|
|
628
|
+
# This is useful for UI flows that allow the user to "test" a VAT number before
|
|
629
|
+
# deciding whether to add it. The response payload mirrors the shape returned by
|
|
630
|
+
# the create/update endpoints, but `id`, `createdDate`, and `modifiedDate` are not set.
|
|
631
|
+
# Business-name comparison is not performed here; use the create endpoint to persist
|
|
632
|
+
# and obtain a `businessNameStatus`.
|
|
633
|
+
#
|
|
634
|
+
# ### Security Policies
|
|
635
|
+
#
|
|
636
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
637
|
+
# Swagger Name: AvaTaxClient
|
|
638
|
+
# @param companyId [Integer] The ID of the company on whose behalf the validation is performed
|
|
639
|
+
# @param model [Object] The VAT number to validate (vatNumber, country)
|
|
640
|
+
# @return [Object]
|
|
641
|
+
def validate_vat_number(companyId, model) path = "/api/v2/companies/#{companyId}/vatnumbers/validate"
|
|
642
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
517
643
|
end
|
|
518
644
|
end
|
|
519
645
|
end
|
|
@@ -275,7 +275,7 @@ module AvaTax
|
|
|
275
275
|
# Swagger Name: AvaTaxClient
|
|
276
276
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
|
277
277
|
# @param customerCode [String] The unique code representing this customer
|
|
278
|
-
# @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
|
|
278
|
+
# @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
|
|
279
279
|
# @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, ecmsId, ecmsStatus, pdf, pages
|
|
280
280
|
# @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.
|
|
281
281
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -26,20 +26,6 @@ module AvaTax
|
|
|
26
26
|
def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
|
|
27
27
|
get(path, {}, AvaTax::VERSION) end
|
|
28
28
|
|
|
29
|
-
# Test whether a form supports online login verification
|
|
30
|
-
#
|
|
31
|
-
# This API is intended to be useful to identify whether the user should be allowed
|
|
32
|
-
# to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
|
|
33
|
-
# Swagger Name: AvaTaxClient
|
|
34
|
-
# @param form [String] The name of the form you would like to verify. This is the tax form code
|
|
35
|
-
# @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
|
|
36
|
-
# @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.
|
|
37
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
38
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
39
|
-
# @return [FetchResult]
|
|
40
|
-
def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
|
|
41
|
-
get(path, options, AvaTax::VERSION) end
|
|
42
|
-
|
|
43
29
|
# List all market place locations.
|
|
44
30
|
#
|
|
45
31
|
# List all market place locations.
|
|
@@ -323,6 +309,16 @@ module AvaTax
|
|
|
323
309
|
def list_item_h_s_code_classification_status() path = "/api/v2/definitions/items/hscode-classification-status"
|
|
324
310
|
get(path, {}, AvaTax::VERSION) end
|
|
325
311
|
|
|
312
|
+
# List of all event types that can be subscribed to for Item reverse sync webhook registrations.
|
|
313
|
+
#
|
|
314
|
+
# ### Security Policies
|
|
315
|
+
#
|
|
316
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
317
|
+
# Swagger Name: AvaTaxClient
|
|
318
|
+
# @return [ItemReverseSyncEventDefinitionOutputModel[]]
|
|
319
|
+
def list_item_reverse_sync_events() path = "/api/v2/definitions/items/events"
|
|
320
|
+
get(path, {}, AvaTax::VERSION) end
|
|
321
|
+
|
|
326
322
|
# List of all recommendation status which can be assigned to an item
|
|
327
323
|
#
|
|
328
324
|
# ### Security Policies
|
|
@@ -356,6 +352,7 @@ module AvaTax
|
|
|
356
352
|
# @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.
|
|
357
353
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
358
354
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
355
|
+
# @param companyId [Integer] Optional query parameter; when set, the result set is restricted to jurisdictions in regions where the company has nexus. When omitted, all jurisdiction rows are eligible before filter is applied.
|
|
359
356
|
# @return [FetchResult]
|
|
360
357
|
def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
|
|
361
358
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -426,6 +423,33 @@ module AvaTax
|
|
|
426
423
|
def list_jurisdictions_hierarchy(options={}) path = "/api/v2/definitions/jurisdictions/hierarchy"
|
|
427
424
|
get(path, options, AvaTax::VERSION) end
|
|
428
425
|
|
|
426
|
+
# List tax types, subtypes, and rate types applicable for a given jurisdiction
|
|
427
|
+
#
|
|
428
|
+
# Returns a list of tax type and subtype groups, and optionally the available rate types for each group, applicable for a given jurisdiction.
|
|
429
|
+
#
|
|
430
|
+
# This API lets you filter tax types and rate types based on whether they may apply in a given jurisdiction and provides a description of each.
|
|
431
|
+
#
|
|
432
|
+
# If a company ID is provided, then only the tax types for which the company has nexus are shown.
|
|
433
|
+
#
|
|
434
|
+
# If custom content is included, then all available custom tax types are included in the result if the calling user has the appropriate subscription
|
|
435
|
+
# and the tax types are available in the jurisdiction's country.
|
|
436
|
+
# Swagger Name: AvaTaxClient
|
|
437
|
+
# @param country [String] ISO country code (e.g. `US`)
|
|
438
|
+
# @param region [String] ISO region or state/province code (e.g. `CA` for California)
|
|
439
|
+
# @param jurisdictionTypeId [String] Jurisdiction type identifier (e.g. `STA` for state)
|
|
440
|
+
# @param jurisdictionCode [String] Code identifying a specific jurisdiction
|
|
441
|
+
# @param companyId [Integer] Optional query parameter. When set, tax type/subtype pairs are filtered to those which correspond to the company's configured nexus. When omitted, no nexus-based filtering is applied.
|
|
442
|
+
# @param effectiveDate [DateTime] Optional query parameter. When companyId is not provided, this is the date used to filter effective tax types and rate types. Defaults to the current date.
|
|
443
|
+
# @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.
|
|
444
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
445
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
446
|
+
# @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:* rateTypes
|
|
447
|
+
# @param includeCustomContent [Boolean] When true, merges in potentially applicable custom tax types and subtypes into result (i.e. for which no system content is defined). Defaults to false.
|
|
448
|
+
# @param includeRateTypes [Boolean] Query parameter `$includeRateTypes`. When true (default), returns the rate types available for each tax type + subtype pair in the result.
|
|
449
|
+
# @return [FetchResult]
|
|
450
|
+
def list_jurisdiction_tax_types_and_sub_types(country, region, jurisdictionTypeId, jurisdictionCode, options={}) path = "/api/v2/definitions/jurisdictions/#{country}/#{region}/#{jurisdictionTypeId}/#{jurisdictionCode}/taxTypesAndSubTypes"
|
|
451
|
+
get(path, options, AvaTax::VERSION) end
|
|
452
|
+
|
|
429
453
|
# List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
|
|
430
454
|
#
|
|
431
455
|
# Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId
|
|
@@ -465,20 +489,6 @@ module AvaTax
|
|
|
465
489
|
def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
|
|
466
490
|
get(path, options, AvaTax::VERSION) end
|
|
467
491
|
|
|
468
|
-
# List all forms where logins can be verified automatically
|
|
469
|
-
#
|
|
470
|
-
# List all forms where logins can be verified automatically.
|
|
471
|
-
# This API is intended to be useful to identify whether the user should be allowed
|
|
472
|
-
# to automatically verify their login and password.
|
|
473
|
-
# Swagger Name: AvaTaxClient
|
|
474
|
-
# @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
|
|
475
|
-
# @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.
|
|
476
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
477
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
478
|
-
# @return [FetchResult]
|
|
479
|
-
def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
|
|
480
|
-
get(path, options, AvaTax::VERSION) end
|
|
481
|
-
|
|
482
492
|
# Retrieve the list of locations for a marketplace.
|
|
483
493
|
#
|
|
484
494
|
# Retrieves the list of suggested locations for a marketplace.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
module AvaTax
|
|
2
|
+
class Client
|
|
3
|
+
module EcoNexusThreshold
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
# List economic nexus threshold statuses for a company
|
|
7
|
+
#
|
|
8
|
+
# Returns precomputed economic nexus threshold statuses for a company, sourced from a cache
|
|
9
|
+
# refreshed weekly from Snowflake.
|
|
10
|
+
#
|
|
11
|
+
# When the optional `region` query parameter is provided, only the matching jurisdiction row is included in `states`.
|
|
12
|
+
# If no row exists for that company and region, `states` is an empty array (still 200 OK).
|
|
13
|
+
#
|
|
14
|
+
# TPS currently binds this filter as query parameter `state`; use the same value. If the public contract standardizes on `region`,
|
|
15
|
+
# TPS or api-gateway should accept or rewrite `region` so filtering still applies.
|
|
16
|
+
#
|
|
17
|
+
# Production traffic is served by TPS; api-gateway should route this path to TPS.
|
|
18
|
+
#
|
|
19
|
+
# This endpoint requires the `NexusFetch` permission. If EcoNexus is not configured in TPS or the cache has not loaded, TPS returns 503.
|
|
20
|
+
#
|
|
21
|
+
# ### Security Policies
|
|
22
|
+
#
|
|
23
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
24
|
+
# Swagger Name: AvaTaxClient
|
|
25
|
+
# @param companyId [Integer] The Avalara company identifier.
|
|
26
|
+
# @param region [String] Optional two-letter US state/region postal code (case-insensitive), same meaning as the `state` column in the data store. When provided, `states` contains at most one item; if there is no data for that company and region, `states` is an empty array (200 OK).
|
|
27
|
+
# @param include [String] Standard Avalara `$include` query option (see other v2 list APIs).
|
|
28
|
+
# @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/).
|
|
29
|
+
# @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.
|
|
30
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
31
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
32
|
+
# @return [Object]
|
|
33
|
+
def get_eco_nexus_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/econexusthresholds"
|
|
34
|
+
get(path, options, AvaTax::VERSION) end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
module AvaTax
|
|
2
|
+
class Client
|
|
3
|
+
module FormTypeMapping
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
# Resolves a form type to an extraction task identifier.
|
|
7
|
+
#
|
|
8
|
+
# ### Security Policies
|
|
9
|
+
#
|
|
10
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
11
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
12
|
+
# Swagger Name: AvaTaxClient
|
|
13
|
+
# @param form_type [String] The form type to resolve (e.g., "W-9").
|
|
14
|
+
# @return [Object]
|
|
15
|
+
def resolve_form_type_task(options={}) path = "/api/v2/form-type-mappings/resolve-task"
|
|
16
|
+
get(path, options, AvaTax::VERSION) end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
data/lib/avatax/client/items.rb
CHANGED
|
@@ -237,6 +237,25 @@ module AvaTax
|
|
|
237
237
|
def create_item_tags(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
|
|
238
238
|
post(path, model, {}, AvaTax::VERSION) end
|
|
239
239
|
|
|
240
|
+
# Creates a batch to generate tax code recommendations asynchronously.
|
|
241
|
+
#
|
|
242
|
+
# Creates a new batch for asynchronous tax code recommendations processing.
|
|
243
|
+
# The batch is processed asynchronously, and you can check the status using the GetBatchTaxCodeRecommendations endpoint.
|
|
244
|
+
#
|
|
245
|
+
# Maximum items created per request: 2,000 (subject to change).
|
|
246
|
+
#
|
|
247
|
+
# Batches are automatically deleted after 1 day.
|
|
248
|
+
#
|
|
249
|
+
# ### Security Policies
|
|
250
|
+
#
|
|
251
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
252
|
+
# Swagger Name: AvaTaxClient
|
|
253
|
+
# @param companyId [Integer] The unique ID of the company.
|
|
254
|
+
# @param model [ItemTaxcodeRecommendationBatchesInputModel[]] The list of items to include in the batch (maximum 2,000).
|
|
255
|
+
# @return [TaxcodeBatchOutputModel[]]
|
|
256
|
+
def create_taxcode_batch(companyId, model) path = "/api/v2/companies/#{companyId}/taxcode-recommendations/batches"
|
|
257
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
258
|
+
|
|
240
259
|
# Create a new tax code classification request
|
|
241
260
|
#
|
|
242
261
|
# Creates a new tax code classification request.
|
|
@@ -255,6 +274,22 @@ module AvaTax
|
|
|
255
274
|
def create_tax_code_classification_request(companyId, model) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode"
|
|
256
275
|
post(path, model, {}, AvaTax::VERSION) end
|
|
257
276
|
|
|
277
|
+
# Deletes a tax code recommendation batch.
|
|
278
|
+
#
|
|
279
|
+
# Deletes the specified tax code recommendation batch.
|
|
280
|
+
#
|
|
281
|
+
# Returns '404 Not Found' if the batch is already deleted, does not exist, or belongs to a different company.
|
|
282
|
+
#
|
|
283
|
+
# ### Security Policies
|
|
284
|
+
#
|
|
285
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
286
|
+
# Swagger Name: AvaTaxClient
|
|
287
|
+
# @param companyId [Integer] The unique ID of the company.
|
|
288
|
+
# @param batchId [Integer] The unique ID of the batch to delete.
|
|
289
|
+
# @return [ObjectDeletedErrorModel[]]
|
|
290
|
+
def delete_batch_tax_code_recommendations(companyId, batchId) path = "/api/v2/companies/#{companyId}/taxcode-recommendations/batches/#{batchId}"
|
|
291
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
292
|
+
|
|
258
293
|
# Delete a single item
|
|
259
294
|
#
|
|
260
295
|
# Deletes the item object at this URL.
|
|
@@ -283,6 +318,19 @@ module AvaTax
|
|
|
283
318
|
def delete_catalogue_item(companyId, itemCode) path = "/api/v2/companies/#{companyId}/itemcatalogue/#{itemCode}"
|
|
284
319
|
delete(path, {}, AvaTax::VERSION) end
|
|
285
320
|
|
|
321
|
+
# Deletes HS Code classification status for the item by status id.
|
|
322
|
+
#
|
|
323
|
+
# ### Security Policies
|
|
324
|
+
#
|
|
325
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
326
|
+
# Swagger Name: AvaTaxClient
|
|
327
|
+
# @param companyId [Integer] The ID of the company to which this item belongs
|
|
328
|
+
# @param itemId [Integer] The ID of the item
|
|
329
|
+
# @param id [String] The HS Code classification status id.
|
|
330
|
+
# @return []
|
|
331
|
+
def delete_h_s_code_classification_status(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hscode-classifications-status/#{id}"
|
|
332
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
333
|
+
|
|
286
334
|
# Delete a single item
|
|
287
335
|
#
|
|
288
336
|
# Deletes the item object at this URL.
|
|
@@ -448,6 +496,25 @@ module AvaTax
|
|
|
448
496
|
def fetch_additional_h_s_code_duty_details(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hsdutydetails/$fetch-additional-hsdutydetails"
|
|
449
497
|
post(path, model, {}, AvaTax::VERSION) end
|
|
450
498
|
|
|
499
|
+
# Retrieves the status and results of a tax code recommendation batch.
|
|
500
|
+
#
|
|
501
|
+
# Retrieves the status and results of a tax code recommendation batch for the specified company.
|
|
502
|
+
# If the batch status is "Completed", the response includes the tax code recommendations for all items in the batch.
|
|
503
|
+
# If the batch status is "Waiting", "Processing", or any other non-complete status, only the status information is returned.
|
|
504
|
+
# Returns '404 Not Found' if the batch has been deleted or does not exist.
|
|
505
|
+
#
|
|
506
|
+
# Batches are automatically deleted after 1 day.
|
|
507
|
+
#
|
|
508
|
+
# ### Security Policies
|
|
509
|
+
#
|
|
510
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
511
|
+
# Swagger Name: AvaTaxClient
|
|
512
|
+
# @param companyId [Integer] The unique ID of the company.
|
|
513
|
+
# @param batchId [Integer] The unique ID of the recommendation batch.
|
|
514
|
+
# @return [Object]
|
|
515
|
+
def get_batch_tax_code_recommendations(companyId, batchId) path = "/api/v2/companies/#{companyId}/taxcode-recommendations/batches/#{batchId}"
|
|
516
|
+
get(path, {}, AvaTax::VERSION) end
|
|
517
|
+
|
|
451
518
|
# Retrieve the HS code classification SLA details for a company.
|
|
452
519
|
#
|
|
453
520
|
# This endpoint returns the SLA details for HS code classification for the
|
|
@@ -1222,6 +1289,18 @@ module AvaTax
|
|
|
1222
1289
|
# @return [ItemParameterModel[]]
|
|
1223
1290
|
def upsert_item_parameter(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
|
1224
1291
|
put(path, model, {}, AvaTax::VERSION) end
|
|
1292
|
+
|
|
1293
|
+
# Verify the HSCode to be valid/invalid
|
|
1294
|
+
#
|
|
1295
|
+
# ### Security Policies
|
|
1296
|
+
#
|
|
1297
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
1298
|
+
# Swagger Name: AvaTaxClient
|
|
1299
|
+
# @param companyId [Integer] The unique ID of the company
|
|
1300
|
+
# @param model [ItemHSCodeVerificationInputModel[]] The request model for HS Code Verification
|
|
1301
|
+
# @return [Object]
|
|
1302
|
+
def verify_h_s_code(companyId, model) path = "/api/v2/companies/#{companyId}/items/hscodes/$verify"
|
|
1303
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
1225
1304
|
end
|
|
1226
1305
|
end
|
|
1227
1306
|
end
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
module AvaTax
|
|
2
|
+
class Client
|
|
3
|
+
module ItemsReverseSync
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
# Create a webhook registration for a company.
|
|
7
|
+
#
|
|
8
|
+
# Creates a webhook registration for the specified company. The registration defines a
|
|
9
|
+
# connector, callback URL, registration type, and subscribed events.
|
|
10
|
+
#
|
|
11
|
+
# The customer must pass the connector name in `connectorName`; this value is also
|
|
12
|
+
# used as the OAuth scope for the registration.
|
|
13
|
+
#
|
|
14
|
+
# ### Security Policies
|
|
15
|
+
#
|
|
16
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
17
|
+
# Swagger Name: AvaTaxClient
|
|
18
|
+
# @param companyId [Integer] The ID of the company for which you want to create the registration.
|
|
19
|
+
# @param model [Object] The webhook registration details to create.
|
|
20
|
+
# @return [Object]
|
|
21
|
+
def create_reverse_sync_registration(companyId, model) path = "/api/v2/connector-sync/companies/#{companyId}/registrations"
|
|
22
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
23
|
+
|
|
24
|
+
# Delete a webhook registration.
|
|
25
|
+
#
|
|
26
|
+
# Deletes the webhook registration identified by the specified registration ID for the given company.
|
|
27
|
+
#
|
|
28
|
+
# ### Security Policies
|
|
29
|
+
#
|
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
31
|
+
# Swagger Name: AvaTaxClient
|
|
32
|
+
# @param companyId [Integer] The ID of the company that owns this registration.
|
|
33
|
+
# @param registrationId [Integer] The ID of the registration to delete.
|
|
34
|
+
# @return [ObjectDeletedErrorModel[]]
|
|
35
|
+
def delete_reverse_sync_registration(companyId, registrationId) path = "/api/v2/connector-sync/companies/#{companyId}/registrations/#{registrationId}"
|
|
36
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
37
|
+
|
|
38
|
+
# Retrieve a webhook registration.
|
|
39
|
+
#
|
|
40
|
+
# Returns the webhook registration identified by the specified registration ID for the given company.
|
|
41
|
+
#
|
|
42
|
+
# ### Security Policies
|
|
43
|
+
#
|
|
44
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
45
|
+
# Swagger Name: AvaTaxClient
|
|
46
|
+
# @param companyId [Integer] The ID of the company that owns this registration.
|
|
47
|
+
# @param registrationId [Integer] The ID of the registration.
|
|
48
|
+
# @return [Object]
|
|
49
|
+
def get_reverse_sync_registration(companyId, registrationId) path = "/api/v2/connector-sync/companies/#{companyId}/registrations/#{registrationId}"
|
|
50
|
+
get(path, {}, AvaTax::VERSION) end
|
|
51
|
+
|
|
52
|
+
# List webhook registrations for a company.
|
|
53
|
+
#
|
|
54
|
+
# Returns all webhook registrations for the specified company.
|
|
55
|
+
#
|
|
56
|
+
# ### Security Policies
|
|
57
|
+
#
|
|
58
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
59
|
+
# Swagger Name: AvaTaxClient
|
|
60
|
+
# @param companyId [Integer] The ID of the company that owns the webhook registrations.
|
|
61
|
+
# @return [FetchResult]
|
|
62
|
+
def list_reverse_sync_registrations(companyId) path = "/api/v2/connector-sync/companies/#{companyId}/registrations"
|
|
63
|
+
get(path, {}, AvaTax::VERSION) end
|
|
64
|
+
|
|
65
|
+
# Update a webhook registration.
|
|
66
|
+
#
|
|
67
|
+
# Updates the webhook registration with the provided fields. Only the fields included in the
|
|
68
|
+
# request body are updated.
|
|
69
|
+
#
|
|
70
|
+
# ### Security Policies
|
|
71
|
+
#
|
|
72
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
73
|
+
# Swagger Name: AvaTaxClient
|
|
74
|
+
# @param companyId [Integer] The ID of the company that owns this registration.
|
|
75
|
+
# @param registrationId [Integer] The ID of the registration to update.
|
|
76
|
+
# @param model [Object] The registration fields to update.
|
|
77
|
+
# @return [Object]
|
|
78
|
+
def update_reverse_sync_registration(companyId, registrationId, model) path = "/api/v2/connector-sync/companies/#{companyId}/registrations/#{registrationId}"
|
|
79
|
+
patch(path, model, {}, AvaTax::VERSION) end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
@@ -154,7 +154,7 @@ module AvaTax
|
|
|
154
154
|
#
|
|
155
155
|
# ### Security Policies
|
|
156
156
|
#
|
|
157
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
157
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
158
158
|
# * This API is available to Avalara system-level (registrar-level) users only.
|
|
159
159
|
# Swagger Name: AvaTaxClient
|
|
160
160
|
# @param userId [Integer] The unique ID of the user whose password will be changed
|
|
@@ -3,6 +3,20 @@ module AvaTax
|
|
|
3
3
|
module Reports
|
|
4
4
|
|
|
5
5
|
|
|
6
|
+
# Download an audit log report
|
|
7
|
+
#
|
|
8
|
+
# Downloads the file associated with an audit log report.
|
|
9
|
+
# If the report is not yet complete, you will receive a `ReportNotFinished` error.
|
|
10
|
+
#
|
|
11
|
+
# ### Security Policies
|
|
12
|
+
#
|
|
13
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
14
|
+
# Swagger Name: AvaTaxClient
|
|
15
|
+
# @param id [String] The unique ID of the audit log report
|
|
16
|
+
# @return [Object]
|
|
17
|
+
def download_audit_log_report(id) path = "/api/v2/reports/exportauditlogs/#{id}/attachment"
|
|
18
|
+
get(path, {}, AvaTax::VERSION) end
|
|
19
|
+
|
|
6
20
|
# Download a report
|
|
7
21
|
#
|
|
8
22
|
# This API downloads the file associated with a report.
|
|
@@ -29,6 +43,32 @@ module AvaTax
|
|
|
29
43
|
def download_report(id) path = "/api/v2/reports/#{id}/attachment"
|
|
30
44
|
get(path, {}, AvaTax::VERSION) end
|
|
31
45
|
|
|
46
|
+
# Initiate an ExportAuditLogs report task
|
|
47
|
+
#
|
|
48
|
+
# Begins running an `ExportAuditLogs` report task and returns the identity of the report.
|
|
49
|
+
#
|
|
50
|
+
# ### Security Policies
|
|
51
|
+
#
|
|
52
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
53
|
+
# Swagger Name: AvaTaxClient
|
|
54
|
+
# @param model [Object] Options to filter the audit log export.
|
|
55
|
+
# @return [ReportAuditLogResponseModel[]]
|
|
56
|
+
def export_audit_logs(model) path = "/api/v2/reports/exportauditlogs"
|
|
57
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
58
|
+
|
|
59
|
+
# Get an audit log report by id
|
|
60
|
+
#
|
|
61
|
+
# Retrieves the status and details of an audit log report task.
|
|
62
|
+
#
|
|
63
|
+
# ### Security Policies
|
|
64
|
+
#
|
|
65
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
66
|
+
# Swagger Name: AvaTaxClient
|
|
67
|
+
# @param id [String] The unique ID of the audit log report
|
|
68
|
+
# @return [Object]
|
|
69
|
+
def get_audit_log_report(id) path = "/api/v2/reports/exportauditlogs/#{id}"
|
|
70
|
+
get(path, {}, AvaTax::VERSION) end
|
|
71
|
+
|
|
32
72
|
# Retrieve a single report
|
|
33
73
|
#
|
|
34
74
|
# Retrieve a single report by its unique ID number.
|
data/lib/avatax/client/users.rb
CHANGED
|
@@ -15,7 +15,7 @@ module AvaTax
|
|
|
15
15
|
#
|
|
16
16
|
# ### Security Policies
|
|
17
17
|
#
|
|
18
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
18
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
19
19
|
# Swagger Name: AvaTaxClient
|
|
20
20
|
# @param model [Object] An object containing your current password and the new password.
|
|
21
21
|
# @return [String]
|
|
@@ -36,7 +36,7 @@ module AvaTax
|
|
|
36
36
|
#
|
|
37
37
|
# ### Security Policies
|
|
38
38
|
#
|
|
39
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
39
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
40
40
|
# Swagger Name: AvaTaxClient
|
|
41
41
|
# @param accountId [Integer] The unique ID number of the account where these users will be created.
|
|
42
42
|
# @param model [UserModel[]] The user or array of users you wish to create.
|
|
@@ -55,7 +55,7 @@ module AvaTax
|
|
|
55
55
|
#
|
|
56
56
|
# ### Security Policies
|
|
57
57
|
#
|
|
58
|
-
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
|
|
58
|
+
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
|
|
59
59
|
# Swagger Name: AvaTaxClient
|
|
60
60
|
# @param id [Integer] The ID of the user you wish to delete.
|
|
61
61
|
# @param accountId [Integer] The accountID of the user you wish to delete.
|
|
@@ -74,7 +74,7 @@ module AvaTax
|
|
|
74
74
|
#
|
|
75
75
|
# ### Security Policies
|
|
76
76
|
#
|
|
77
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
77
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
78
78
|
# Swagger Name: AvaTaxClient
|
|
79
79
|
# @param id [Integer] The ID of the user to retrieve.
|
|
80
80
|
# @param accountId [Integer] The accountID of the user you wish to get.
|
|
@@ -103,7 +103,7 @@ module AvaTax
|
|
|
103
103
|
#
|
|
104
104
|
# ### Security Policies
|
|
105
105
|
#
|
|
106
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
106
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
107
107
|
# Swagger Name: AvaTaxClient
|
|
108
108
|
# @param id [Integer] The ID of the user to retrieve.
|
|
109
109
|
# @param accountId [Integer] The accountID of the user you wish to get.
|
|
@@ -128,7 +128,7 @@ module AvaTax
|
|
|
128
128
|
#
|
|
129
129
|
# ### Security Policies
|
|
130
130
|
#
|
|
131
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
131
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
132
132
|
# Swagger Name: AvaTaxClient
|
|
133
133
|
# @param accountId [Integer] The accountID of the user you wish to list.
|
|
134
134
|
# @param include [String] Optional fetch commands.
|
|
@@ -159,7 +159,7 @@ module AvaTax
|
|
|
159
159
|
#
|
|
160
160
|
# ### Security Policies
|
|
161
161
|
#
|
|
162
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
162
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
163
163
|
# Swagger Name: AvaTaxClient
|
|
164
164
|
# @param include [String] Optional fetch commands.
|
|
165
165
|
# @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:* SuppressNewUserEmail
|
|
@@ -179,7 +179,7 @@ module AvaTax
|
|
|
179
179
|
#
|
|
180
180
|
# ### Security Policies
|
|
181
181
|
#
|
|
182
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
182
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
183
183
|
# Swagger Name: AvaTaxClient
|
|
184
184
|
# @param id [Integer] The ID of the user you wish to update.
|
|
185
185
|
# @param accountId [Integer] The accountID of the user you wish to update.
|
|
@@ -32,6 +32,29 @@ module AvaTax
|
|
|
32
32
|
def create_vendors(companyId, model) path = "/api/v2/companies/#{companyId}/vendors"
|
|
33
33
|
post(path, model, {}, AvaTax::VERSION) end
|
|
34
34
|
|
|
35
|
+
# Delete a vendor record
|
|
36
|
+
#
|
|
37
|
+
# Deletes the vendor object referenced by this URL.
|
|
38
|
+
#
|
|
39
|
+
# A vendor object defines information about a person or business that you purchase products from.
|
|
40
|
+
# The same CertCapture customer resource is used for vendors (isVendor flag). Deleting removes the record.
|
|
41
|
+
#
|
|
42
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
43
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
44
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
45
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
46
|
+
#
|
|
47
|
+
# ### Security Policies
|
|
48
|
+
#
|
|
49
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
50
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
51
|
+
# Swagger Name: AvaTaxClient
|
|
52
|
+
# @param companyId [Integer] The unique ID number of the company that recorded this vendor
|
|
53
|
+
# @param vendorCode [String] The unique code representing this vendor
|
|
54
|
+
# @return []
|
|
55
|
+
def delete_vendor(companyId, vendorCode) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}"
|
|
56
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
57
|
+
|
|
35
58
|
# Retrieve a single vendor
|
|
36
59
|
#
|
|
37
60
|
# Retrieve the vendor identified by this URL.
|
|
@@ -54,7 +77,7 @@ module AvaTax
|
|
|
54
77
|
# * shipTos - Retrieves ship-tos linked with this vendor
|
|
55
78
|
# * shipToStates - Retrieves ship-to states for this vendor
|
|
56
79
|
# * custom_fields - Retrieves custom fields set for this vendor
|
|
57
|
-
#
|
|
80
|
+
# * vendorAdditionalInfo - Retrieves vendorAdditionalInfo for this vendor
|
|
58
81
|
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
59
82
|
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
60
83
|
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
@@ -128,6 +151,7 @@ module AvaTax
|
|
|
128
151
|
# * shipTos - Retrieves ship-tos linked with this vendor
|
|
129
152
|
# * shipToStates - Retrieves ship-to states for this vendor
|
|
130
153
|
# * custom_fields - Retrieves custom fields set for this vendor
|
|
154
|
+
# * vendorAdditionalInfo - Retrieves vendorAdditionalInfo for vendors
|
|
131
155
|
#
|
|
132
156
|
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
133
157
|
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
@@ -150,6 +174,32 @@ module AvaTax
|
|
|
150
174
|
# @return [FetchResult]
|
|
151
175
|
def query_vendors(companyId, options={}) path = "/api/v2/companies/#{companyId}/vendors"
|
|
152
176
|
get(path, options, AvaTax::VERSION) end
|
|
177
|
+
|
|
178
|
+
# Update a single vendor
|
|
179
|
+
#
|
|
180
|
+
# Replace the vendor object with a new record.
|
|
181
|
+
#
|
|
182
|
+
# A vendor object defines information about a person or business that you purchase products from.
|
|
183
|
+
# When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
|
|
184
|
+
# record. AvaTax will search for this `vendorCode` value and identify any certificates
|
|
185
|
+
# linked to this vendor object.
|
|
186
|
+
#
|
|
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
|
+
#
|
|
192
|
+
# ### Security Policies
|
|
193
|
+
#
|
|
194
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
195
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
196
|
+
# Swagger Name: AvaTaxClient
|
|
197
|
+
# @param companyId [Integer] The unique ID number of the company that recorded this vendor
|
|
198
|
+
# @param vendorCode [String] The unique code representing this vendor
|
|
199
|
+
# @param model [Object] The new vendor model that will replace the existing record at this URL
|
|
200
|
+
# @return [Object]
|
|
201
|
+
def update_vendor(companyId, vendorCode, model) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}"
|
|
202
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
153
203
|
end
|
|
154
204
|
end
|
|
155
205
|
end
|
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: 26.
|
|
4
|
+
version: 26.6.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: 2026-
|
|
11
|
+
date: 2026-06-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|
|
@@ -142,14 +142,17 @@ files:
|
|
|
142
142
|
- lib/avatax/client/ecmeventnotifications.rb
|
|
143
143
|
- lib/avatax/client/ecms.rb
|
|
144
144
|
- lib/avatax/client/ecommercetoken.rb
|
|
145
|
+
- lib/avatax/client/econexusthreshold.rb
|
|
145
146
|
- lib/avatax/client/errortransactions.rb
|
|
146
147
|
- lib/avatax/client/filingcalendars.rb
|
|
147
148
|
- lib/avatax/client/filings.rb
|
|
148
149
|
- lib/avatax/client/firmclientlinkages.rb
|
|
150
|
+
- lib/avatax/client/formtypemapping.rb
|
|
149
151
|
- lib/avatax/client/free.rb
|
|
150
152
|
- lib/avatax/client/fundingrequests.rb
|
|
151
153
|
- lib/avatax/client/glaccount.rb
|
|
152
154
|
- lib/avatax/client/items.rb
|
|
155
|
+
- lib/avatax/client/itemsreversesync.rb
|
|
153
156
|
- lib/avatax/client/jurisdictionoverrides.rb
|
|
154
157
|
- lib/avatax/client/locations.rb
|
|
155
158
|
- lib/avatax/client/multidocument.rb
|