avatax 26.4.0 → 26.5.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/companies.rb +122 -0
- data/lib/avatax/client/definitions.rb +0 -28
- data/lib/avatax/client/econexusthreshold.rb +37 -0
- data/lib/avatax/client/formtypemapping.rb +19 -0
- data/lib/avatax/client/items.rb +67 -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/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5dc32c4d50d3f06a0e19a6f0221ab7c0b0dae4c5fc6cef906f8132cc5ba35bb4
|
|
4
|
+
data.tar.gz: 8a88a83d37197697af220ef1c0d4c9419c11556ebb89cb54eb619327d20ec7f2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fbf907dd44b45fcb9945b85d1fe2b75005abbfa74b214c68293497d521a753a8d4b14460d1315341637cd1c4203b4e91836955de7e95a300e7a6fb2d4be2dec5
|
|
7
|
+
data.tar.gz: 197d2602ecd59c91885c1342a845c11631f79a89b2a92c44137f090c676a4ece7f9f4506e5fe7f7f25a1322de3fdca446f5bbf25e9c9f89cde5160fb451dbf82
|
|
@@ -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,38 @@ 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
|
+
#
|
|
475
|
+
# Order results using `$orderBy`. Common orderings:
|
|
476
|
+
# * `vatNumber ASC` - Order by VAT number ascending
|
|
477
|
+
# * `validationDate DESC` - Order by most recently validated first
|
|
478
|
+
# * `modifiedDate DESC` - Order by most recently modified first
|
|
479
|
+
#
|
|
480
|
+
# ### Security Policies
|
|
481
|
+
#
|
|
482
|
+
# * 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.
|
|
483
|
+
# Swagger Name: AvaTaxClient
|
|
484
|
+
# @param companyId [Integer] The ID of the company
|
|
485
|
+
# @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:* createdDate, modifiedDate
|
|
486
|
+
# @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.
|
|
487
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
488
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
489
|
+
# @return [FetchResult]
|
|
490
|
+
def list_vat_numbers(companyId, options={}) path = "/api/v2/companies/#{companyId}/vatnumbers"
|
|
491
|
+
get(path, options, AvaTax::VERSION) end
|
|
492
|
+
|
|
415
493
|
# Retrieve all companies
|
|
416
494
|
#
|
|
417
495
|
# Get multiple company objects.
|
|
@@ -514,6 +592,50 @@ module AvaTax
|
|
|
514
592
|
# @return [Object]
|
|
515
593
|
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
|
516
594
|
put(path, model, {}, AvaTax::VERSION) end
|
|
595
|
+
|
|
596
|
+
# Update a single VAT Number
|
|
597
|
+
#
|
|
598
|
+
# Replace the existing VAT number record with the data in the object you PUT.
|
|
599
|
+
#
|
|
600
|
+
# Only `vatNumber`, `businessName`, and `country` fields can be updated. The
|
|
601
|
+
# validation-related fields (`vatNumberStatus`, `registeredBusinessName`,
|
|
602
|
+
# `businessNameStatus`, `validationDate`, `validationSource`) are managed by the
|
|
603
|
+
# system and are refreshed automatically: every successful PUT re-triggers a
|
|
604
|
+
# synchronous VAT validation against the ELR / Directory Search service (which
|
|
605
|
+
# proxies VIES). This makes "Fix" flows work as expected — correcting an
|
|
606
|
+
# invalid VAT number immediately updates its status.
|
|
607
|
+
#
|
|
608
|
+
# ### Security Policies
|
|
609
|
+
#
|
|
610
|
+
# * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
|
611
|
+
# Swagger Name: AvaTaxClient
|
|
612
|
+
# @param companyId [Integer] The ID of the company that owns this VAT number
|
|
613
|
+
# @param id [Integer] The unique ID of the VAT number record to update
|
|
614
|
+
# @param model [Object] The VAT number object you wish to update
|
|
615
|
+
# @return [Object]
|
|
616
|
+
def update_vat_number(companyId, id, model) path = "/api/v2/companies/#{companyId}/vatnumbers/#{id}"
|
|
617
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
618
|
+
|
|
619
|
+
# Validate a VAT Number without storing it
|
|
620
|
+
#
|
|
621
|
+
# Performs a synchronous VAT number validation against the ELR / Directory Search service
|
|
622
|
+
# (which proxies VIES) without persisting any record in the `CustomerVatNumber` table.
|
|
623
|
+
#
|
|
624
|
+
# This is useful for UI flows that allow the user to "test" a VAT number before
|
|
625
|
+
# deciding whether to add it. The response payload mirrors the shape returned by
|
|
626
|
+
# the create/update endpoints, but `id`, `createdDate`, and `modifiedDate` are not set.
|
|
627
|
+
# Business-name comparison is not performed here; use the create endpoint to persist
|
|
628
|
+
# and obtain a `businessNameStatus`.
|
|
629
|
+
#
|
|
630
|
+
# ### Security Policies
|
|
631
|
+
#
|
|
632
|
+
# * 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.
|
|
633
|
+
# Swagger Name: AvaTaxClient
|
|
634
|
+
# @param companyId [Integer] The ID of the company on whose behalf the validation is performed
|
|
635
|
+
# @param model [Object] The VAT number to validate (vatNumber, country)
|
|
636
|
+
# @return [Object]
|
|
637
|
+
def validate_vat_number(companyId, model) path = "/api/v2/companies/#{companyId}/vatnumbers/validate"
|
|
638
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
517
639
|
end
|
|
518
640
|
end
|
|
519
641
|
end
|
|
@@ -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.
|
|
@@ -465,20 +451,6 @@ module AvaTax
|
|
|
465
451
|
def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
|
|
466
452
|
get(path, options, AvaTax::VERSION) end
|
|
467
453
|
|
|
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
454
|
# Retrieve the list of locations for a marketplace.
|
|
483
455
|
#
|
|
484
456
|
# 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
|
|
@@ -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.
|
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.5.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-05-22 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|
|
@@ -142,10 +142,12 @@ 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
|