avatax 24.4.2 → 24.6.1

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: 31751f7b24d24b44df16c17b3b8d376319397a7331c510979926989cf997bf0c
4
- data.tar.gz: 4d0dab28f959b7e1ae1a94aaca7116c4666613c7c503d662c436b0e669f0c5bf
3
+ metadata.gz: fcc1c5f0a2dd612483bc9128af65b7f57deb5e71b80805280d89daf02d4637f3
4
+ data.tar.gz: 63d6423b2640f46070d987d762cbec80e9eb42667924b0b762655e81255d667a
5
5
  SHA512:
6
- metadata.gz: 0ac34886147b236ca990b6e0a7c56b3b36122651cbdf84a829a0eb770a426728cd862ed0d64645ed7b9ab99600f2a2e55791b1a9351e55a86869d658db8a1db1
7
- data.tar.gz: 6ad5e07383574f98840ddfa54c3d506bee052efafa65d98c80b8ac17a64203fdb4f477cd77cc3e42e92624321a9f971d24b750d28698fca96356c71c304065b4
6
+ metadata.gz: 8188c0a1cb7f67498006bae3fbccc91a4d5859c970b4e0399b600424cc9315c1d4c6717fa6f6c18394d9247b10342dc62ab048ad2834869ac845dad4114f1944
7
+ data.tar.gz: cfd5890e1b606efea3778f745f7499cd003a28128f2471d7f598986fbf96d771d6910de9a8a7840a0d4276d4c7b14c132e7b6f1d101894e9e22da2378864774a
data/avatax.gemspec CHANGED
@@ -9,21 +9,6 @@ Gem::Specification.new do |s|
9
9
  s.add_runtime_dependency('activesupport', '>= 6.1.7')
10
10
  s.authors = ["Marcus Vorwaller"]
11
11
  s.description = %q{A Ruby wrapper for the AvaTax REST and Search APIs}
