avatax 23.11.0 → 24.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4b284a025cf6da4d08e800948c224d4349fd0b135c2bbd93b894a8896db0250b
4
- data.tar.gz: 4d5bb87fb862f66cbaabe6dbbb532f3aae5c6934a6ff4dc990152d8a17aefac2
3
+ metadata.gz: d3f6bf35e950ccfaf27315e6a902334d14812e7d300faa0d03d71c1ac3cef6cc
4
+ data.tar.gz: 2fca71f39c99db3d5570836d43c0cb7ecc1a1f33352c3f2b043904d0a43a0b53
5
5
  SHA512:
6
- metadata.gz: '0899840e86762bb4d0d9ab85d08c566ec8ed531c25341b0d7d1382f512ed720fd3523dd9649231289045546c41e038e7606856979280c3c2a2e36ccb0f4ed6c1'
7
- data.tar.gz: 73ba848201eaf752af22923a1298a1568d1d2bca65d9b7dc95bfcfb8b75530bb11013c4ef17130727e5a9c29d52c0d2e87b6f66c8e479a4ecba7a754baa283aa
6
+ metadata.gz: '09157bc1861e91d0f9deeae134d66d2fdc6833ed0c5c947e6ace745a943337c1969261d6668ae32a4ff47084fc169585525694f5761abb75f79151d4680c3684'
7
+ data.tar.gz: 18ca564f6446301359ceb5845245841e039e4a4cdc1e44013845e31efba805140d8785e0dfefc2f06023ffd203dc4252a646cb60216691e199802d691e098762
@@ -24,7 +24,7 @@ module AvaTax
24
24
  # ### Security Policies
25
25
  #
26
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.
27
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
28
28
  # Swagger Name: AvaTaxClient
29
29
  # @param companyId [Integer] The unique ID number of the company that will record certificates
30
30
  # @param customerCode [String] The number of the customer where the request is sent to
@@ -54,7 +54,7 @@ module AvaTax
54
54
  # ### Security Policies
55
55
  #
56
56
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
57
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
57
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
58
58
  # Swagger Name: AvaTaxClient
59
59
  # @param companyId [Integer] The unique ID number of the company that issued this invitation
60
60
  # @param customerCode [String] The number of the customer where the request is sent to
@@ -85,7 +85,7 @@ module AvaTax
85
85
  # ### Security Policies
86
86
  #
87
87
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
88
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
88
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
89
89
  # Swagger Name: AvaTaxClient
90
90
  # @param companyId [Integer] The unique ID number of the company that issued this invitation
91
91
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
@@ -30,7 +30,7 @@ module AvaTax
30
30
  # ### Security Policies
31
31
  #
32
32
  # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
33
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
33
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
34
34
  # Swagger Name: AvaTaxClient
35
35
  # @param companyId [Integer] The ID number of the company recording this certificate
36
36
  # @param preValidatedExemptionReason [Boolean] If set to true, the certificate will bypass the human verification process.
@@ -58,7 +58,7 @@ module AvaTax
58
58
  # ### Security Policies
59
59
  #
60
60
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
61
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
61
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
62
62
  # Swagger Name: AvaTaxClient
63
63
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
64
64
  # @param id [Integer] The unique ID number of this certificate
@@ -86,7 +86,7 @@ module AvaTax
86
86
  # ### Security Policies
87
87
  #
88
88
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
89
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
89
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
90
90
  # Swagger Name: AvaTaxClient
91
91
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
92
92
  # @param id [Integer] The unique ID number of this certificate
@@ -119,7 +119,7 @@ module AvaTax
119
119
  # ### Security Policies
120
120
  #
121
121
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
122
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
122
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
123
123
  # Swagger Name: AvaTaxClient
124
124
  # @param companyId [Integer] The ID number of the company that recorded this certificate
125
125
  # @param id [Integer] The unique ID number of this certificate
@@ -141,7 +141,7 @@ module AvaTax
141
141
  # ### Security Policies
142
142
  #
143
143
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
144
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
144
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
145
145
  # Swagger Name: AvaTaxClient
