avatax 25.9.0 → 25.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/definitions.rb +7 -1
- data/lib/avatax/client/items.rb +249 -4
- data/lib/avatax/client/registrar.rb +1 -1
- data/lib/avatax/client/vendorcertificates.rb +49 -0
- data/lib/avatax/client/vendors.rb +126 -0
- data/lib/avatax/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: af2b5ed138e7475d9c17c94c93f86018025244fe25f928210d3e93c6d16fa0f4
|
|
4
|
+
data.tar.gz: 040e5c28099d3545fb5fd137e7dac11eb64b12ae19cc7ca47946384e89a3c8a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e01adeb897025a42c791daab9c1739eac45257e0d57e8f44683afa6554f41a749687ded1dcf08e0400eaefdcaa023d098c093a70bcd94ac13b6309756630b3ef
|
|
7
|
+
data.tar.gz: 82ed1212ba259e8117dcd19010da314c183559b46dc86fd4ffd03d051d64d1b384cb898c646f2118adb009f0dce753553c186c19ca0e0f744ea3f7623b0e3672
|
|
@@ -82,7 +82,7 @@ module AvaTax
|
|
|
82
82
|
#
|
|
83
83
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
|
84
84
|
# Swagger Name: AvaTaxClient
|
|
85
|
-
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId
|
|
85
|
+
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId, isCustomContent
|
|
86
86
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
|
87
87
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
88
88
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -388,6 +388,7 @@ module AvaTax
|
|
|
388
388
|
# @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.
|
|
389
389
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
390
390
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
391
|
+
# @param includeCustomContent [Boolean] Optional query parameter to include custom content jurisdictions (default: false)
|
|
391
392
|
# @return [FetchResult]
|
|
392
393
|
def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
|
|
393
394
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -416,6 +417,7 @@ module AvaTax
|
|
|
416
417
|
# @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
|
|
417
418
|
# @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
|
|
418
419
|
# @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
|
|
420
|
+
# @param includeCustomContent [Boolean] Optional query parameter to include custom content jurisdiction types (default: false)
|
|
419
421
|
# @return [string[]]
|
|
420
422
|
def list_jurisdiction_types_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictionTypes/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
|
|
421
423
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -891,6 +893,7 @@ module AvaTax
|
|
|
891
893
|
# @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.
|
|
892
894
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
893
895
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
896
|
+
# @param includeCustomContent [Boolean] Optional query parameter to include custom content rate types (default: false)
|
|
894
897
|
# @return [FetchResult]
|
|
895
898
|
def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
|
|
896
899
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -939,6 +942,7 @@ module AvaTax
|
|
|
939
942
|
# @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.
|
|
940
943
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
941
944
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
945
|
+
# @param includeCustomContent [Boolean] Optional query parameter to include custom content regions (default: false)
|
|
942
946
|
# @return [FetchResult]
|
|
943
947
|
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}"
|
|
944
948
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -978,7 +982,7 @@ module AvaTax
|
|
|
978
982
|
# You may always contact Avalara's sales department for information on available products or services.
|
|
979
983
|
# You cannot change your subscriptions directly through the API.
|
|
980
984
|
# Swagger Name: AvaTaxClient
|
|
981
|
-
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxTypeGroupIdSK
|
|
985
|
+
# @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:* system, taxTypeGroupIdSK
|
|
982
986
|
# @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.
|
|
983
987
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
984
988
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -1109,6 +1113,7 @@ module AvaTax
|
|
|
1109
1113
|
# @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.
|
|
1110
1114
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
1111
1115
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
1116
|
+
# @param includeCustomContent [Boolean] Optional query parameter to include custom content tax sub types (default: false)
|
|
1112
1117
|
# @return [FetchResult]
|
|
1113
1118
|
def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
|
|
1114
1119
|
get(path, options, AvaTax::VERSION) end
|
|
@@ -1150,6 +1155,7 @@ module AvaTax
|
|
|
1150
1155
|
# @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.
|
|
1151
1156
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
1152
1157
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
1158
|
+
# @param includeCustomContent [Boolean] Optional query parameter to include custom content tax types (default: false)
|
|
1153
1159
|
# @return [FetchResult]
|
|
1154
1160
|
def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
|
|
1155
1161
|
get(path, options, AvaTax::VERSION) end
|
data/lib/avatax/client/items.rb
CHANGED
|
@@ -3,6 +3,37 @@ module AvaTax
|
|
|
3
3
|
module Items
|
|
4
4
|
|
|
5
5
|
|
|
6
|
+
# Parse natural language query into structured filters
|
|
7
|
+
#
|
|
8
|
+
# Parse natural language queries into structured API filters. This endpoint forwards the query to NLQ (Natural Language Query)
|
|
9
|
+
# service for interpretation and returns only the intent and structured filters.
|
|
10
|
+
#
|
|
11
|
+
# Example queries:
|
|
12
|
+
# - "give me items created in last 1 week which are having status complete"
|
|
13
|
+
# - "show me all items with item code CERMUG"
|
|
14
|
+
# - "find items containing 'mug' in description"
|
|
15
|
+
#
|
|
16
|
+
# Response format:
|
|
17
|
+
# {
|
|
18
|
+
# "intent": "GET",
|
|
19
|
+
# "filters": {
|
|
20
|
+
# "createdDate": { "value": "from: 2025-09-12 to: 2025-09-19" },
|
|
21
|
+
# "itemStatus": { "value": ["Complete"] }
|
|
22
|
+
# }
|
|
23
|
+
# }
|
|
24
|
+
#
|
|
25
|
+
# Raw NLQ responses are logged for debugging purposes.
|
|
26
|
+
#
|
|
27
|
+
# ### Security Policies
|
|
28
|
+
#
|
|
29
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
30
|
+
# Swagger Name: AvaTaxClient
|
|
31
|
+
# @param companyId [Integer] The ID of the company that owns these items
|
|
32
|
+
# @param model [Object] Natural language search request
|
|
33
|
+
# @return [Object]
|
|
34
|
+
def a_isearch(companyId, model) path = "/api/v2/companies/#{companyId}/items/nlq/$parse"
|
|
35
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
36
|
+
|
|
6
37
|
# Delete all classifications for an item
|
|
7
38
|
#
|
|
8
39
|
# Delete all the classifications for a given item.
|
|
@@ -21,6 +52,26 @@ module AvaTax
|
|
|
21
52
|
def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
22
53
|
delete(path, {}, AvaTax::VERSION) end
|
|
23
54
|
|
|
55
|
+
# Delete all custom parameters for an item
|
|
56
|
+
#
|
|
57
|
+
# Delete all the custom parameters for a given item.
|
|
58
|
+
#
|
|
59
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
60
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
61
|
+
#
|
|
62
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
63
|
+
# that doesn't fit into the standard item fields.
|
|
64
|
+
#
|
|
65
|
+
# ### Security Policies
|
|
66
|
+
#
|
|
67
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
68
|
+
# Swagger Name: AvaTaxClient
|
|
69
|
+
# @param companyId [Integer] The ID of the company that owns this item.
|
|
70
|
+
# @param itemId [Integer] The ID of the item you wish to delete the custom parameters.
|
|
71
|
+
# @return [AssociatedObjectDeletedErrorDetailsModel[]]
|
|
72
|
+
def batch_delete_item_custom_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
73
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
74
|
+
|
|
24
75
|
# Delete all parameters for an item
|
|
25
76
|
#
|
|
26
77
|
# Delete all the parameters for a given item.
|
|
@@ -45,6 +96,10 @@ module AvaTax
|
|
|
45
96
|
#
|
|
46
97
|
# Create/Update one or more item objects attached to this company.
|
|
47
98
|
#
|
|
99
|
+
# Recommended number of items to create/update in a single call is upto 100.
|
|
100
|
+
#
|
|
101
|
+
# Currently, the maximum number of items that can be created/updated in a single call is 500 (This limit is subject to change).
|
|
102
|
+
#
|
|
48
103
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
|
49
104
|
# can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
|
|
50
105
|
# and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
|
|
@@ -53,6 +108,9 @@ module AvaTax
|
|
|
53
108
|
#
|
|
54
109
|
# The tax code takes precedence over the tax code id if both are provided.
|
|
55
110
|
#
|
|
111
|
+
# Please provide all the countries of destination values as a valid two letter ISO-3166 country code.
|
|
112
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
113
|
+
#
|
|
56
114
|
# ### Security Policies
|
|
57
115
|
#
|
|
58
116
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -84,6 +142,27 @@ module AvaTax
|
|
|
84
142
|
def create_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
85
143
|
post(path, model, {}, AvaTax::VERSION) end
|
|
86
144
|
|
|
145
|
+
# Add custom parameters to an item.
|
|
146
|
+
#
|
|
147
|
+
# Add custom parameters to an item.
|
|
148
|
+
#
|
|
149
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
150
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
151
|
+
#
|
|
152
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
153
|
+
# that doesn't fit into the standard item fields.
|
|
154
|
+
#
|
|
155
|
+
# ### Security Policies
|
|
156
|
+
#
|
|
157
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
158
|
+
# Swagger Name: AvaTaxClient
|
|
159
|
+
# @param companyId [Integer] The ID of the company that owns this item custom parameter.
|
|
160
|
+
# @param itemId [Integer] The item id.
|
|
161
|
+
# @param model [ItemCustomParametersModel[]] The item custom parameters you wish to create.
|
|
162
|
+
# @return [ItemCustomParametersModel[]]
|
|
163
|
+
def create_item_custom_parameters(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
164
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
165
|
+
|
|
87
166
|
# Add parameters to an item.
|
|
88
167
|
#
|
|
89
168
|
# Add parameters to an item.
|
|
@@ -97,6 +176,8 @@ module AvaTax
|
|
|
97
176
|
# To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product`
|
|
98
177
|
#
|
|
99
178
|
# Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
|
|
179
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
180
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
100
181
|
#
|
|
101
182
|
# ### Security Policies
|
|
102
183
|
#
|
|
@@ -113,12 +194,19 @@ module AvaTax
|
|
|
113
194
|
#
|
|
114
195
|
# Creates one or more new item objects attached to this company.
|
|
115
196
|
#
|
|
197
|
+
# Recommended number of items to create in a single call is upto 50.
|
|
198
|
+
#
|
|
199
|
+
# Currently, the maximum number of items that can be created in a single call is 500 (This limit is subject to change).
|
|
200
|
+
#
|
|
116
201
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
|
117
202
|
# can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
|
|
118
203
|
# and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
|
|
119
204
|
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
|
120
205
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
|
121
206
|
#
|
|
207
|
+
# Please provide all the countries of destination values as a valid two letter ISO-3166 country code.
|
|
208
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
209
|
+
#
|
|
122
210
|
# The tax code takes precedence over the tax code id if both are provided.
|
|
123
211
|
#
|
|
124
212
|
# ### Security Policies
|
|
@@ -236,6 +324,27 @@ module AvaTax
|
|
|
236
324
|
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
|
237
325
|
delete(path, {}, AvaTax::VERSION) end
|
|
238
326
|
|
|
327
|
+
# Delete a single item custom parameter
|
|
328
|
+
#
|
|
329
|
+
# Delete a single item custom parameter.
|
|
330
|
+
#
|
|
331
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
332
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
333
|
+
#
|
|
334
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
335
|
+
# that doesn't fit into the standard item fields.
|
|
336
|
+
#
|
|
337
|
+
# ### Security Policies
|
|
338
|
+
#
|
|
339
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
340
|
+
# Swagger Name: AvaTaxClient
|
|
341
|
+
# @param companyId [Integer] The company id
|
|
342
|
+
# @param itemId [Integer] The item id
|
|
343
|
+
# @param id [Integer] The custom parameter id
|
|
344
|
+
# @return [ObjectDeletedErrorModel[]]
|
|
345
|
+
def delete_item_custom_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters/#{id}"
|
|
346
|
+
delete(path, {}, AvaTax::VERSION) end
|
|
347
|
+
|
|
239
348
|
# Delete the image associated with an item.
|
|
240
349
|
#
|
|
241
350
|
# Delete the image associated with an item.
|
|
@@ -326,6 +435,19 @@ module AvaTax
|
|
|
326
435
|
def dismiss_h_s_code_classification_status(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hscode-classifications-status/$dismiss"
|
|
327
436
|
put(path, options, AvaTax::VERSION) end
|
|
328
437
|
|
|
438
|
+
# Fetch Additional HS Duty Details for items
|
|
439
|
+
#
|
|
440
|
+
# ### Security Policies
|
|
441
|
+
#
|
|
442
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
443
|
+
# Swagger Name: AvaTaxClient
|
|
444
|
+
# @param companyId [Integer] The ID of the company for which you want to get additional HS Duty Details.
|
|
445
|
+
# @param itemId [Integer]
|
|
446
|
+
# @param model [ItemAdditionalHSCodeDutyInputModel[]] Additional HS Code Duty Details input Model
|
|
447
|
+
# @return [ItemHSCodeDutyDetailModel[]]
|
|
448
|
+
def fetch_additional_h_s_code_duty_details(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/hsdutydetails/$fetch-additional-hsdutydetails"
|
|
449
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
450
|
+
|
|
329
451
|
# Retrieve the HS code classification SLA details for a company.
|
|
330
452
|
#
|
|
331
453
|
# This endpoint returns the SLA details for HS code classification for the
|
|
@@ -381,6 +503,27 @@ module AvaTax
|
|
|
381
503
|
def get_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
|
382
504
|
get(path, {}, AvaTax::VERSION) end
|
|
383
505
|
|
|
506
|
+
# Retrieve a single item custom parameter
|
|
507
|
+
#
|
|
508
|
+
# Retrieve a single item custom parameter.
|
|
509
|
+
#
|
|
510
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
511
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
512
|
+
#
|
|
513
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
514
|
+
# that doesn't fit into the standard item fields.
|
|
515
|
+
#
|
|
516
|
+
# ### Security Policies
|
|
517
|
+
#
|
|
518
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
519
|
+
# Swagger Name: AvaTaxClient
|
|
520
|
+
# @param companyId [Integer] The company id
|
|
521
|
+
# @param itemId [Integer] The item id
|
|
522
|
+
# @param id [Integer] The custom parameter id
|
|
523
|
+
# @return [Object]
|
|
524
|
+
def get_item_custom_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters/#{id}"
|
|
525
|
+
get(path, {}, AvaTax::VERSION) end
|
|
526
|
+
|
|
384
527
|
# Retrieve a single item parameter
|
|
385
528
|
#
|
|
386
529
|
# Retrieve a single item parameter.
|
|
@@ -478,6 +621,22 @@ module AvaTax
|
|
|
478
621
|
def get_product_image(companyId, itemId, imageId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/images/#{imageId}"
|
|
479
622
|
get(path, {}, AvaTax::VERSION) end
|
|
480
623
|
|
|
624
|
+
# Get the real-time tax code recommendations for the specified items without saving item data.
|
|
625
|
+
#
|
|
626
|
+
# Provides immediate tax code recommendations for item details submitted in the request. Item data is processed only for recommendation purposes and is not persisted.
|
|
627
|
+
#
|
|
628
|
+
# Maximum items per request: 50 (subject to change).
|
|
629
|
+
#
|
|
630
|
+
# ### Security Policies
|
|
631
|
+
#
|
|
632
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
633
|
+
# Swagger Name: AvaTaxClient
|
|
634
|
+
# @param companyId [Integer] The unique ID of the company.
|
|
635
|
+
# @param model [ItemTaxcodeRecommendationBatchesInputModel[]] The list of items to analyze for tax code recommendations (maximum 50).
|
|
636
|
+
# @return [ItemTaxcodeRecommendationBatchesOutputModel[]]
|
|
637
|
+
def get_sync_tax_code_recommendations(companyId, model) path = "/api/v2/companies/#{companyId}/$taxcode-recommendations"
|
|
638
|
+
post(path, model, {}, AvaTax::VERSION) end
|
|
639
|
+
|
|
481
640
|
# Create an HS code classification request.
|
|
482
641
|
#
|
|
483
642
|
# ### Security Policies
|
|
@@ -542,6 +701,33 @@ module AvaTax
|
|
|
542
701
|
def list_item_classifications(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
543
702
|
get(path, options, AvaTax::VERSION) end
|
|
544
703
|
|
|
704
|
+
# Retrieve custom parameters for an item
|
|
705
|
+
#
|
|
706
|
+
# List custom parameters for an item.
|
|
707
|
+
#
|
|
708
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
709
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
710
|
+
#
|
|
711
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
712
|
+
# that doesn't fit into the standard item fields.
|
|
713
|
+
#
|
|
714
|
+
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
|
715
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
|
716
|
+
#
|
|
717
|
+
# ### Security Policies
|
|
718
|
+
#
|
|
719
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
720
|
+
# Swagger Name: AvaTaxClient
|
|
721
|
+
# @param companyId [Integer] The company id
|
|
722
|
+
# @param itemId [Integer] The item id
|
|
723
|
+
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* id, name, value
|
|
724
|
+
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
|
725
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
726
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
727
|
+
# @return [FetchResult]
|
|
728
|
+
def list_item_custom_parameters(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
729
|
+
get(path, options, AvaTax::VERSION) end
|
|
730
|
+
|
|
545
731
|
# Retrieve parameters for an item
|
|
546
732
|
#
|
|
547
733
|
# List parameters for an item.
|
|
@@ -637,7 +823,7 @@ module AvaTax
|
|
|
637
823
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
638
824
|
# Swagger Name: AvaTaxClient
|
|
639
825
|
# @param companyId [Integer] The ID of the company that defined these items
|
|
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
|
|
826
|
+
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
641
827
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
642
828
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
|
643
829
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -716,7 +902,7 @@ module AvaTax
|
|
|
716
902
|
#
|
|
717
903
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
718
904
|
# Swagger Name: AvaTaxClient
|
|
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
|
|
905
|
+
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
720
906
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
721
907
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
|
722
908
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -773,7 +959,7 @@ module AvaTax
|
|
|
773
959
|
# Swagger Name: AvaTaxClient
|
|
774
960
|
# @param companyId [Integer] The ID of the company that defined these items.
|
|
775
961
|
# @param tag [String] The master tag to be associated with item.
|
|
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
|
|
962
|
+
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image
|
|
777
963
|
# @param include [String] A comma separated list of additional data to retrieve.
|
|
778
964
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
|
779
965
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
@@ -786,12 +972,19 @@ module AvaTax
|
|
|
786
972
|
#
|
|
787
973
|
# Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company.
|
|
788
974
|
#
|
|
975
|
+
# Recommended number of items to create/update in a single call is upto 100.
|
|
976
|
+
#
|
|
977
|
+
# Currently, the maximum number of items that can be created/updated in a single call is 1000 (This limit is subject to change).
|
|
978
|
+
#
|
|
789
979
|
# Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to create
|
|
790
980
|
# a new or update an existing item. This can be used to sync the items with Avalara. For example, an accounting software
|
|
791
981
|
# system can use this to sync all their items from an ERP with Avalara.
|
|
792
982
|
#
|
|
793
983
|
# Parameters and Classifications can be added with the Item.
|
|
794
984
|
#
|
|
985
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
986
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
987
|
+
#
|
|
795
988
|
# ### Security Policies
|
|
796
989
|
#
|
|
797
990
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -809,7 +1002,7 @@ module AvaTax
|
|
|
809
1002
|
#
|
|
810
1003
|
# Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information.
|
|
811
1004
|
#
|
|
812
|
-
# This API is currently limited to
|
|
1005
|
+
# This API is currently limited to 500 items per call (the limit is subject to change).
|
|
813
1006
|
#
|
|
814
1007
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
|
815
1008
|
# can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
|
|
@@ -817,6 +1010,9 @@ module AvaTax
|
|
|
817
1010
|
# from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
|
|
818
1011
|
# team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
|
|
819
1012
|
#
|
|
1013
|
+
# Please provide all the countries of destination values as a valid two letter ISO-3166 country code.
|
|
1014
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
1015
|
+
#
|
|
820
1016
|
# ### Security Policies
|
|
821
1017
|
#
|
|
822
1018
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -896,6 +1092,28 @@ module AvaTax
|
|
|
896
1092
|
def update_item_classification(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
|
897
1093
|
put(path, model, {}, AvaTax::VERSION) end
|
|
898
1094
|
|
|
1095
|
+
# Update an item custom parameter
|
|
1096
|
+
#
|
|
1097
|
+
# Update an item custom parameter.
|
|
1098
|
+
#
|
|
1099
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
1100
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
1101
|
+
#
|
|
1102
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
1103
|
+
# that doesn't fit into the standard item fields.
|
|
1104
|
+
#
|
|
1105
|
+
# ### Security Policies
|
|
1106
|
+
#
|
|
1107
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
1108
|
+
# Swagger Name: AvaTaxClient
|
|
1109
|
+
# @param companyId [Integer] The company id.
|
|
1110
|
+
# @param itemId [Integer] The item id
|
|
1111
|
+
# @param id [Integer] The item custom parameter id
|
|
1112
|
+
# @param model [Object] The item custom parameter object you wish to update.
|
|
1113
|
+
# @return [Object]
|
|
1114
|
+
def update_item_custom_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters/#{id}"
|
|
1115
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
1116
|
+
|
|
899
1117
|
# Update an item parameter
|
|
900
1118
|
#
|
|
901
1119
|
# Update an item parameter.
|
|
@@ -906,6 +1124,9 @@ module AvaTax
|
|
|
906
1124
|
#
|
|
907
1125
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
|
908
1126
|
#
|
|
1127
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
1128
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
1129
|
+
#
|
|
909
1130
|
# ### Security Policies
|
|
910
1131
|
#
|
|
911
1132
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -957,6 +1178,27 @@ module AvaTax
|
|
|
957
1178
|
def upsert_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
|
958
1179
|
put(path, model, {}, AvaTax::VERSION) end
|
|
959
1180
|
|
|
1181
|
+
# Add/update an item custom parameter
|
|
1182
|
+
#
|
|
1183
|
+
# Add/update an item custom parameter.
|
|
1184
|
+
#
|
|
1185
|
+
# Custom parameters provide extra information about an item that can be used for various business purposes.
|
|
1186
|
+
# These parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.
|
|
1187
|
+
#
|
|
1188
|
+
# Custom parameters can be used to store custom attributes, metadata, or any other supplementary information
|
|
1189
|
+
# that doesn't fit into the standard item fields.
|
|
1190
|
+
#
|
|
1191
|
+
# ### Security Policies
|
|
1192
|
+
#
|
|
1193
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
1194
|
+
# Swagger Name: AvaTaxClient
|
|
1195
|
+
# @param companyId [Integer] The company id.
|
|
1196
|
+
# @param itemId [Integer] The item id
|
|
1197
|
+
# @param model [ItemCustomParametersModel[]] The item custom parameter object you wish to Upsert.
|
|
1198
|
+
# @return [ItemCustomParametersModel[]]
|
|
1199
|
+
def upsert_item_custom_parameter(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/custom-parameters"
|
|
1200
|
+
put(path, model, {}, AvaTax::VERSION) end
|
|
1201
|
+
|
|
960
1202
|
# Add/update an item parameter.
|
|
961
1203
|
#
|
|
962
1204
|
# Add/update an item parameter.
|
|
@@ -967,6 +1209,9 @@ module AvaTax
|
|
|
967
1209
|
#
|
|
968
1210
|
# A parameter specified on a transaction line will override an item parameter if they share the same parameter name.
|
|
969
1211
|
#
|
|
1212
|
+
# Please provide all the countries parameter values as a valid two letter ISO-3166 country code.
|
|
1213
|
+
# Refer to 'ListCountries' api to get valid country code for any country if needed.
|
|
1214
|
+
#
|
|
970
1215
|
# ### Security Policies
|
|
971
1216
|
#
|
|
972
1217
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
|
@@ -135,7 +135,7 @@ module AvaTax
|
|
|
135
135
|
#
|
|
136
136
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
|
137
137
|
# Swagger Name: AvaTaxClient
|
|
138
|
-
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxTypeGroupIdSK
|
|
138
|
+
# @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:* system, taxTypeGroupIdSK
|
|
139
139
|
# @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.
|
|
140
140
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
141
141
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
module AvaTax
|
|
2
|
+
class Client
|
|
3
|
+
module VendorCertificates
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
# List all vendor certificates for a company
|
|
7
|
+
#
|
|
8
|
+
# List all certificates recorded by a company
|
|
9
|
+
#
|
|
10
|
+
# A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
|
|
11
|
+
# can contain information about a vendor's eligibility for exemption from sales or use taxes based on
|
|
12
|
+
# criteria you specify when you store the certificate. To view or manage your certificates directly, please
|
|
13
|
+
# log onto the administrative website for the product you purchased.
|
|
14
|
+
#
|
|
15
|
+
# You can use the `$include` parameter to fetch the following additional objects for expansion:
|
|
16
|
+
#
|
|
17
|
+
# * customers - Retrieves the list of vendors linked to the certificate.
|
|
18
|
+
# * po_numbers - Retrieves all PO numbers tied to the certificate.
|
|
19
|
+
# * attributes - Retrieves all attributes applied to the certificate.
|
|
20
|
+
# * histories - Retrieves the certificate update history
|
|
21
|
+
# * jobs - Retrieves the jobs for this certificate
|
|
22
|
+
# * logs - Retrieves the certificate log
|
|
23
|
+
# * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
|
|
24
|
+
# * custom_fields - Retrieves custom fields set for this certificate
|
|
25
|
+
#
|
|
26
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
27
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
28
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
29
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
30
|
+
#
|
|
31
|
+
# Note* Filtering not supported for any documentType field.
|
|
32
|
+
#
|
|
33
|
+
# ### Security Policies
|
|
34
|
+
#
|
|
35
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
36
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
37
|
+
# Swagger Name: AvaTaxClient
|
|
38
|
+
# @param companyId [Integer] The ID number of the company to search
|
|
39
|
+
# @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 vendors linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
|
|
40
|
+
# @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:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages
|
|
41
|
+
# @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.
|
|
42
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
43
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
44
|
+
# @return [FetchResult]
|
|
45
|
+
def query_vendor_certificates(companyId, options={}) path = "/#{companyId}/vendor-certificates"
|
|
46
|
+
get(path, options, AvaTax::VERSION) end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
module AvaTax
|
|
2
|
+
class Client
|
|
3
|
+
module Vendors
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
# Retrieve a single vendor
|
|
7
|
+
#
|
|
8
|
+
# Retrieve the vendor identified by this URL.
|
|
9
|
+
#
|
|
10
|
+
# A vendor object defines information about a person or business that purchases products from your
|
|
11
|
+
# company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
|
|
12
|
+
# record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
|
|
13
|
+
# identify any certificates linked to this vendor object. If any certificate applies to the transaction,
|
|
14
|
+
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
15
|
+
#
|
|
16
|
+
# You can use the `$include` parameter to fetch the following additional objects for expansion:
|
|
17
|
+
#
|
|
18
|
+
# * certificates - Fetch a list of certificates linked to this vendor.
|
|
19
|
+
# * attributes - Retrieves all attributes applied to the vendor.
|
|
20
|
+
# * active_certificates - Retrieves all the active certificates linked to this vendor
|
|
21
|
+
# * histories - Retrieves the update history for this vendor
|
|
22
|
+
# * logs - Retrieves vendor logs
|
|
23
|
+
# * jobs - Retrieves vendor jobs
|
|
24
|
+
# * billTos - Retrieves bill-tos linked with this vendor
|
|
25
|
+
# * shipTos - Retrieves ship-tos linked with this vendor
|
|
26
|
+
# * shipToStates - Retrieves ship-to states for this vendor
|
|
27
|
+
# * custom_fields - Retrieves custom fields set for this vendor
|
|
28
|
+
#
|
|
29
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
30
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
31
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
32
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
33
|
+
#
|
|
34
|
+
# ### Security Policies
|
|
35
|
+
#
|
|
36
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
37
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
38
|
+
# Swagger Name: AvaTaxClient
|
|
39
|
+
# @param companyId [Integer] The unique ID number of the company that recorded this vendor
|
|
40
|
+
# @param vendorCode [String]
|
|
41
|
+
# @param include [String] Specify optional additional objects to include in this fetch request
|
|
42
|
+
# @return [Object]
|
|
43
|
+
def get_vendor(companyId, vendorCode, options={}) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}"
|
|
44
|
+
get(path, options, AvaTax::VERSION) end
|
|
45
|
+
|
|
46
|
+
# List certificates linked to a vendor
|
|
47
|
+
#
|
|
48
|
+
# List all certificates linked to a vendor.
|
|
49
|
+
#
|
|
50
|
+
# A vendor object defines information about a person or business that purchases products from your
|
|
51
|
+
# company. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
|
|
52
|
+
# record in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and
|
|
53
|
+
# identify any certificates linked to this `vendor` object. If any certificate applies to the transaction,
|
|
54
|
+
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
55
|
+
#
|
|
56
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
57
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
58
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
59
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
60
|
+
#
|
|
61
|
+
# You can filter certificates by exposure zone name using the $filter parameter with the syntax:
|
|
62
|
+
# `$filter=exposureZoneName eq 'ZoneName'` or `$filter=contains(exposureZoneName,'PartialName')`
|
|
63
|
+
#
|
|
64
|
+
# ### Security Policies
|
|
65
|
+
#
|
|
66
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
67
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
68
|
+
# Swagger Name: AvaTaxClient
|
|
69
|
+
# @param companyId [Integer] The unique ID number of the company that recorded this vendor
|
|
70
|
+
# @param vendorCode [String] The unique code representing this vendor
|
|
71
|
+
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * vendors - Retrieves the list of vendors linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
|
|
72
|
+
# @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:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages
|
|
73
|
+
# @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.
|
|
74
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
75
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
76
|
+
# @return [FetchResult]
|
|
77
|
+
def list_certificates_for_vendor(companyId, vendorCode, options={}) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}/certificates"
|
|
78
|
+
get(path, options, AvaTax::VERSION) end
|
|
79
|
+
|
|
80
|
+
# List all vendors for this company
|
|
81
|
+
#
|
|
82
|
+
# List all vendors recorded by this company matching the specified criteria.
|
|
83
|
+
#
|
|
84
|
+
# A vendor object defines information about a person or business that purchases products from your
|
|
85
|
+
# company. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
|
|
86
|
+
# record in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and
|
|
87
|
+
# identify any certificates linked to this `vendor` object. If any certificate applies to the transaction,
|
|
88
|
+
# AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
|
|
89
|
+
#
|
|
90
|
+
# You can use the `$include` parameter to fetch the following additional objects for expansion:
|
|
91
|
+
#
|
|
92
|
+
# * certificates - Fetch a list of certificates linked to this vendor.
|
|
93
|
+
# * attributes - Retrieves all attributes applied to the vendor.
|
|
94
|
+
# * active_certificates - Retrieves all the active certificates linked to this vendor
|
|
95
|
+
# * histories - Retrieves the update history for this vendor
|
|
96
|
+
# * logs - Retrieves vendor logs
|
|
97
|
+
# * jobs - Retrieves vendor jobs
|
|
98
|
+
# * billTos - Retrieves bill-tos linked with this vendor
|
|
99
|
+
# * shipTos - Retrieves ship-tos linked with this vendor
|
|
100
|
+
# * shipToStates - Retrieves ship-to states for this vendor
|
|
101
|
+
# * custom_fields - Retrieves custom fields set for this vendor
|
|
102
|
+
#
|
|
103
|
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
|
|
104
|
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
|
|
105
|
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
|
|
106
|
+
# certificate storage for this company, call `RequestCertificateSetup`.
|
|
107
|
+
#
|
|
108
|
+
# Note* Filtering not supported for isVendor field.
|
|
109
|
+
#
|
|
110
|
+
# ### Security Policies
|
|
111
|
+
#
|
|
112
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
|
113
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
|
|
114
|
+
# Swagger Name: AvaTaxClient
|
|
115
|
+
# @param companyId [Integer] The unique ID number of the company that recorded this vendor
|
|
116
|
+
# @param include [String] OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.
|
|
117
|
+
# @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/).
|
|
118
|
+
# @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.
|
|
119
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
|
120
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
|
121
|
+
# @return [FetchResult]
|
|
122
|
+
def query_vendors(companyId, options={}) path = "/api/v2/companies/#{companyId}/vendors"
|
|
123
|
+
get(path, options, AvaTax::VERSION) end
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
data/lib/avatax/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: avatax
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 25.
|
|
4
|
+
version: 25.12.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Marcus Vorwaller
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2026-01-05 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rake
|
|
@@ -176,6 +176,8 @@ files:
|
|
|
176
176
|
- lib/avatax/client/userdefinedfields.rb
|
|
177
177
|
- lib/avatax/client/users.rb
|
|
178
178
|
- lib/avatax/client/utilities.rb
|
|
179
|
+
- lib/avatax/client/vendorcertificates.rb
|
|
180
|
+
- lib/avatax/client/vendors.rb
|
|
179
181
|
- lib/avatax/configuration.rb
|
|
180
182
|
- lib/avatax/connection.rb
|
|
181
183
|
- lib/avatax/request.rb
|