12
- s.post_install_message =<<eos
13
- ********************************************************************************
14
-
15
- AvaTax REST API
16
- ------------------------------
17
- Our developer site documents the AvaTax REST API.
18
- (https://developer.avalara.com).
19
- Blog
20
- ----------------------------
21
- The Developer Blog is a great place to learn more about the API and AvaTax integrations
22
- Subscribe to the RSS feed be notified of new posts:
23
- (https://developer.avalara.com/blogs).
24
-
25
- ********************************************************************************
26
- eos
27
12
  s.email = ['marcus.vorwaller@avalara.com']
28
13
  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
29
14
  s.files = `git ls-files`.split("\n")
@@ -130,7 +130,7 @@ module AvaTax
130
130
  # The list of parameters is available for use with Item Classification.
131
131
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
132
132
  # Swagger Name: AvaTaxClient
133
- # @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:* values
133
+ # @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:* attributeSubType, values
134
134
  # @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.
135
135
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
136
136
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -296,6 +296,26 @@ module AvaTax
296
296
  def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
297
297
  get(path, options, AvaTax::VERSION) end
298
298
 
299
+ # List of all recommendation status which can be assigned to an item
300
+ #
301
+ # ### Security Policies
302
+ #
303
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
304
+ # Swagger Name: AvaTaxClient
305
+ # @return [ItemTaxCodeRecommendationStatusModel[]]
306
+ def list_items_recommendations_status() path = "/api/v2/definitions/items/recommendationstatus"
307
+ get(path, {}, AvaTax::VERSION) end
308
+
309
+ # List of all possible status which can be assigned to an item
310
+ #
311
+ # ### Security Policies
312
+ #
313
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
314
+ # Swagger Name: AvaTaxClient
315
+ # @return [ItemStatusModel[]]
316
+ def list_items_status() path = "/api/v2/definitions/items/status"
317
+ get(path, {}, AvaTax::VERSION) end
318
+
299
319
  # List jurisdictions based on the filter provided
300
320
  #
301
321
  # Returns a list of all Avalara-supported taxing jurisdictions.
@@ -684,7 +704,7 @@ module AvaTax
684
704
  # This list of parameters is available for use when configuring your transaction.
685
705
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
686
706
  # Swagger Name: AvaTaxClient
687
- # @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:* serviceTypes, regularExpression, values
707
+ # @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:* serviceTypes, regularExpression, attributeSubType, values
688
708
  # @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.
689
709
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
690
710
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -697,7 +717,7 @@ module AvaTax
697
717
  # Returns the list of Avalara-supported parameters based on account subscriptions.
698
718
  # Swagger Name: AvaTaxClient
699
719
  # @param accountId [Integer] The ID of the account to retrieve the parameters.
700
- # @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:* serviceTypes, regularExpression, values
720
+ # @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:* serviceTypes, regularExpression, attributeSubType, values
701
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.
702
722
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
703
723
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -728,7 +748,7 @@ module AvaTax
728
748
  # Swagger Name: AvaTaxClient
729
749
  # @param companyCode [String] Company code.
730
750
  # @param itemCode [String] Item code.
731
- # @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:* serviceTypes, regularExpression, values
751
+ # @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:* serviceTypes, regularExpression, attributeSubType, values
732
752
  # @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.
733
753
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
734
754
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -742,7 +762,7 @@ module AvaTax
742
762
  # This list of parameters is available for use when configuring your transaction.
743
763
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
744
764
  # Swagger Name: AvaTaxClient
745
- # @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:* values, valueDescriptions
765
+ # @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:* attributeSubType, values, valueDescriptions
746
766
  # @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.
747
767
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
748
768
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -913,26 +933,13 @@ module AvaTax
913
933
  def list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type(companyId, country, taxTypeId, taxSubTypeId, rateTypeId, jurisdictionTypeId, options={}) path = "/api/v2/definitions/companies/#{companyId}/countries/#{country}/regions/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/rateTypeId/#{rateTypeId}/jurisdictionTypeId/#{jurisdictionTypeId}"
914
934
  get(path, options, AvaTax::VERSION) end
915
935
 
916
- # Retrieve the full list of Avalara-supported resource file types
917
- #
918
- # Returns the full list of Avalara-supported resource file types
919
- # This API is intended to be useful to identify all the different resource file types.
920
- # Swagger Name: AvaTaxClient
921
- # @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/).
922
- # @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.
923
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
924
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
925
- # @return [FetchResult]
926
- def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
927
- get(path, options, AvaTax::VERSION) end
928
-
929
936
  # Retrieve the full list of Avalara-supported usage of parameters used for returns.
930
937
  #
931
938
  # Returns the full list of Avalara-supported usage of extra parameters for the returns.
932
939
  # This list of parameters is available for use with Returns.
933
940
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
934
941
  # Swagger Name: AvaTaxClient
935
- # @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:* values
942
+ # @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:* attributeSubType, values
936
943
  # @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.
937
944
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
938
945
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -0,0 +1,74 @@
1
+ module AvaTax
2
+ class Client
3
+ module GLAccount
4
+
5
+
6
+ # Bulk upload GL accounts
7
+ #
8
+ # Allows a bulk upload of GL accounts for the specified company. Use the companyid path parameter to identify the company for which the GL accounts should be uploaded.
9
+ # Swagger Name: AvaTaxClient
10
+ # @param companyid [Integer] The ID of the company that owns this GL account object
11
+ # @param model [Object] The GL account bulk upload model.
12
+ # @return [Object]
13
+ def bulk_upload_g_l_accounts(companyid, model) path = "/api/v2/companies/#{companyid}/glaccounts/$upload"
14
+ post(path, model, {}, AvaTax::VERSION) end
15
+
16
+ # Create a new GL account
17
+ #
18
+ # Creates one or more new GL account objects attached to this company.
19
+ #
20
+ # A GL account is a general ledger account that can be passed to transactions at the line level to apply the multiple rules of the transactions, including exemptions, allocations, etc. to a specific general ledger.
21
+ # Swagger Name: AvaTaxClient
22
+ # @param companyid [Integer] The ID of the company that owns this GL Account object
23
+ # @param model [Object] The GL Account you want to create
24
+ # @return [Object]
25
+ def create_g_l_account(companyid, model) path = "/api/v2/companies/#{companyid}/glaccounts"
26
+ post(path, model, {}, AvaTax::VERSION) end
27
+
28
+ # Delete the GL account associated with the given company ID and GL account ID
29
+ #
30
+ # Deletes the GL account associated with the specified `glaccountid` and `companyid`
31
+ # Swagger Name: AvaTaxClient
32
+ # @param companyid [Integer] The ID of the company that owns this GL account object
33
+ # @param glaccountid [Integer] The primary key of this GL account
34
+ # @return [Object]
35
+ def delete_g_l_account(companyid, glaccountid) path = "/api/v2/companies/#{companyid}/glaccounts/#{glaccountid}"
36
+ delete(path, {}, AvaTax::VERSION) end
37
+
38
+ # Retrieve a single GL account
39
+ #
40
+ # Retrieve details of a single GL account identified by its `glaccountid` and `companyid`
41
+ # Swagger Name: AvaTaxClient
42
+ # @param companyid [Integer] The ID of the company that owns this GL account object
43
+ # @param glaccountid [Integer] The primary key of this GL account
44
+ # @return [Object]
45
+ def get_g_l_account_by_id(companyid, glaccountid) path = "/api/v2/companies/#{companyid}/glaccounts/#{glaccountid}"
46
+ get(path, {}, AvaTax::VERSION) end
47
+
48
+ # Retrieve GL accounts for this company
49
+ #
50
+ # Retrieves a list of GL accounts attached to this company. You can apply filters to retrieve specific records.
51
+ # Swagger Name: AvaTaxClient
52
+ # @param companyid [Integer] The ID of the company that owns these GL accounts
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:* companyId, meta, defaultItem
54
+ # @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.
55
+ # @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.
56
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
57
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
58
+ # @return [FetchResult]
59
+ def list_g_l_accounts_by_company(companyid, options={}) path = "/api/v2/companies/#{companyid}/glaccounts"
60
+ get(path, options, AvaTax::VERSION) end
61
+
62
+ # Update a single GL account
63
+ #
64
+ # Updates a single GL account owned by the company. Use the glaccountid path parameter to identify the GL account to update.
65
+ # Swagger Name: AvaTaxClient
66
+ # @param companyid [Integer] The ID of the company that owns this GL Account object
67
+ # @param glaccountid [Integer] The primary key of this GL Account
68
+ # @param model [Object] The GL account object you want to update
69
+ # @return [Object]
70
+ def update_g_l_account(companyid, glaccountid, model) path = "/api/v2/companies/#{companyid}/glaccounts/#{glaccountid}"
71
+ put(path, model, {}, AvaTax::VERSION) end
72
+ end
73
+ end
74
+ end
@@ -126,10 +126,11 @@ module AvaTax
126
126
  # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
127
127
  # Swagger Name: AvaTaxClient
128
128
  # @param companyId [Integer] The ID of the company that owns this item.
129
+ # @param processRecommendationsSynchronously [Boolean] If true then Indix api will be called synchronously to get tax code recommendations.
129
130
  # @param model [ItemModel[]] The item you wish to create.
130
131
  # @return [ItemModel[]]
131
- def create_items(companyId, model) path = "/api/v2/companies/#{companyId}/items"
132
- post(path, model, {}, AvaTax::VERSION) end
132
+ def create_items(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/items"
133
+ post(path, model, options, AvaTax::VERSION) end
133
134
 
134
135
  # Create tags for a item
135
136
  #
@@ -289,30 +290,6 @@ module AvaTax
289
290
  def delete_item_tags(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
290
291
  delete(path, {}, AvaTax::VERSION) end
291
292
 
292
- # Get status of classification requests of a company
293
- #
294
- # Get status of tax code classification requests of a company.
295
- #
296
- # Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and
297
- # major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes
298
- # allowing them to take advantage of thousands of tax rules in the AvaTax engine resulting in accurate taxability determinations.
299
- #
300
- # Enable includeClassificationDetails flag to get details of classification request status.
301
- #
302
- # ### Security Policies
303
- #
304
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
305
- # Swagger Name: AvaTaxClient
306
- # @param companyId [Integer] The ID of the company that defined these items
307
- # @param includeClassificationDetails [Boolean] A boolean field to get detailed classification status.
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:* classificationDetails, totalItems
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
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
311
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
312
- # @return [FetchResult]
313
- def get_classification_status(companyId, options={}) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode"
314
- get(path, options, AvaTax::VERSION) end
315
-
316
293
  # Retrieve a single item
317
294
  #
318
295
  # Get the `Item` object identified by this URL.
@@ -393,6 +370,20 @@ module AvaTax
393
370
  def get_item_tags(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
394
371
  get(path, options, AvaTax::VERSION) end
395
372
 
373
+ # Get Item TaxCode Recommendations
374
+ #
375
+ # Provides at least three tax-code recommendations for the given company ID and item ID
376
+ #
377
+ # ### Security Policies
378
+ #
379
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
380
+ # Swagger Name: AvaTaxClient
381
+ # @param companyId [Integer]
382
+ # @param itemId [Integer]
383
+ # @return [Object]
384
+ def get_item_tax_code_recommendations(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/taxcoderecommendations"
385
+ get(path, {}, AvaTax::VERSION) end
386
+
396
387
  # Retrieve premium classification for a company's item based on its ItemCode and SystemCode.
397
388
  #
398
389
  # Retrieves the premium classification for an ItemCode and SystemCode.
@@ -417,28 +408,6 @@ module AvaTax
417
408
  def get_premium_classification(companyId, itemCode, systemCode) path = "/api/v2/companies/#{companyId}/items/#{itemCode}/premiumClassification/#{systemCode}"
418
409
  get(path, {}, AvaTax::VERSION) end
419
410
 
420
- # Get tax code recommendations
421
- #
422
- # Get tax code recommendations.
423
- #
424
- # Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and
425
- # major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes
426
- # allowing them to take advantage of thousands of tax rules in the AvaTax engine resulting in accurate taxability determinations.
427
- #
428
- # ### Security Policies
429
- #
430
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
431
- # Swagger Name: AvaTaxClient
432
- # @param companyId [Integer] The ID of the company that defined these items
433
- # @param requestId [Integer] The ID of the classification request
434
- # @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:* recommendations, url
435
- # @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.
436
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
437
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
438
- # @return [FetchResult]
439
- def get_tax_code_recommendations(companyId, requestId, options={}) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode/#{requestId}/recommendations"
440
- get(path, options, AvaTax::VERSION) end
441
-
442
411
  # Retrieve Restrictions for Item by CountryOfImport
443
412
  #
444
413
  # Retrieve Restrictions for Item by CountryOfImport. This API will only return import restriction for the countryOfImport.
@@ -534,6 +503,10 @@ module AvaTax
534
503
  #
535
504
  # You may specify Tag Name in the `tagName` query parameter if you want to filter items on the basis of tagName
536
505
  #
506
+ # You may specify comma seperated item status in the `itemStatus` query parameter if you want to filter items on the basis of item status
507
+ #
508
+ # You may specify Tax Code recommendation status in the `taxCodeRecommendationStatus` query parameter if you want to filter items on the basis of tax code recommendation status
509
+ #
537
510
  # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
538
511
  #
539
512
  # * Parameters
@@ -546,12 +519,14 @@ module AvaTax
546
519
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
547
520
  # Swagger Name: AvaTaxClient
548
521
  # @param companyId [Integer] The ID of the company that defined these items
549
- # @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, upc, classifications, parameters, tags, properties
522
+ # @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
550
523
  # @param include [String] A comma separated list of additional data to retrieve.
551
524
  # @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.
552
525
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
553
526
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
554
527
  # @param tagName [String] Tag Name on the basis of which you want to filter Items
528
+ # @param itemStatus [String] A comma separated list of item status on the basis of which you want to filter Items
529
+ # @param taxCodeRecommendationStatus [String] Tax code recommendation status on the basis of which you want to filter Items
555
530
  # @return [FetchResult]
556
531
  def list_items_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/items"
557
532
  get(path, options, AvaTax::VERSION) end
@@ -574,7 +549,7 @@ module AvaTax
574
549
  #
575
550
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
576
551
  # Swagger Name: AvaTaxClient
577
- # @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, upc, classifications, parameters, tags, properties
552
+ # @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
578
553
  # @param include [String] A comma separated list of additional data to retrieve.
579
554
  # @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.
580
555
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -583,6 +558,34 @@ module AvaTax
583
558
  def query_items(options={}) path = "/api/v2/items"
584
559
  get(path, options, AvaTax::VERSION) end
585
560
 
561
+ # Retrieve items for this company based on System Code and filter criteria(optional) provided
562
+ #
563
+ # Retrieve items based on System Code
564
+ #
565
+ # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
566
+ # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
567
+ # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
568
+ # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
569
+ # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
570
+ #
571
+ # Search for specific objects by passing the `$filter` criteria in the body; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
572
+ #
573
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
574
+ #
575
+ # ### Security Policies
576
+ #
577
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
578
+ # Swagger Name: AvaTaxClient
579
+ # @param companyId [Integer] The ID of the company that defined these items
580
+ # @param systemCode [String] System code on the basis of which you want to filter Items
581
+ # @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.
582
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
583
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
584
+ # @param model [Object] A filter statement to select specific records, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .
585
+ # @return [FetchResult]
586
+ def query_items_by_system_code(companyId, systemCode, model, options={}) path = "/api/v2/companies/#{companyId}/items/internal/bySystemCode/#{systemCode}"
587
+ post(path, model, options, AvaTax::VERSION) end
588
+
586
589
  # Retrieve all items associated with given tag
587
590
  #
588
591
  # Get multiple item objects associated with given tag.
@@ -603,7 +606,7 @@ module AvaTax
603
606
  # Swagger Name: AvaTaxClient
604
607
  # @param companyId [Integer] The ID of the company that defined these items.
605
608
  # @param tag [String] The master tag to be associated with item.
606
- # @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, upc, classifications, parameters, tags, properties
609
+ # @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
607
610
  # @param include [String] A comma separated list of additional data to retrieve.
608
611
  # @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.
609
612
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '24.4.2'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '24.6.1'.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: 24.4.2
4
+ version: 24.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcus Vorwaller
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-23 00:00:00.000000000 Z
11
+ date: 2024-06-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -144,6 +144,7 @@ files:
144
144
  - lib/avatax/client/firmclientlinkages.rb
145
145
  - lib/avatax/client/free.rb
146
146
  - lib/avatax/client/fundingrequests.rb
147
+ - lib/avatax/client/glaccount.rb
147
148
  - lib/avatax/client/items.rb
148
149
  - lib/avatax/client/jurisdictionoverrides.rb
149
150
  - lib/avatax/client/locations.rb
@@ -185,20 +186,7 @@ files:
185
186
  homepage: https://github.com/avadev/AvaTax-REST-V2-Ruby-SDK
186
187
  licenses: []
187
188
  metadata: {}
188
- post_install_message: |
189
- ********************************************************************************
190
-
191
- AvaTax REST API
192
- ------------------------------
193
- Our developer site documents the AvaTax REST API.
194
- (https://developer.avalara.com).
195
- Blog
196
- ----------------------------
197
- The Developer Blog is a great place to learn more about the API and AvaTax integrations
198
- Subscribe to the RSS feed be notified of new posts:
199
- (https://developer.avalara.com/blogs).
200
-
201
- ********************************************************************************
189
+ post_install_message:
202
190
  rdoc_options: []
203
191
  require_paths:
204
192
  - lib