avatax 25.3.3 → 25.6.2
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 +1 -1
- data/lib/avatax/client/clerk.rb +25 -0
- data/lib/avatax/client/companies.rb +1 -1
- data/lib/avatax/client/definitions.rb +5 -5
- data/lib/avatax/client/items.rb +116 -19
- data/lib/avatax/client/taxcodes.rb +5 -5
- data/lib/avatax/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce48ef793ea588f503d66bfd567f9d3a009a876cf6094f791cf6c7d3f44e35df
|
4
|
+
data.tar.gz: 811a0200131d1b55a6afe17b163b1418ba0d0bb98f42acdfc8caf4062b8d4276
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ff340760367854d44a712182f8618f24592a47bacf40cb536de3296c35750ccf225300b6bc2616e23230feb95dbc3e25ae1235ec34c63eaa086d0acaa78b7d28
|
7
|
+
data.tar.gz: 14f48aefc4bbdf32cc53e9d2ce305714a86a51e547e2b769999a288e00af89372f30fc2652be3455ce5f7fb7a233b599d38b98db65c5a8e17c57cd151ac385b5
|
data/.gitlab-ci.yml
CHANGED
@@ -0,0 +1,25 @@
|
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Clerk
|
4
|
+
|
5
|
+
|
6
|
+
# Retrieves a list of location records associated with the specified company.
|
7
|
+
# This endpoint is secured and requires appropriate subscription and permission levels.
|
8
|
+
#
|
9
|
+
# ### Security Policies
|
10
|
+
#
|
11
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
12
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
13
|
+
# Swagger Name: AvaTaxClient
|
14
|
+
# @param companyId [Integer] The unique identifier of the company whose locations are being requested.
|
15
|
+
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:
|
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/).<br />*Not filterable:* id
|
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 list_location_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/clerk/locations"
|
22
|
+
get(path, options, AvaTax::VERSION) end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -419,7 +419,7 @@ module AvaTax
|
|
419
419
|
# * 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.
|
420
420
|
# Swagger Name: AvaTaxClient
|
421
421
|
# @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
|
422
|
-
# @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
|
422
|
+
# @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave
|
423
423
|
# @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.
|
424
424
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
425
425
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
@@ -300,7 +300,7 @@ module AvaTax
|
|
300
300
|
#
|
301
301
|
# ### Security Policies
|
302
302
|
#
|
303
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
303
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
304
304
|
# Swagger Name: AvaTaxClient
|
305
305
|
# @return [ItemHSCodeClassificationStatusOutputModel[]]
|
306
306
|
def list_item_h_s_code_classification_status() path = "/api/v2/definitions/items/hscode-classification-status"
|
@@ -310,7 +310,7 @@ module AvaTax
|
|
310
310
|
#
|
311
311
|
# ### Security Policies
|
312
312
|
#
|
313
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
313
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
314
314
|
# Swagger Name: AvaTaxClient
|
315
315
|
# @return [ItemTaxCodeRecommendationStatusModel[]]
|
316
316
|
def list_items_recommendations_status() path = "/api/v2/definitions/items/recommendationstatus"
|
@@ -320,7 +320,7 @@ module AvaTax
|
|
320
320
|
#
|
321
321
|
# ### Security Policies
|
322
322
|
#
|
323
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
323
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
324
324
|
# Swagger Name: AvaTaxClient
|
325
325
|
# @return [ItemStatusModel[]]
|
326
326
|
def list_items_status() path = "/api/v2/definitions/items/status"
|
@@ -754,7 +754,7 @@ module AvaTax
|
|
754
754
|
#
|
755
755
|
# ### Security Policies
|
756
756
|
#
|
757
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
757
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
758
758
|
# Swagger Name: AvaTaxClient
|
759
759
|
# @param companyCode [String] Company code.
|
760
760
|
# @param itemCode [String] Item code.
|
@@ -1044,7 +1044,7 @@ module AvaTax
|
|
1044
1044
|
# Retrieves the list of Avalara-supported system tax codes.
|
1045
1045
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
1046
1046
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
1047
|
-
# If you identify your products by tax code in your 'Create
|
1047
|
+
# If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
|
1048
1048
|
# taxability rules for this product in all supported jurisdictions.
|
1049
1049
|
#
|
1050
1050
|
# ### Security Policies
|
data/lib/avatax/client/items.rb
CHANGED
@@ -236,6 +236,27 @@ module AvaTax
|
|
236
236
|
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
237
237
|
delete(path, {}, AvaTax::VERSION) end
|
238
238
|
|
239
|
+
# Delete the image associated with an item.
|
240
|
+
#
|
241
|
+
# Delete the image associated with an item.
|
242
|
+
#
|
243
|
+
# Permanently deletes both the image and its association with the specified item.
|
244
|
+
# This endpoint allows users to manage product visual representations by removing outdated or incorrect images,
|
245
|
+
# and cleaning up unused resources in the system.
|
246
|
+
# Once deleted, the image association cannot be recovered. To use the image again, it must be re-uploaded and
|
247
|
+
# re-linked with the item.
|
248
|
+
#
|
249
|
+
# ### Security Policies
|
250
|
+
#
|
251
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
252
|
+
# Swagger Name: AvaTaxClient
|
253
|
+
# @param companyId [Integer] The unique ID of the company.
|
254
|
+
# @param itemId [Integer] The unique ID of the item.
|
255
|
+
# @param imageId [String] The unique ID of the image to delete.
|
256
|
+
# @return [AssociatedObjectDeletedErrorDetailsModel[]]
|
257
|
+
def delete_item_image(companyId, itemId, imageId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
|
258
|
+
delete(path, {}, AvaTax::VERSION) end
|
259
|
+
|
239
260
|
# Delete a single item parameter
|
240
261
|
#
|
241
262
|
# Delete a single item parameter.
|
@@ -313,7 +334,7 @@ module AvaTax
|
|
313
334
|
#
|
314
335
|
# ### Security Policies
|
315
336
|
#
|
316
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
337
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
317
338
|
# Swagger Name: AvaTaxClient
|
318
339
|
# @param companyId [Integer] The ID of the company for which to retrieve the SLA details.
|
319
340
|
# @return [Object]
|
@@ -332,7 +353,7 @@ module AvaTax
|
|
332
353
|
#
|
333
354
|
# ### Security Policies
|
334
355
|
#
|
335
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
356
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
336
357
|
# Swagger Name: AvaTaxClient
|
337
358
|
# @param companyId [Integer] The ID of the company that owns this item object
|
338
359
|
# @param id [Integer] The primary key of this item
|
@@ -351,7 +372,7 @@ module AvaTax
|
|
351
372
|
#
|
352
373
|
# ### Security Policies
|
353
374
|
#
|
354
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
375
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
355
376
|
# Swagger Name: AvaTaxClient
|
356
377
|
# @param companyId [Integer] The company id.
|
357
378
|
# @param itemId [Integer] The item id.
|
@@ -372,7 +393,7 @@ module AvaTax
|
|
372
393
|
#
|
373
394
|
# ### Security Policies
|
374
395
|
#
|
375
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
396
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
376
397
|
# Swagger Name: AvaTaxClient
|
377
398
|
# @param companyId [Integer] The company id
|
378
399
|
# @param itemId [Integer] The item id
|
@@ -389,7 +410,7 @@ module AvaTax
|
|
389
410
|
#
|
390
411
|
# ### Security Policies
|
391
412
|
#
|
392
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
413
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
393
414
|
# Swagger Name: AvaTaxClient
|
394
415
|
# @param companyId [Integer] The ID of the company that defined these items
|
395
416
|
# @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
|
@@ -406,7 +427,7 @@ module AvaTax
|
|
406
427
|
#
|
407
428
|
# ### Security Policies
|
408
429
|
#
|
409
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
430
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
410
431
|
# Swagger Name: AvaTaxClient
|
411
432
|
# @param companyId [Integer]
|
412
433
|
# @param itemId [Integer]
|
@@ -429,7 +450,7 @@ module AvaTax
|
|
429
450
|
#
|
430
451
|
# ### Security Policies
|
431
452
|
#
|
432
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
453
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
433
454
|
# Swagger Name: AvaTaxClient
|
434
455
|
# @param companyId [Integer] The ID of the company that owns this item object
|
435
456
|
# @param itemCode [String] The ItemCode of the item for which you want to retrieve premium classification
|
@@ -439,6 +460,24 @@ module AvaTax
|
|
439
460
|
def get_premium_classification(companyId, itemCode, systemCode, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemCode}/premiumClassification/#{systemCode}"
|
440
461
|
get(path, options, AvaTax::VERSION) end
|
441
462
|
|
463
|
+
# Get the image associated with an item.
|
464
|
+
#
|
465
|
+
# Get the image file for the specified image ID linked to the item.
|
466
|
+
#
|
467
|
+
# This endpoint allows users to retrieve and display product images in user interfaces or to verify the current
|
468
|
+
# image associated with a specific item.
|
469
|
+
#
|
470
|
+
# ### Security Policies
|
471
|
+
#
|
472
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
473
|
+
# Swagger Name: AvaTaxClient
|
474
|
+
# @param companyId [Integer] The unique ID of the company.
|
475
|
+
# @param itemId [Integer] The unique ID of the item.
|
476
|
+
# @param imageId [String] The unique ID of the image to retrieve.
|
477
|
+
# @return [Object]
|
478
|
+
def get_product_image(companyId, itemId, imageId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
|
479
|
+
get(path, {}, AvaTax::VERSION) end
|
480
|
+
|
442
481
|
# Create an HS code classification request.
|
443
482
|
#
|
444
483
|
# ### Security Policies
|
@@ -466,7 +505,7 @@ module AvaTax
|
|
466
505
|
#
|
467
506
|
# ### Security Policies
|
468
507
|
#
|
469
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
508
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
470
509
|
# Swagger Name: AvaTaxClient
|
471
510
|
# @param companyId [Integer] The ID of the company that owns this item object
|
472
511
|
# @param itemCode [String] ItemCode for the item
|
@@ -491,7 +530,7 @@ module AvaTax
|
|
491
530
|
#
|
492
531
|
# ### Security Policies
|
493
532
|
#
|
494
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
533
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
495
534
|
# Swagger Name: AvaTaxClient
|
496
535
|
# @param companyId [Integer] The company id.
|
497
536
|
# @param itemId [Integer] The item id.
|
@@ -518,7 +557,7 @@ module AvaTax
|
|
518
557
|
#
|
519
558
|
# ### Security Policies
|
520
559
|
#
|
521
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
560
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
522
561
|
# Swagger Name: AvaTaxClient
|
523
562
|
# @param companyId [Integer] The company id
|
524
563
|
# @param itemId [Integer] The item id
|
@@ -545,7 +584,7 @@ module AvaTax
|
|
545
584
|
#
|
546
585
|
# ### Security Policies
|
547
586
|
#
|
548
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
587
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
549
588
|
# Swagger Name: AvaTaxClient
|
550
589
|
# @param companyId [Integer] The ID of the company that owns this item object.
|
551
590
|
# @param itemCode [String] The item code of the item for which you want to retrieve premium classification.
|
@@ -595,10 +634,10 @@ module AvaTax
|
|
595
634
|
#
|
596
635
|
# ### Security Policies
|
597
636
|
#
|
598
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
637
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
599
638
|
# Swagger Name: AvaTaxClient
|
600
639
|
# @param companyId [Integer] The ID of the company that defined these items
|
601
|
-
# @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
|
640
|
+
# @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
|
602
641
|
# @param include [String] A comma separated list of additional data to retrieve.
|
603
642
|
# @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.
|
604
643
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -621,7 +660,7 @@ module AvaTax
|
|
621
660
|
#
|
622
661
|
# ### Security Policies
|
623
662
|
#
|
624
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
663
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
625
664
|
# Swagger Name: AvaTaxClient
|
626
665
|
# @param companyId [Integer] Company Identifier.
|
627
666
|
# @param itemId [Integer] Item Identifier.
|
@@ -675,9 +714,9 @@ module AvaTax
|
|
675
714
|
#
|
676
715
|
# ### Security Policies
|
677
716
|
#
|
678
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
717
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
679
718
|
# Swagger Name: AvaTaxClient
|
680
|
-
# @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
|
719
|
+
# @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
|
681
720
|
# @param include [String] A comma separated list of additional data to retrieve.
|
682
721
|
# @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.
|
683
722
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -702,7 +741,7 @@ module AvaTax
|
|
702
741
|
#
|
703
742
|
# ### Security Policies
|
704
743
|
#
|
705
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
744
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
706
745
|
# Swagger Name: AvaTaxClient
|
707
746
|
# @param companyId [Integer] The ID of the company that defined these items
|
708
747
|
# @param systemCode [String] System code on the basis of which you want to filter Items
|
@@ -730,11 +769,11 @@ module AvaTax
|
|
730
769
|
#
|
731
770
|
# ### Security Policies
|
732
771
|
#
|
733
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
772
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
734
773
|
# Swagger Name: AvaTaxClient
|
735
774
|
# @param companyId [Integer] The ID of the company that defined these items.
|
736
775
|
# @param tag [String] The master tag to be associated with item.
|
737
|
-
# @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
|
776
|
+
# @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
|
738
777
|
# @param include [String] A comma separated list of additional data to retrieve.
|
739
778
|
# @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.
|
740
779
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -788,6 +827,25 @@ module AvaTax
|
|
788
827
|
def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/sync"
|
789
828
|
post(path, model, {}, AvaTax::VERSION) end
|
790
829
|
|
830
|
+
# Update an existing image for an item.
|
831
|
+
#
|
832
|
+
# This endpoint allows users to update the existing image associated with a specific item by uploading a new image file.
|
833
|
+
#
|
834
|
+
# The updated image serves as the item's visual representation and will be used for tax code recommendation purposes.
|
835
|
+
#
|
836
|
+
# Restrictions:
|
837
|
+
# - Supported formats: JPEG, GIF, PNG
|
838
|
+
# - Maximum file size: 10MB
|
839
|
+
# - Maximum file name length allowed: 200 characters
|
840
|
+
# Swagger Name: AvaTaxClient
|
841
|
+
# @param companyId [Integer] The unique ID of the company.
|
842
|
+
# @param itemId [Integer] The unique ID of the item.
|
843
|
+
# @param imageId [String] The unique ID of the image to update.
|
844
|
+
# @param imageFile [Object]
|
845
|
+
# @return [Object]
|
846
|
+
def update_image(companyId, itemId, imageId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
|
847
|
+
put(path, {}, AvaTax::VERSION) end
|
848
|
+
|
791
849
|
# Update a single item
|
792
850
|
#
|
793
851
|
# Replace the existing `Item` object at this URL with an updated object.
|
@@ -860,6 +918,24 @@ module AvaTax
|
|
860
918
|
def update_item_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
861
919
|
put(path, model, {}, AvaTax::VERSION) end
|
862
920
|
|
921
|
+
# Upload an image for an item.
|
922
|
+
#
|
923
|
+
# This endpoint allows users to upload an image file for a specific item.
|
924
|
+
#
|
925
|
+
# The uploaded image serves as the item's visual representation and will be used for tax code recommendation purposes.
|
926
|
+
#
|
927
|
+
# Restrictions:
|
928
|
+
# - Supported formats: JPEG, GIF, PNG
|
929
|
+
# - Maximum file size: 10MB
|
930
|
+
# - Maximum file name length allowed: 200 characters
|
931
|
+
# Swagger Name: AvaTaxClient
|
932
|
+
# @param companyId [Integer] The unique ID of the company.
|
933
|
+
# @param itemId [Integer] The unique ID of the item.
|
934
|
+
# @param imageFile [Object]
|
935
|
+
# @return [Object]
|
936
|
+
def upload_image(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/images"
|
937
|
+
post(path, {}, {}, AvaTax::VERSION) end
|
938
|
+
|
863
939
|
# Add/update item classifications.
|
864
940
|
#
|
865
941
|
# Add/update classifications to an item.
|
@@ -880,6 +956,27 @@ module AvaTax
|
|
880
956
|
# @return [ItemClassificationOutputModel[]]
|
881
957
|
def upsert_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
882
958
|
put(path, model, {}, AvaTax::VERSION) end
|
959
|
+
|
960
|
+
# Add/update an item parameter.
|
961
|
+
#
|
962
|
+
# Add/update an item parameter.
|
963
|
+
#
|
964
|
+
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
965
|
+
#
|
966
|
+
# A parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
|
967
|
+
#
|
968
|
+
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
969
|
+
#
|
970
|
+
# ### Security Policies
|
971
|
+
#
|
972
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
973
|
+
# Swagger Name: AvaTaxClient
|
974
|
+
# @param companyId [Integer] The ID of the company that this item belongs to.
|
975
|
+
# @param itemId [Integer] The ID of the item you want to update.
|
976
|
+
# @param model [ItemParameterModel[]] The item parameter object you want to upsert.
|
977
|
+
# @return [ItemParameterModel[]]
|
978
|
+
def upsert_item_parameter(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
979
|
+
put(path, model, {}, AvaTax::VERSION) end
|
883
980
|
end
|
884
981
|
end
|
885
982
|
end
|
@@ -8,7 +8,7 @@ module AvaTax
|
|
8
8
|
# Create one or more new taxcode objects attached to this company.
|
9
9
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
10
10
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
11
|
-
# If you identify your products by tax code in your 'Create
|
11
|
+
# If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
|
12
12
|
# taxability rules for this product in all supported jurisdictions.
|
13
13
|
#
|
14
14
|
# ### Security Policies
|
@@ -40,7 +40,7 @@ module AvaTax
|
|
40
40
|
# Get the taxcode object identified by this URL.
|
41
41
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
42
42
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
43
|
-
# If you identify your products by tax code in your 'Create
|
43
|
+
# If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
|
44
44
|
# taxability rules for this product in all supported jurisdictions.
|
45
45
|
#
|
46
46
|
# ### Security Policies
|
@@ -58,7 +58,7 @@ module AvaTax
|
|
58
58
|
# List all taxcode objects attached to this company.
|
59
59
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
60
60
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
61
|
-
# If you identify your products by tax code in your 'Create
|
61
|
+
# If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
|
62
62
|
# taxability rules for this product in all supported jurisdictions.
|
63
63
|
#
|
64
64
|
# 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/) .
|
@@ -83,7 +83,7 @@ module AvaTax
|
|
83
83
|
# Get multiple taxcode objects across all companies.
|
84
84
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
85
85
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
86
|
-
# If you identify your products by tax code in your 'Create
|
86
|
+
# If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
|
87
87
|
# taxability rules for this product in all supported jurisdictions.
|
88
88
|
#
|
89
89
|
# 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/) .
|
@@ -107,7 +107,7 @@ module AvaTax
|
|
107
107
|
# Replace the existing taxcode object at this URL with an updated object.
|
108
108
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
109
109
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
110
|
-
# If you identify your products by tax code in your 'Create
|
110
|
+
# If you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and
|
111
111
|
# taxability rules for this product in all supported jurisdictions.
|
112
112
|
# All data from the existing object will be replaced with data in the object you PUT.
|
113
113
|
# To set a field's value to null, you may either set its value to null or omit that field from the object you post.
|
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.6.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Marcus Vorwaller
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-06-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rake
|
@@ -128,6 +128,7 @@ files:
|
|
128
128
|
- lib/avatax/client/batches.rb
|
129
129
|
- lib/avatax/client/certexpressinvites.rb
|
130
130
|
- lib/avatax/client/certificates.rb
|
131
|
+
- lib/avatax/client/clerk.rb
|
131
132
|
- lib/avatax/client/communicationcertificates.rb
|
132
133
|
- lib/avatax/client/companies.rb
|
133
134
|
- lib/avatax/client/compliance.rb
|