146
146
  # @param companyId [Integer] The company ID to check
147
147
  # @return [Object]
@@ -168,7 +168,7 @@ module AvaTax
168
168
  # ### Security Policies
169
169
  #
170
170
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
171
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
171
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
172
172
  # Swagger Name: AvaTaxClient
173
173
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
174
174
  # @param id [Integer] The unique ID number of this certificate
@@ -198,7 +198,7 @@ module AvaTax
198
198
  # ### Security Policies
199
199
  #
200
200
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
201
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
201
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
202
202
  # Swagger Name: AvaTaxClient
203
203
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
204
204
  # @param id [Integer] The unique ID number of this certificate
@@ -227,7 +227,7 @@ module AvaTax
227
227
  # ### Security Policies
228
228
  #
229
229
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
230
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
230
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
231
231
  # Swagger Name: AvaTaxClient
232
232
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
233
233
  # @param id [Integer] The unique ID number of this certificate
@@ -255,7 +255,7 @@ module AvaTax
255
255
  # ### Security Policies
256
256
  #
257
257
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
258
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
258
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
259
259
  # Swagger Name: AvaTaxClient
260
260
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
261
261
  # @param id [Integer] The unique ID number of this certificate
@@ -287,7 +287,7 @@ module AvaTax
287
287
  # ### Security Policies
288
288
  #
289
289
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
290
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
290
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
291
291
  # Swagger Name: AvaTaxClient
292
292
  # @param companyId [Integer] The ID number of the company to search
293
293
  # @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.
@@ -314,7 +314,7 @@ module AvaTax
314
314
  # ### Security Policies
315
315
  #
316
316
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
317
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
317
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
318
318
  # Swagger Name: AvaTaxClient
319
319
  # @param companyId [Integer]
320
320
  # @return [Object]
@@ -341,7 +341,7 @@ module AvaTax
341
341
  # ### Security Policies
342
342
  #
343
343
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
344
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
344
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
345
345
  # Swagger Name: AvaTaxClient
346
346
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
347
347
  # @param id [Integer] The unique ID number of this certificate
@@ -372,7 +372,7 @@ module AvaTax
372
372
  # ### Security Policies
373
373
  #
374
374
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
375
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
375
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
376
376
  # Swagger Name: AvaTaxClient
377
377
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
378
378
  # @param id [Integer] The unique ID number of this certificate
@@ -398,7 +398,7 @@ module AvaTax
398
398
  # ### Security Policies
399
399
  #
400
400
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
401
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
401
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
402
402
  # Swagger Name: AvaTaxClient
403
403
  # @param companyId [Integer] The ID number of the company that recorded this certificate
404
404
  # @param id [Integer] The unique ID number of this certificate
@@ -427,7 +427,7 @@ module AvaTax
427
427
  # ### Security Policies
428
428
  #
429
429
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
430
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
430
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
431
431
  # Swagger Name: AvaTaxClient
432
432
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
433
433
  # @param id [Integer] The unique ID number of this certificate
@@ -3,7 +3,25 @@ module AvaTax
3
3
  module Compliance
4
4
 
5
5
 
6
- # Retrieve jurisdiction rate information for tax authority
6
+ # Retrieve all unique jurisnames based on filter.
7
+ #
8
+ # ### Security Policies
9
+ #
10
+ # * 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.
11
+ # Swagger Name: AvaTaxClient
12
+ # @param country [String] The two-character ISO-3166 code for the country.
13
+ # @param region [String] The two or three character region code for the region.
14
+ # @param effectiveDate [DateTime] Used to limit the jurisnames returned.
15
+ # @param endDate [DateTime] Used to limit the jurisnames returned.
16
+ # @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/).
17
+ # @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.
18
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
19
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
20
+ # @return [FetchResult]
21
+ def query_juris_names(country, region, options={}) path = "/api/v2/compliance/jurisnames/#{country}/#{region}"
22
+ get(path, options, AvaTax::VERSION) end
23
+
24
+ # Retrieve all RateOptions.
7
25
  #
8
26
  # This API is available by invitation only.
