avatax 25.12.0 → 26.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitlab-ci.yml +3 -2
- data/lib/avatax/client/apconfigsetting.rb +2 -2
- data/lib/avatax/client/companies.rb +18 -0
- data/lib/avatax/client/definitions.rb +10 -5
- data/lib/avatax/client/items.rb +1 -1
- data/lib/avatax/client/notices.rb +4 -4
- data/lib/avatax/client/vendors.rb +29 -0
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e5bc5d492cf5fdd4f0b047fee2dbcc06076f400a994adf1042a642b143f3e939
|
|
4
|
+
data.tar.gz: 02f4d8c13037f333ab4d82c075abf508e309b95dd71b26b9e7ccd5fb35cc542e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8b5a299c1d51aa3abf946f0730e8b99b69818cba86fabb37e2b0e8ef290b14a5be72daa5b6b22ab6ee2b09a89c6da15bfac9150cebacef229861a4786ce949e7
|
|
7
|
+
data.tar.gz: a545565e61236ed0f1e4d7ee10efa519203da652840d427774e40caccd29505deb2ba2d7d7a5a0c099e260ec002549952fd478fc73ffb6f4879448dd1f90a57c
|
data/.gitlab-ci.yml
CHANGED
|
@@ -18,7 +18,7 @@ module AvaTax
|
|
|
18
18
|
#
|
|
19
19
|
# Swagger Name: AvaTaxClient
|
|
20
20
|
# @param companyid [Integer] The ID of the company that defined this rule
|
|
21
|
-
# @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:* meta, amount, amountToMarkForReview, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive
|
|
21
|
+
# @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:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive
|
|
22
22
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
23
23
|
# @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.
|
|
24
24
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -31,7 +31,7 @@ module AvaTax
|
|
|
31
31
|
#
|
|
32
32
|
#
|
|
33
33
|
# Swagger Name: AvaTaxClient
|
|
34
|
-
# @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:* meta, amount, amountToMarkForReview, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive
|
|
34
|
+
# @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:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive
|
|
35
35
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
36
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
37
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -222,6 +222,24 @@ module AvaTax
|
|
|
222
222
|
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
|
223
223
|
get(path, options, AvaTax::VERSION) end
|
|
224
224
|
|
|
225
|
+
# Retrieve all customers and suppliers with their country parameters for a company
|
|
226
|
+
#
|
|
227
|
+
# Retrieves all customers and suppliers for a company along with their country parameters. Records without country parameters will still be returned with null country parameter fields (LEFT JOIN behavior).
|
|
228
|
+
# Results are ordered by CustomerTypeId, CustomerCode, and Country.
|
|
229
|
+
#
|
|
230
|
+
# ### Security Policies
|
|
231
|
+
#
|
|
232
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
233
|
+
# Swagger Name: AvaTaxClient
|
|
234
|
+
# @param companyId [Integer] Company Id
|
|
235
|
+
# @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:* CustomerId, CompanyId, CustomerTypeId, CustomerSupplierCountryParamId, Country, IsEstablished, IsRegisteredThroughFiscalRep, VatNumberStatus
|
|
236
|
+
# @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.
|
|
237
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
238
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
239
|
+
# @return [FetchResult]
|
|
240
|
+
def get_all_customers_and_suppliers_with_country_params(companyId, options={}) path = "/api/v2/companies/#{companyId}/supplierandcustomers/withcountryparams"
|
|
241
|
+
get(path, options, AvaTax::VERSION) end
|
|
242
|
+
|
|
225
243
|
# Retrieve a single company
|
|
226
244
|
#
|
|
227
245
|
# Get the company object identified by this URL.
|
|
@@ -179,14 +179,19 @@ module AvaTax
|
|
|
179
179
|
|
|
180
180
|
# List all ISO 3166 countries
|
|
181
181
|
#
|
|
182
|
-
# Returns a list of
|
|
182
|
+
# Returns a list of ISO 3166 country codes based on the scope filter.
|
|
183
183
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
|
|
184
|
-
# a shipping address.
|
|
184
|
+
# a shipping address.
|
|
185
|
+
#
|
|
186
|
+
# Scope options:
|
|
187
|
+
# - Custom: Return only countries for which there is a TaxTypeMapping with IsCustomContent = true (requires subscription)
|
|
188
|
+
# - All (default): Return all ISO 3166 countries
|
|
185
189
|
# Swagger Name: AvaTaxClient
|
|
186
190
|
# @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:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion
|
|
187
191
|
# @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.
|
|
188
192
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
189
193
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
194
|
+
# @param scope [String] Optional query parameter to filter by Custom or All countries (default: All) (See ContentScope::* for a list of allowable values)
|
|
190
195
|
# @return [FetchResult]
|
|
191
196
|
def list_countries(options={}) path = "/api/v2/definitions/countries"
|
|
192
197
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -942,7 +947,7 @@ module AvaTax
|
|
|
942
947
|
# @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.
|
|
943
948
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
944
949
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
945
|
-
# @param
|
|
950
|
+
# @param scope [String] Optional query parameter to filter system, custom content or all regions (default: System) (See ContentScope::* for a list of allowable values)
|
|
946
951
|
# @return [FetchResult]
|
|
947
952
|
def list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type(companyId, country, taxTypeId, taxSubTypeId, rateTypeId, jurisdictionTypeId, options={}) path = "/api/v2/definitions/companies/#{companyId}/countries/#{country}/regions/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/rateTypeId/#{rateTypeId}/jurisdictionTypeId/#{jurisdictionTypeId}"
|
|
948
953
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -1113,7 +1118,7 @@ module AvaTax
|
|
|
1113
1118
|
# @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.
|
|
1114
1119
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
1115
1120
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
1116
|
-
# @param
|
|
1121
|
+
# @param scope [String] Optional query parameter to filter by System, Custom or All tax sub types (default: System) (See ContentScope::* for a list of allowable values)
|
|
1117
1122
|
# @return [FetchResult]
|
|
1118
1123
|
def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
|
|
1119
1124
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -1155,7 +1160,7 @@ module AvaTax
|
|
|
1155
1160
|
# @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.
|
|
1156
1161
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
1157
1162
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
1158
|
-
# @param
|
|
1163
|
+
# @param scope [String] Optional query parameter to filter by System, Custom or All tax types (default: System) (See ContentScope::* for a list of allowable values)
|
|
1159
1164
|
# @return [FetchResult]
|
|
1160
1165
|
def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
|
|
1161
1166
|
get(path, options, AvaTax::VERSION) end
|
data/lib/avatax/client/items.rb
CHANGED
|
@@ -442,7 +442,7 @@ module AvaTax
|
|
|
442
442
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
443
443
|
# Swagger Name: AvaTaxClient
|
|
444
444
|
# @param companyId [Integer] The ID of the company for which you want to get additional HS Duty Details.
|
|
445
|
-
# @param itemId [Integer]
|
|
445
|
+
# @param itemId [Integer] The unique ID of the item for which you want to get additional HS Duty Details.
|
|
446
446
|
# @param model [ItemAdditionalHSCodeDutyInputModel[]] Additional HS Code Duty Details input Model
|
|
447
447
|
# @return [ItemHSCodeDutyDetailModel[]]
|
|
448
448
|
def fetch_additional_h_s_code_duty_details(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hsdutydetails/$fetch-additional-hsdutydetails"
|
|
@@ -9,7 +9,7 @@ module AvaTax
|
|
|
9
9
|
#
|
|
10
10
|
# ### Security Policies
|
|
11
11
|
#
|
|
12
|
-
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
12
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
13
13
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
|
14
14
|
# Swagger Name: AvaTaxClient
|
|
15
15
|
# @param model [Object] The responsibility type to create
|
|
@@ -23,7 +23,7 @@ module AvaTax
|
|
|
23
23
|
#
|
|
24
24
|
# ### Security Policies
|
|
25
25
|
#
|
|
26
|
-
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
26
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
27
27
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
|
28
28
|
# Swagger Name: AvaTaxClient
|
|
29
29
|
# @param model [Object] The root cause type to create
|
|
@@ -37,7 +37,7 @@ module AvaTax
|
|
|
37
37
|
#
|
|
38
38
|
# ### Security Policies
|
|
39
39
|
#
|
|
40
|
-
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
40
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
41
41
|
# Swagger Name: AvaTaxClient
|
|
42
42
|
# @param responsibilityId [Integer] The unique ID of the responsibility type
|
|
43
43
|
# @return [ErrorDetail[]]
|
|
@@ -50,7 +50,7 @@ module AvaTax
|
|
|
50
50
|
#
|
|
51
51
|
# ### Security Policies
|
|
52
52
|
#
|
|
53
|
-
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
53
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
54
54
|
# Swagger Name: AvaTaxClient
|
|
55
55
|
# @param rootCauseId [Integer] The unique ID of the root cause type
|
|
56
56
|
# @return [ErrorDetail[]]
|
|
@@ -3,6 +3,35 @@ module AvaTax
|
|
|
3
3
|
module Vendors
|
|
4
4
|
|
|
5
5
|
|
|
6
|
+
# Create vendors for this company
|
|
7
|
+
#
|
|
8
|
+
# Create one or more vendors for this company.
|
|
9
|
+
#
|
|
10
|
+
# A vendor object defines information about a person or business that purchases products from your
|
|
11
|
+
# company. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
|
|
12
|
+
# record in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and
|
|
13
|
+
# identify any certificates linked to this `vendor` object. If any certificate applies to the transaction,
|
|
14
|
+
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
15
|
+
#
|
|
16
|
+
# A nested object such as CustomFields could be specified and created along with the vendor object. To fetch the
|
|
17
|
+
# nested object, please call 'GetVendor' API with appropriate $include parameters.
|
|
18
|
+
#
|
|
19
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
20
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
21
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
22
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
23
|
+
#
|
|
24
|
+
# ### Security Policies
|
|
25
|
+
#
|
|
26
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
27
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
28
|
+
# Swagger Name: AvaTaxClient
|
|
29
|
+
# @param companyId [Integer] The unique ID number of the company that recorded this vendor
|
|
30
|
+
# @param model [VendorModel[]] The list of vendor objects to be created
|
|
31
|
+
# @return [VendorModel[]]
|
|
32
|
+
def create_vendors(companyId, model) path = "/api/v2/companies/#{companyId}/vendors"
|
|
33
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
34
|
+
|
|
6
35
|
# Retrieve a single vendor
|
|
7
36
|
#
|
|
8
37
|
# Retrieve the vendor identified by this URL.
|
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:
|
|
4
|
+
version: 26.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Marcus Vorwaller
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-02-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|