avatax 24.4.2 → 24.6.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/avatax.gemspec +0 -15
- data/lib/avatax/client/certificates.rb +1 -1
- data/lib/avatax/client/customers.rb +2 -2
- data/lib/avatax/client/definitions.rb +26 -19
- data/lib/avatax/client/glaccount.rb +74 -0
- data/lib/avatax/client/items.rb +66 -61
- data/lib/avatax/version.rb +1 -1
- metadata +4 -16
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 21716b9e05b88f595006b01020571986eb1dbcc40b5fc9cc15a95b7e01d46f78
|
4
|
+
data.tar.gz: 45ff66124db89843e7da211c9dc016647e9d05926db499dbdf7ead56039d664d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8f939dcbbd650e6e91152478f65e7165bd074bc358db68efadf3fcbcb064b8edffb8d7164bf95a06447de128d594e5a01e87a8d06f758d0c9a8468126d65830d
|
7
|
+
data.tar.gz: 875e1c67817e98f2da5943b1c8352b648a03eadef6d8636b2095e7b4d7287675fc5bbf2292fcec1052bc7c1845e6f53daced8fe2340d5200da9080a3828f703e
|
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")
|
@@ -291,7 +291,7 @@ module AvaTax
|
|
291
291
|
# Swagger Name: AvaTaxClient
|
292
292
|
# @param companyId [Integer] The ID number of the company to search
|
293
293
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
294
|
-
# @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
|
294
|
+
# @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:* exemptionNumber, status, ecmStatus, ecmsId, ecmsStatus, pdf, pages
|
295
295
|
# @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.
|
296
296
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
297
297
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
@@ -228,7 +228,7 @@ module AvaTax
|
|
228
228
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
229
229
|
# @param customerCode [String] The unique code representing this customer
|
230
230
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
231
|
-
# @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
|
231
|
+
# @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:* exemptionNumber, status, ecmStatus, ecmsId, ecmsStatus, pdf, pages
|
232
232
|
# @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.
|
233
233
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
234
234
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
@@ -294,7 +294,7 @@ module AvaTax
|
|
294
294
|
# Swagger Name: AvaTaxClient
|
295
295
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
296
296
|
# @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
|
297
|
-
# @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/)
|
297
|
+
# @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/).
|
298
298
|
# @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.
|
299
299
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
300
300
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
@@ -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
|
data/lib/avatax/client/items.rb
CHANGED
@@ -17,7 +17,7 @@ module AvaTax
|
|
17
17
|
# Swagger Name: AvaTaxClient
|
18
18
|
# @param companyId [Integer] The ID of the company that owns this item.
|
19
19
|
# @param itemId [Integer] The ID of the item you wish to delete the classifications.
|
20
|
-
# @return [
|
20
|
+
# @return [AssociatedObjectDeletedErrorDetailsModel[]]
|
21
21
|
def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
22
22
|
delete(path, {}, AvaTax::VERSION) end
|
23
23
|
|
@@ -37,7 +37,7 @@ module AvaTax
|
|
37
37
|
# Swagger Name: AvaTaxClient
|
38
38
|
# @param companyId [Integer] The ID of the company that owns this item.
|
39
39
|
# @param itemId [Integer] The ID of the item you wish to delete the parameters.
|
40
|
-
# @return [
|
40
|
+
# @return [AssociatedObjectDeletedErrorDetailsModel[]]
|
41
41
|
def batch_delete_item_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
42
42
|
delete(path, {}, AvaTax::VERSION) end
|
43
43
|
|
@@ -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,
|
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
|
#
|
@@ -190,7 +191,7 @@ module AvaTax
|
|
190
191
|
# Swagger Name: AvaTaxClient
|
191
192
|
# @param companyId [Integer] The ID of the company that owns this item.
|
192
193
|
# @param itemCode [String] The code of the item you want to delete.
|
193
|
-
# @return [
|
194
|
+
# @return [ObjectDeletedErrorModel[]]
|
194
195
|
def delete_catalogue_item(companyId, itemCode) path = "/api/v2/companies/#{companyId}/itemcatalogue/#{itemCode}"
|
195
196
|
delete(path, {}, AvaTax::VERSION) end
|
196
197
|
|
@@ -212,7 +213,7 @@ module AvaTax
|
|
212
213
|
# Swagger Name: AvaTaxClient
|
213
214
|
# @param companyId [Integer] The ID of the company that owns this item.
|
214
215
|
# @param id [Integer] The ID of the item you wish to delete.
|
215
|
-
# @return [
|
216
|
+
# @return [ObjectDeletedErrorModel[]]
|
216
217
|
def delete_item(companyId, id) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
217
218
|
delete(path, {}, AvaTax::VERSION) end
|
218
219
|
|
@@ -231,7 +232,7 @@ module AvaTax
|
|
231
232
|
# @param companyId [Integer] The company id.
|
232
233
|
# @param itemId [Integer] The item id.
|
233
234
|
# @param id [Integer] The item classification id.
|
234
|
-
# @return [
|
235
|
+
# @return [ObjectDeletedErrorModel[]]
|
235
236
|
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
236
237
|
delete(path, {}, AvaTax::VERSION) end
|
237
238
|
|
@@ -252,7 +253,7 @@ module AvaTax
|
|
252
253
|
# @param companyId [Integer] The company id
|
253
254
|
# @param itemId [Integer] The item id
|
254
255
|
# @param id [Integer] The parameter id
|
255
|
-
# @return [
|
256
|
+
# @return [ObjectDeletedErrorModel[]]
|
256
257
|
def delete_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
257
258
|
delete(path, {}, AvaTax::VERSION) end
|
258
259
|
|
@@ -269,7 +270,7 @@ module AvaTax
|
|
269
270
|
# @param companyId [Integer] The ID of the company that defined these items
|
270
271
|
# @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
|
271
272
|
# @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
|
272
|
-
# @return [
|
273
|
+
# @return [ObjectDeletedErrorModel[]]
|
273
274
|
def delete_item_tag(companyId, itemId, itemTagDetailId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
|
274
275
|
delete(path, {}, AvaTax::VERSION) end
|
275
276
|
|
@@ -285,34 +286,10 @@ module AvaTax
|
|
285
286
|
# Swagger Name: AvaTaxClient
|
286
287
|
# @param companyId [Integer] The ID of the company that defined these items.
|
287
288
|
# @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
|
288
|
-
# @return [
|
289
|
+
# @return [AssociatedObjectDeletedErrorDetailsModel[]]
|
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 [TaxCodeRecommendationOutputModel[]]
|
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,24 +503,31 @@ 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
|
540
513
|
# * Classifications
|
541
514
|
# * Tags
|
542
515
|
# * Properties
|
516
|
+
# * TaxCodeRecommendationStatus
|
543
517
|
#
|
544
518
|
# ### Security Policies
|
545
519
|
#
|
546
520
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
547
521
|
# Swagger Name: AvaTaxClient
|
548
522
|
# @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
|
523
|
+
# @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
|
550
524
|
# @param include [String] A comma separated list of additional data to retrieve.
|
551
525
|
# @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
526
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
553
527
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
554
528
|
# @param tagName [String] Tag Name on the basis of which you want to filter Items
|
529
|
+
# @param itemStatus [String] A comma separated list of item status on the basis of which you want to filter Items
|
530
|
+
# @param taxCodeRecommendationStatus [String] Tax code recommendation status on the basis of which you want to filter Items
|
555
531
|
# @return [FetchResult]
|
556
532
|
def list_items_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/items"
|
557
533
|
get(path, options, AvaTax::VERSION) end
|
@@ -574,7 +550,7 @@ module AvaTax
|
|
574
550
|
#
|
575
551
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
576
552
|
# 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
|
553
|
+
# @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
|
578
554
|
# @param include [String] A comma separated list of additional data to retrieve.
|
579
555
|
# @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
556
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -583,6 +559,34 @@ module AvaTax
|
|
583
559
|
def query_items(options={}) path = "/api/v2/items"
|
584
560
|
get(path, options, AvaTax::VERSION) end
|
585
561
|
|
562
|
+
# Retrieve items for this company based on System Code and filter criteria(optional) provided
|
563
|
+
#
|
564
|
+
# Retrieve items based on System Code
|
565
|
+
#
|
566
|
+
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
567
|
+
# can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
|
568
|
+
# and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
|
569
|
+
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
570
|
+
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
571
|
+
#
|
572
|
+
# 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/) .
|
573
|
+
#
|
574
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
575
|
+
#
|
576
|
+
# ### Security Policies
|
577
|
+
#
|
578
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
579
|
+
# Swagger Name: AvaTaxClient
|
580
|
+
# @param companyId [Integer] The ID of the company that defined these items
|
581
|
+
# @param systemCode [String] System code on the basis of which you want to filter Items
|
582
|
+
# @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.
|
583
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
584
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
585
|
+
# @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 .
|
586
|
+
# @return [FetchResult]
|
587
|
+
def query_items_by_system_code(companyId, systemCode, model, options={}) path = "/api/v2/companies/#{companyId}/items/internal/bySystemCode/#{systemCode}"
|
588
|
+
post(path, model, options, AvaTax::VERSION) end
|
589
|
+
|
586
590
|
# Retrieve all items associated with given tag
|
587
591
|
#
|
588
592
|
# Get multiple item objects associated with given tag.
|
@@ -603,7 +607,7 @@ module AvaTax
|
|
603
607
|
# Swagger Name: AvaTaxClient
|
604
608
|
# @param companyId [Integer] The ID of the company that defined these items.
|
605
609
|
# @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
|
610
|
+
# @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
|
607
611
|
# @param include [String] A comma separated list of additional data to retrieve.
|
608
612
|
# @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
613
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -678,10 +682,11 @@ module AvaTax
|
|
678
682
|
# Swagger Name: AvaTaxClient
|
679
683
|
# @param companyId [Integer] The ID of the company that this item belongs to.
|
680
684
|
# @param id [Integer] The ID of the item you wish to update
|
685
|
+
# @param isRecommendationSelected [Boolean] If true then Set recommendation status to RecommendationSelected
|
681
686
|
# @param model [Object] The item object you wish to update.
|
682
687
|
# @return [Object]
|
683
|
-
def update_item(companyId, id, model) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
684
|
-
put(path, model,
|
688
|
+
def update_item(companyId, id, model, options={}) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
689
|
+
put(path, model, options, AvaTax::VERSION) end
|
685
690
|
|
686
691
|
# Update an item classification.
|
687
692
|
#
|
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: 24.
|
4
|
+
version: 24.6.3
|
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-
|
11
|
+
date: 2024-06-27 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
|