9
27
  #
@@ -11,16 +29,65 @@ module AvaTax
11
29
  #
12
30
  # * 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.
13
31
  # Swagger Name: AvaTaxClient
14
- # @param taxAuthorityId [Integer] Used to limit the jurisdictions returned.
15
- # @param effectiveDate [DateTime] Used to limit the jurisdictions returned.
16
- # @param endDate [DateTime] Used to limit the jurisdictions returned.
17
- # @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/).
18
- # @param include [String] A comma separated list of objects to fetch underneath this jurisdiction.
32
+ # @param country [String] The two-character ISO-3166 code for the country.
33
+ # @param region [String] The two or three character region code for the region.
34
+ # @param effectiveDate [DateTime] Used to limit the jurisdictions or rates returned.
35
+ # @param endDate [DateTime] Used to limit the jurisdictions or rates returned.
36
+ # @param aggregationOption [String] Aggregation method used. (See StackAggregationOption::* for a list of allowable values)
37
+ # @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.
38
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
39
+ # @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:* taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate
40
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
41
+ # @return [FetchResult]
42
+ def query_rate_options(country, region, options={}) path = "/api/v2/compliance/rateOptions/#{country}/#{region}"
43
+ get(path, options, AvaTax::VERSION) end
44
+
45
+ # Retrieve StateConfig information
46
+ #
47
+ # This API is available by invitation only.
48
+ #
49
+ # ### Security Policies
50
+ #
51
+ # * 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.
52
+ # Swagger Name: AvaTaxClient
53
+ # @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:* effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary
54
+ # @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.
55
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
56
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
57
+ # @return [FetchResult]
58
+ def query_state_config(options={}) path = "/api/v2/compliance/stateconfig"
59
+ get(path, options, AvaTax::VERSION) end
60
+
61
+ # Retrieve all State Reporting Codes based on filter.
62
+ #
63
+ # ### Security Policies
64
+ #
65
+ # * 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.
66
+ # Swagger Name: AvaTaxClient
67
+ # @param country [String] The two-character ISO-3166 code for the country.
68
+ # @param region [String] The two or three character region code for the region.
69
+ # @param effectiveDate [DateTime] Used to limit the StateReportingCodes or rates returned.
70
+ # @param endDate [DateTime] Used to limit the StateReportingCodes or rates returned.
71
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* label
72
+ # @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.
73
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
74
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
75
+ # @return [FetchResult]
76
+ def query_state_reporting_codes(country, region, options={}) path = "/api/v2/compliance/stateReportingCodes/#{country}/#{region}"
77
+ get(path, options, AvaTax::VERSION) end
78
+
79
+ # Retrieve all tax type mappings based on filter.
80
+ #
81
+ # ### Security Policies
82
+ #
83
+ # * 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.
84
+ # Swagger Name: AvaTaxClient
85
+ # @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:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId
19
86
  # @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.
20
87
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
21
88
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
22
- # @return [Object]
23
- def query_tax_authority_jurisdiction_rates(options={}) path = "/api/v2/compliance/taxauthorityjurisdictionrates"
89
+ # @return [FetchResult]
90
+ def query_tax_type_mappings(options={}) path = "/api/v2/compliance/taxtypemappings"
24
91
  get(path, options, AvaTax::VERSION) end
25
92
  end
26
93
  end
@@ -24,7 +24,7 @@ module AvaTax
24
24
  # ### Security Policies
25
25
  #
26
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.
27
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
28
28
  # Swagger Name: AvaTaxClient
29
29
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
30
30
  # @param model [CustomerModel[]] The list of customer objects to be created
@@ -50,7 +50,7 @@ module AvaTax
50
50
  # ### Security Policies
51
51
  #
52
52
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
53
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
53
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
54
54
  # Swagger Name: AvaTaxClient
55
55
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
56
56
  # @param customerCode [String] The unique code representing this customer
@@ -82,7 +82,7 @@ module AvaTax
82
82
  # ### Security Policies
83
83
  #
84
84
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
85
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
85
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
86
86
  # Swagger Name: AvaTaxClient
