avatax 25.11.0 → 25.12.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/items.rb +236 -3
- 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: af2b5ed138e7475d9c17c94c93f86018025244fe25f928210d3e93c6d16fa0f4
|
|
4
|
+
data.tar.gz: 040e5c28099d3545fb5fd137e7dac11eb64b12ae19cc7ca47946384e89a3c8a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e01adeb897025a42c791daab9c1739eac45257e0d57e8f44683afa6554f41a749687ded1dcf08e0400eaefdcaa023d098c093a70bcd94ac13b6309756630b3ef
|
|
7
|
+
data.tar.gz: 82ed1212ba259e8117dcd19010da314c183559b46dc86fd4ffd03d051d64d1b384cb898c646f2118adb009f0dce753553c186c19ca0e0f744ea3f7623b0e3672
|
data/lib/avatax/client/items.rb
CHANGED
|
@@ -3,6 +3,37 @@ module AvaTax
|
|
|
3
3
|
module Items
|
|
4
4
|
|
|
5
5
|
|
|
6
|
+
# Parse natural language query into structured filters
|
|
7
|
+
#
|
|
8
|
+
# Parse natural language queries into structured API filters. This endpoint forwards the query to NLQ (Natural Language Query)
|
|
9
|
+
# service for interpretation and returns only the intent and structured filters.
|
|
10
|
+
#
|
|
11
|
+
# Example queries:
|
|
12
|
+
# - "give me items created in last 1 week which are having status complete"
|
|
13
|
+
# - "show me all items with item code CERMUG"
|
|
14
|
+
# - "find items containing 'mug' in description"
|
|
15
|
+
#
|
|
16
|
+
# Response format:
|
|
17
|
+
# {
|
|
18
|
+
# "intent": "GET",
|
|
19
|
+
# "filters": {
|
|
20
|
+
# "createdDate": { "value": "from: 2025-09-12 to: 2025-09-19" },
|
|
21
|
+
# "itemStatus": { "value": ["Complete"] }
|
|
22
|
+
# }
|
|
23
|
+
# }
|
|
24
|
+
#
|
|
25
|
+
# Raw NLQ responses are logged for debugging purposes.
|
|
26
|
+
#
|
|
27
|
+
# ### Security Policies
|
|
28
|
+
#
|
|
29
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
30
|
+
# Swagger Name: AvaTaxClient
|
|
31
|
+
# @param companyId [Integer] The ID of the company that owns these items
|
|
32
|
+
# @param model [Object] Natural language search request
|
|
33
|
+
# @return [Object]
|
|
34
|
+
def a_isearch(companyId, model) path = "/api/v2/companies/#{companyId}/items/nlq/$parse"
|
|
35
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
36
|
+
|
|
6
37
|
# Delete all classifications for an item
|
|
7
38
|
#
|
|
8
39
|
# Delete all the classifications for a given item.
|
|
@@ -21,6 +52,26 @@ module AvaTax
|
|
|
21
52
|
def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
22
53
|
delete(path, {}, AvaTax::VERSION) end
|
|
23
54
|
|
|
55
|
+
# Delete all custom parameters for an item
|
|
56
|
+
#
|
|
57
|
+
# Delete all the custom parameters for a given item.
|
|
58
|
+
#
|
|
59
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
60
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
61
|
+
#
|
|
62
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
63
|
+
# that doesn't fit into the standard item fields.
|
|
64
|
+
#
|
|
65
|
+
# ### Security Policies
|
|
66
|
+
#
|
|
67
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
68
|
+
# Swagger Name: AvaTaxClient
|
|
69
|
+
# @param companyId [Integer] The ID of the company that owns this item.
|
|
70
|
+
# @param itemId [Integer] The ID of the item you wish to delete the custom parameters.
|
|
71
|
+
# @return [AssociatedObjectDeletedErrorDetailsModel[]]
|
|
72
|
+
def batch_delete_item_custom_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
73
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
74
|
+
|
|
24
75
|
# Delete all parameters for an item
|
|
25
76
|
#
|
|
26
77
|
# Delete all the parameters for a given item.
|
|
@@ -57,6 +108,9 @@ module AvaTax
|
|
|
57
108
|
#
|
|
58
109
|
# The tax code takes precedence over the tax code id if both are provided.
|
|
59
110
|
#
|
|
111
|
+
# Please provide all the countries of destination values as a valid two letter ISO-3166 country code.
|
|
112
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
113
|
+
#
|
|
60
114
|
# ### Security Policies
|
|
61
115
|
#
|
|
62
116
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -88,6 +142,27 @@ module AvaTax
|
|
|
88
142
|
def create_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
89
143
|
post(path, model, {}, AvaTax::VERSION) end
|
|
90
144
|
|
|
145
|
+
# Add custom parameters to an item.
|
|
146
|
+
#
|
|
147
|
+
# Add custom parameters to an item.
|
|
148
|
+
#
|
|
149
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
150
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
151
|
+
#
|
|
152
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
153
|
+
# that doesn't fit into the standard item fields.
|
|
154
|
+
#
|
|
155
|
+
# ### Security Policies
|
|
156
|
+
#
|
|
157
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
158
|
+
# Swagger Name: AvaTaxClient
|
|
159
|
+
# @param companyId [Integer] The ID of the company that owns this item custom parameter.
|
|
160
|
+
# @param itemId [Integer] The item id.
|
|
161
|
+
# @param model [ItemCustomParametersModel[]] The item custom parameters you wish to create.
|
|
162
|
+
# @return [ItemCustomParametersModel[]]
|
|
163
|
+
def create_item_custom_parameters(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
164
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
165
|
+
|
|
91
166
|
# Add parameters to an item.
|
|
92
167
|
#
|
|
93
168
|
# Add parameters to an item.
|
|
@@ -101,6 +176,8 @@ module AvaTax
|
|
|
101
176
|
# To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product`
|
|
102
177
|
#
|
|
103
178
|
# Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
|
|
179
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
180
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
104
181
|
#
|
|
105
182
|
# ### Security Policies
|
|
106
183
|
#
|
|
@@ -127,6 +204,9 @@ module AvaTax
|
|
|
127
204
|
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
|
128
205
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
|
129
206
|
#
|
|
207
|
+
# Please provide all the countries of destination values as a valid two letter ISO-3166 country code.
|
|
208
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
209
|
+
#
|
|
130
210
|
# The tax code takes precedence over the tax code id if both are provided.
|
|
131
211
|
#
|
|
132
212
|
# ### Security Policies
|
|
@@ -244,6 +324,27 @@ module AvaTax
|
|
|
244
324
|
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
|
245
325
|
delete(path, {}, AvaTax::VERSION) end
|
|
246
326
|
|
|
327
|
+
# Delete a single item custom parameter
|
|
328
|
+
#
|
|
329
|
+
# Delete a single item custom parameter.
|
|
330
|
+
#
|
|
331
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
332
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
333
|
+
#
|
|
334
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
335
|
+
# that doesn't fit into the standard item fields.
|
|
336
|
+
#
|
|
337
|
+
# ### Security Policies
|
|
338
|
+
#
|
|
339
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
340
|
+
# Swagger Name: AvaTaxClient
|
|
341
|
+
# @param companyId [Integer] The company id
|
|
342
|
+
# @param itemId [Integer] The item id
|
|
343
|
+
# @param id [Integer] The custom parameter id
|
|
344
|
+
# @return [ObjectDeletedErrorModel[]]
|
|
345
|
+
def delete_item_custom_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters/#{id}"
|
|
346
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
347
|
+
|
|
247
348
|
# Delete the image associated with an item.
|
|
248
349
|
#
|
|
249
350
|
# Delete the image associated with an item.
|
|
@@ -334,6 +435,19 @@ module AvaTax
|
|
|
334
435
|
def dismiss_h_s_code_classification_status(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hscode-classifications-status/$dismiss"
|
|
335
436
|
put(path, options, AvaTax::VERSION) end
|
|
336
437
|
|
|
438
|
+
# Fetch Additional HS Duty Details for items
|
|
439
|
+
#
|
|
440
|
+
# ### Security Policies
|
|
441
|
+
#
|
|
442
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
443
|
+
# Swagger Name: AvaTaxClient
|
|
444
|
+
# @param companyId [Integer] The ID of the company for which you want to get additional HS Duty Details.
|
|
445
|
+
# @param itemId [Integer]
|
|
446
|
+
# @param model [ItemAdditionalHSCodeDutyInputModel[]] Additional HS Code Duty Details input Model
|
|
447
|
+
# @return [ItemHSCodeDutyDetailModel[]]
|
|
448
|
+
def fetch_additional_h_s_code_duty_details(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hsdutydetails/$fetch-additional-hsdutydetails"
|
|
449
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
450
|
+
|
|
337
451
|
# Retrieve the HS code classification SLA details for a company.
|
|
338
452
|
#
|
|
339
453
|
# This endpoint returns the SLA details for HS code classification for the
|
|
@@ -389,6 +503,27 @@ module AvaTax
|
|
|
389
503
|
def get_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
|
390
504
|
get(path, {}, AvaTax::VERSION) end
|
|
391
505
|
|
|
506
|
+
# Retrieve a single item custom parameter
|
|
507
|
+
#
|
|
508
|
+
# Retrieve a single item custom parameter.
|
|
509
|
+
#
|
|
510
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
511
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
512
|
+
#
|
|
513
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
514
|
+
# that doesn't fit into the standard item fields.
|
|
515
|
+
#
|
|
516
|
+
# ### Security Policies
|
|
517
|
+
#
|
|
518
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
519
|
+
# Swagger Name: AvaTaxClient
|
|
520
|
+
# @param companyId [Integer] The company id
|
|
521
|
+
# @param itemId [Integer] The item id
|
|
522
|
+
# @param id [Integer] The custom parameter id
|
|
523
|
+
# @return [Object]
|
|
524
|
+
def get_item_custom_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters/#{id}"
|
|
525
|
+
get(path, {}, AvaTax::VERSION) end
|
|
526
|
+
|
|
392
527
|
# Retrieve a single item parameter
|
|
393
528
|
#
|
|
394
529
|
# Retrieve a single item parameter.
|
|
@@ -486,6 +621,22 @@ module AvaTax
|
|
|
486
621
|
def get_product_image(companyId, itemId, imageId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
|
|
487
622
|
get(path, {}, AvaTax::VERSION) end
|
|
488
623
|
|
|
624
|
+
# Get the real-time tax code recommendations for the specified items without saving item data.
|
|
625
|
+
#
|
|
626
|
+
# Provides immediate tax code recommendations for item details submitted in the request. Item data is processed only for recommendation purposes and is not persisted.
|
|
627
|
+
#
|
|
628
|
+
# Maximum items per request: 50 (subject to change).
|
|
629
|
+
#
|
|
630
|
+
# ### Security Policies
|
|
631
|
+
#
|
|
632
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
633
|
+
# Swagger Name: AvaTaxClient
|
|
634
|
+
# @param companyId [Integer] The unique ID of the company.
|
|
635
|
+
# @param model [ItemTaxcodeRecommendationBatchesInputModel[]] The list of items to analyze for tax code recommendations (maximum 50).
|
|
636
|
+
# @return [ItemTaxcodeRecommendationBatchesOutputModel[]]
|
|
637
|
+
def get_sync_tax_code_recommendations(companyId, model) path = "/api/v2/companies/#{companyId}/$taxcode-recommendations"
|
|
638
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
639
|
+
|
|
489
640
|
# Create an HS code classification request.
|
|
490
641
|
#
|
|
491
642
|
# ### Security Policies
|
|
@@ -550,6 +701,33 @@ module AvaTax
|
|
|
550
701
|
def list_item_classifications(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
551
702
|
get(path, options, AvaTax::VERSION) end
|
|
552
703
|
|
|
704
|
+
# Retrieve custom parameters for an item
|
|
705
|
+
#
|
|
706
|
+
# List custom parameters for an item.
|
|
707
|
+
#
|
|
708
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
709
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
710
|
+
#
|
|
711
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
712
|
+
# that doesn't fit into the standard item fields.
|
|
713
|
+
#
|
|
714
|
+
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
|
715
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
|
716
|
+
#
|
|
717
|
+
# ### Security Policies
|
|
718
|
+
#
|
|
719
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
720
|
+
# Swagger Name: AvaTaxClient
|
|
721
|
+
# @param companyId [Integer] The company id
|
|
722
|
+
# @param itemId [Integer] The item id
|
|
723
|
+
# @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:* id, name, value
|
|
724
|
+
# @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.
|
|
725
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
726
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
727
|
+
# @return [FetchResult]
|
|
728
|
+
def list_item_custom_parameters(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
729
|
+
get(path, options, AvaTax::VERSION) end
|
|
730
|
+
|
|
553
731
|
# Retrieve parameters for an item
|
|
554
732
|
#
|
|
555
733
|
# List parameters for an item.
|
|
@@ -645,7 +823,7 @@ module AvaTax
|
|
|
645
823
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
646
824
|
# Swagger Name: AvaTaxClient
|
|
647
825
|
# @param companyId [Integer] The ID of the company that defined these items
|
|
648
|
-
# @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
826
|
+
# @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
649
827
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
650
828
|
# @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.
|
|
651
829
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -724,7 +902,7 @@ module AvaTax
|
|
|
724
902
|
#
|
|
725
903
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
726
904
|
# Swagger Name: AvaTaxClient
|
|
727
|
-
# @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
905
|
+
# @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
728
906
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
729
907
|
# @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.
|
|
730
908
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -781,7 +959,7 @@ module AvaTax
|
|
|
781
959
|
# Swagger Name: AvaTaxClient
|
|
782
960
|
# @param companyId [Integer] The ID of the company that defined these items.
|
|
783
961
|
# @param tag [String] The master tag to be associated with item.
|
|
784
|
-
# @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
962
|
+
# @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
785
963
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
786
964
|
# @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.
|
|
787
965
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -804,6 +982,9 @@ module AvaTax
|
|
|
804
982
|
#
|
|
805
983
|
# Parameters and Classifications can be added with the Item.
|
|
806
984
|
#
|
|
985
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
986
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
987
|
+
#
|
|
807
988
|
# ### Security Policies
|
|
808
989
|
#
|
|
809
990
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -829,6 +1010,9 @@ module AvaTax
|
|
|
829
1010
|
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
|
830
1011
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
|
831
1012
|
#
|
|
1013
|
+
# Please provide all the countries of destination values as a valid two letter ISO-3166 country code.
|
|
1014
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
1015
|
+
#
|
|
832
1016
|
# ### Security Policies
|
|
833
1017
|
#
|
|
834
1018
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -908,6 +1092,28 @@ module AvaTax
|
|
|
908
1092
|
def update_item_classification(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
|
909
1093
|
put(path, model, {}, AvaTax::VERSION) end
|
|
910
1094
|
|
|
1095
|
+
# Update an item custom parameter
|
|
1096
|
+
#
|
|
1097
|
+
# Update an item custom parameter.
|
|
1098
|
+
#
|
|
1099
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
1100
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
1101
|
+
#
|
|
1102
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
1103
|
+
# that doesn't fit into the standard item fields.
|
|
1104
|
+
#
|
|
1105
|
+
# ### Security Policies
|
|
1106
|
+
#
|
|
1107
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
1108
|
+
# Swagger Name: AvaTaxClient
|
|
1109
|
+
# @param companyId [Integer] The company id.
|
|
1110
|
+
# @param itemId [Integer] The item id
|
|
1111
|
+
# @param id [Integer] The item custom parameter id
|
|
1112
|
+
# @param model [Object] The item custom parameter object you wish to update.
|
|
1113
|
+
# @return [Object]
|
|
1114
|
+
def update_item_custom_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters/#{id}"
|
|
1115
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
1116
|
+
|
|
911
1117
|
# Update an item parameter
|
|
912
1118
|
#
|
|
913
1119
|
# Update an item parameter.
|
|
@@ -918,6 +1124,9 @@ module AvaTax
|
|
|
918
1124
|
#
|
|
919
1125
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
|
920
1126
|
#
|
|
1127
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
1128
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
1129
|
+
#
|
|
921
1130
|
# ### Security Policies
|
|
922
1131
|
#
|
|
923
1132
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -969,6 +1178,27 @@ module AvaTax
|
|
|
969
1178
|
def upsert_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
970
1179
|
put(path, model, {}, AvaTax::VERSION) end
|
|
971
1180
|
|
|
1181
|
+
# Add/update an item custom parameter
|
|
1182
|
+
#
|
|
1183
|
+
# Add/update an item custom parameter.
|
|
1184
|
+
#
|
|
1185
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
1186
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
1187
|
+
#
|
|
1188
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
1189
|
+
# that doesn't fit into the standard item fields.
|
|
1190
|
+
#
|
|
1191
|
+
# ### Security Policies
|
|
1192
|
+
#
|
|
1193
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
1194
|
+
# Swagger Name: AvaTaxClient
|
|
1195
|
+
# @param companyId [Integer] The company id.
|
|
1196
|
+
# @param itemId [Integer] The item id
|
|
1197
|
+
# @param model [ItemCustomParametersModel[]] The item custom parameter object you wish to Upsert.
|
|
1198
|
+
# @return [ItemCustomParametersModel[]]
|
|
1199
|
+
def upsert_item_custom_parameter(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
1200
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
1201
|
+
|
|
972
1202
|
# Add/update an item parameter.
|
|
973
1203
|
#
|
|
974
1204
|
# Add/update an item parameter.
|
|
@@ -979,6 +1209,9 @@ module AvaTax
|
|
|
979
1209
|
#
|
|
980
1210
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
|
981
1211
|
#
|
|
1212
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
1213
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
1214
|
+
#
|
|
982
1215
|
# ### Security Policies
|
|
983
1216
|
#
|
|
984
1217
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
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: 25.
|
|
4
|
+
version: 25.12.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:
|
|
11
|
+
date: 2026-01-05 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|