87
87
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
88
88
  # @param customerCode [String] The unique code representing this customer
@@ -112,7 +112,7 @@ module AvaTax
112
112
  # ### Security Policies
113
113
  #
114
114
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
115
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
115
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
116
116
  # Swagger Name: AvaTaxClient
117
117
  # @param companyId [Integer] The unique ID number of the company that recorded the provided customer
118
118
  # @param customerCode [String] The unique code representing the current customer
@@ -139,7 +139,7 @@ module AvaTax
139
139
  # ### Security Policies
140
140
  #
141
141
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
142
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
142
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
143
143
  # Swagger Name: AvaTaxClient
144
144
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
145
145
  # @param customerCode [String] The unique code representing this customer
@@ -167,7 +167,7 @@ module AvaTax
167
167
  # ### Security Policies
168
168
  #
169
169
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
170
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
170
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
171
171
  # Swagger Name: AvaTaxClient
172
172
  # @param companyId [Integer] The unique ID number of the company defining customers.
173
173
  # @param code [String] The code of the bill-to customer to link.
@@ -197,7 +197,7 @@ module AvaTax
197
197
  # ### Security Policies
198
198
  #
199
199
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
200
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
200
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
201
201
  # Swagger Name: AvaTaxClient
202
202
  # @param companyId [Integer] The unique ID number of the company that recorded the provided customer
203
203
  # @param customerCode [String] The unique code representing the current customer
@@ -223,7 +223,7 @@ module AvaTax
223
223
  # ### Security Policies
224
224
  #
225
225
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
226
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
226
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
227
227
  # Swagger Name: AvaTaxClient
228
228
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
229
229
  # @param customerCode [String] The unique code representing this customer
@@ -257,7 +257,7 @@ module AvaTax
257
257
  # ### Security Policies
258
258
  #
259
259
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
260
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
260
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
261
261
  # Swagger Name: AvaTaxClient
262
262
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
263
263
  # @param customerCode [String] The unique code representing this customer
@@ -290,7 +290,7 @@ module AvaTax
290
290
  # ### Security Policies
291
291
  #
292
292
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
293
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
293
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
294
294
  # Swagger Name: AvaTaxClient
295
295
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
296
296
  # @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
@@ -323,7 +323,7 @@ module AvaTax
323
323
  # ### Security Policies
324
324
  #
325
325
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
326
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
326
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
327
327
  # Swagger Name: AvaTaxClient
328
328
  # @param companyId [Integer] The unique ID number of the company that recorded the customer
329
329
  # @param customerCode [String] The unique code representing the current customer
@@ -350,7 +350,7 @@ module AvaTax
350
350
  # ### Security Policies
351
351
  #
352
352
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
353
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
353
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
354
354
  # Swagger Name: AvaTaxClient
355
355
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
356
356
  # @param customerCode [String] The unique code representing this customer
@@ -377,7 +377,7 @@ module AvaTax
377
377
  # ### Security Policies
378
378
  #
379
379
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
380
- # * This API depends on the following active services:*Required* (all): AvaTaxPro.
380
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
381
381
  # Swagger Name: AvaTaxClient
382
382
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
383
383
  # @param customerCode [String] The unique code representing this customer
@@ -305,7 +305,7 @@ module AvaTax
305
305
  #
306
306
  # The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
307
307
  # Swagger Name: AvaTaxClient
308
- # @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:* rate, salesRate, signatureCode, useRate, isAcm, isSst
308
+ # @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:* rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId
309
309
  # @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.
310
310
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
311
311
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -370,7 +370,7 @@ module AvaTax
370
370
  #
371
371
  # The rate, salesRate, and useRate fields are not available on the JurisdictionHirearchyModels returned by this API.
372
372
  # Swagger Name: AvaTaxClient
373
- # @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:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst
373
+ # @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:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId
374
374
  # @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.
375
375
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
376
376
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '23.11.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '24.2.0'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
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: 23.11.0
4
+ version: 24.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: 2023-11-09 00:00:00.000000000 Z
11
+ date: 2024-02-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake