avatax 23.1.0 → 23.3.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/avatax.gemspec +1 -1
- data/lib/avatax/client/accounts.rb +17 -17
- data/lib/avatax/client/addresses.rb +2 -2
- data/lib/avatax/client/advancedrules.rb +5 -5
- data/lib/avatax/client/ageverification.rb +4 -4
- data/lib/avatax/client/avafileforms.rb +5 -5
- data/lib/avatax/client/batches.rb +8 -8
- data/lib/avatax/client/certexpressinvites.rb +3 -3
- data/lib/avatax/client/certificates.rb +15 -15
- data/lib/avatax/client/companies.rb +36 -36
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/contacts.rb +6 -6
- data/lib/avatax/client/customers.rb +13 -13
- data/lib/avatax/client/datasources.rb +9 -9
- data/lib/avatax/client/definitions.rb +82 -82
- data/lib/avatax/client/distancethresholds.rb +6 -6
- data/lib/avatax/client/ecommercetoken.rb +4 -4
- data/lib/avatax/client/firmclientlinkages.rb +11 -11
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +3 -3
- data/lib/avatax/client/items.rb +46 -46
- data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
- data/lib/avatax/client/locations.rb +18 -18
- data/lib/avatax/client/multidocument.rb +10 -10
- data/lib/avatax/client/nexus.rb +15 -15
- data/lib/avatax/client/notices.rb +4 -4
- data/lib/avatax/client/notifications.rb +6 -6
- data/lib/avatax/client/provisioning.rb +2 -2
- data/lib/avatax/client/registrar.rb +14 -14
- data/lib/avatax/client/reports.rb +4 -4
- data/lib/avatax/client/settings.rb +9 -9
- data/lib/avatax/client/shippingverification.rb +4 -4
- data/lib/avatax/client/subscriptions.rb +3 -3
- data/lib/avatax/client/taxcodes.rb +6 -6
- data/lib/avatax/client/taxcontent.rb +8 -8
- data/lib/avatax/client/taxrules.rb +6 -6
- data/lib/avatax/client/transactions.rb +24 -24
- data/lib/avatax/client/upcs.rb +6 -6
- data/lib/avatax/client/userdefinedfields.rb +4 -4
- data/lib/avatax/client/users.rb +12 -12
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/version.rb +1 -1
- data/spec/spec_helper.rb +1 -0
- metadata +4 -4
@@ -19,7 +19,7 @@ module AvaTax
|
|
19
19
|
# @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
|
20
20
|
# @return [CompanyDistanceThresholdModel[]]
|
21
21
|
def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
|
22
|
-
post(path, model, {},
|
22
|
+
post(path, model, {}, AvaTax::VERSION) end
|
23
23
|
|
24
24
|
# Delete a single DistanceThreshold object
|
25
25
|
#
|
@@ -37,7 +37,7 @@ module AvaTax
|
|
37
37
|
# @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
|
38
38
|
# @return [ErrorDetail[]]
|
39
39
|
def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
|
40
|
-
delete(path, {},
|
40
|
+
delete(path, {}, AvaTax::VERSION) end
|
41
41
|
|
42
42
|
# Retrieve a single DistanceThreshold
|
43
43
|
#
|
@@ -55,7 +55,7 @@ module AvaTax
|
|
55
55
|
# @param id [Integer] The unique ID number referring to this DistanceThreshold object
|
56
56
|
# @return [Object]
|
57
57
|
def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
|
58
|
-
get(path, {},
|
58
|
+
get(path, {}, AvaTax::VERSION) end
|
59
59
|
|
60
60
|
# Retrieve all DistanceThresholds for this company.
|
61
61
|
#
|
@@ -77,7 +77,7 @@ module AvaTax
|
|
77
77
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
78
78
|
# @return [FetchResult]
|
79
79
|
def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
|
80
|
-
get(path, options,
|
80
|
+
get(path, options, AvaTax::VERSION) end
|
81
81
|
|
82
82
|
# Retrieve all DistanceThreshold objects
|
83
83
|
#
|
@@ -101,7 +101,7 @@ module AvaTax
|
|
101
101
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
102
102
|
# @return [FetchResult]
|
103
103
|
def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
|
104
|
-
get(path, options,
|
104
|
+
get(path, options, AvaTax::VERSION) end
|
105
105
|
|
106
106
|
# Update a DistanceThreshold object
|
107
107
|
#
|
@@ -123,7 +123,7 @@ module AvaTax
|
|
123
123
|
# @param model [Object] The new DistanceThreshold object to store.
|
124
124
|
# @return [Object]
|
125
125
|
def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
|
126
|
-
put(path, model, {},
|
126
|
+
put(path, model, {}, AvaTax::VERSION) end
|
127
127
|
end
|
128
128
|
end
|
129
129
|
end
|
@@ -11,13 +11,13 @@ module AvaTax
|
|
11
11
|
#
|
12
12
|
# ### Security Policies
|
13
13
|
#
|
14
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
14
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
15
15
|
# Swagger Name: AvaTaxClient
|
16
16
|
# @param companyId [Integer] The company ID that will be issued this certificate.
|
17
17
|
# @param model [Object]
|
18
18
|
# @return [Object]
|
19
19
|
def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
|
20
|
-
post(path, model, {},
|
20
|
+
post(path, model, {}, AvaTax::VERSION) end
|
21
21
|
|
22
22
|
# Refresh an eCommerce token.
|
23
23
|
#
|
@@ -27,13 +27,13 @@ module AvaTax
|
|
27
27
|
#
|
28
28
|
# ### Security Policies
|
29
29
|
#
|
30
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
31
31
|
# Swagger Name: AvaTaxClient
|
32
32
|
# @param companyId [Integer] The company ID that the refreshed certificate belongs to.
|
33
33
|
# @param model [Object]
|
34
34
|
# @return [FetchResult]
|
35
35
|
def refresh_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
|
36
|
-
put(path, model, {},
|
36
|
+
put(path, model, {}, AvaTax::VERSION) end
|
37
37
|
end
|
38
38
|
end
|
39
39
|
end
|
@@ -14,7 +14,7 @@ module AvaTax
|
|
14
14
|
# @param id [Integer]
|
15
15
|
# @return [Object]
|
16
16
|
def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
|
17
|
-
post(path, {},
|
17
|
+
post(path, {}, {}, AvaTax::VERSION) end
|
18
18
|
|
19
19
|
# Request a new FirmClient account and create an approved linkage to it
|
20
20
|
#
|
@@ -36,7 +36,7 @@ module AvaTax
|
|
36
36
|
# @param model [Object] Information about the account you wish to create.
|
37
37
|
# @return [Object]
|
38
38
|
def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
|
39
|
-
post(path, model, {},
|
39
|
+
post(path, model, {}, AvaTax::VERSION) end
|
40
40
|
|
41
41
|
# Links a firm account with the client account
|
42
42
|
#
|
@@ -49,7 +49,7 @@ module AvaTax
|
|
49
49
|
# @param model [Object] FirmClientLinkageInputModel
|
50
50
|
# @return [Object]
|
51
51
|
def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
|
52
|
-
post(path, model, {},
|
52
|
+
post(path, model, {}, AvaTax::VERSION) end
|
53
53
|
|
54
54
|
# Delete a linkage
|
55
55
|
#
|
@@ -62,7 +62,7 @@ module AvaTax
|
|
62
62
|
# @param id [Integer]
|
63
63
|
# @return [ErrorDetail[]]
|
64
64
|
def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
|
65
|
-
delete(path, {},
|
65
|
+
delete(path, {}, AvaTax::VERSION) end
|
66
66
|
|
67
67
|
# Get linkage between a firm and client by id
|
68
68
|
#
|
@@ -70,12 +70,12 @@ module AvaTax
|
|
70
70
|
#
|
71
71
|
# ### Security Policies
|
72
72
|
#
|
73
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
73
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
74
74
|
# Swagger Name: AvaTaxClient
|
75
75
|
# @param id [Integer]
|
76
76
|
# @return [Object]
|
77
77
|
def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
|
78
|
-
get(path, {},
|
78
|
+
get(path, {}, AvaTax::VERSION) end
|
79
79
|
|
80
80
|
# List client linkages for a firm or client
|
81
81
|
#
|
@@ -83,12 +83,12 @@ module AvaTax
|
|
83
83
|
#
|
84
84
|
# ### Security Policies
|
85
85
|
#
|
86
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
86
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
87
87
|
# Swagger Name: AvaTaxClient
|
88
88
|
# @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:* firmAccountName, clientAccountName
|
89
89
|
# @return [FetchResult]
|
90
90
|
def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
|
91
|
-
get(path, options,
|
91
|
+
get(path, options, AvaTax::VERSION) end
|
92
92
|
|
93
93
|
# Rejects linkage to a firm for a client account
|
94
94
|
#
|
@@ -101,7 +101,7 @@ module AvaTax
|
|
101
101
|
# @param id [Integer]
|
102
102
|
# @return [Object]
|
103
103
|
def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
|
104
|
-
post(path, {},
|
104
|
+
post(path, {}, {}, AvaTax::VERSION) end
|
105
105
|
|
106
106
|
# Reset linkage status between a client and firm back to requested
|
107
107
|
#
|
@@ -114,7 +114,7 @@ module AvaTax
|
|
114
114
|
# @param id [Integer]
|
115
115
|
# @return [Object]
|
116
116
|
def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
|
117
|
-
post(path, {},
|
117
|
+
post(path, {}, {}, AvaTax::VERSION) end
|
118
118
|
|
119
119
|
# Revokes previously approved linkage to a firm for a client account
|
120
120
|
#
|
@@ -127,7 +127,7 @@ module AvaTax
|
|
127
127
|
# @param id [Integer]
|
128
128
|
# @return [Object]
|
129
129
|
def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
|
130
|
-
post(path, {},
|
130
|
+
post(path, {}, {}, AvaTax::VERSION) end
|
131
131
|
end
|
132
132
|
end
|
133
133
|
end
|
data/lib/avatax/client/free.rb
CHANGED
@@ -23,7 +23,7 @@ module AvaTax
|
|
23
23
|
# @param model [Object] Required information to provision a free trial account.
|
24
24
|
# @return [Object]
|
25
25
|
def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
|
26
|
-
post(path, model, {},
|
26
|
+
post(path, model, {}, AvaTax::VERSION) end
|
27
27
|
end
|
28
28
|
end
|
29
29
|
end
|
@@ -20,7 +20,7 @@ module AvaTax
|
|
20
20
|
#
|
21
21
|
# ### Security Policies
|
22
22
|
#
|
23
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
23
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
24
24
|
# * 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.
|
25
25
|
# Swagger Name: AvaTaxClient
|
26
26
|
# @param id [Integer] The unique ID number of this funding request
|
@@ -28,7 +28,7 @@ module AvaTax
|
|
28
28
|
# @param subscriptionType [String] The company's subscription type (See POASubscriptionType::* for a list of allowable values)
|
29
29
|
# @return [Object]
|
30
30
|
def activate_funding_request(id, options={}) path = "/api/v2/fundingrequests/#{id}/widget"
|
31
|
-
get(path, options,
|
31
|
+
get(path, options, AvaTax::VERSION) end
|
32
32
|
|
33
33
|
# Retrieve status about a funding setup request
|
34
34
|
#
|
@@ -53,7 +53,7 @@ module AvaTax
|
|
53
53
|
# @param subscriptionType [String] The company's subscription type (See POASubscriptionType::* for a list of allowable values)
|
54
54
|
# @return [Object]
|
55
55
|
def funding_request_status(id, options={}) path = "/api/v2/fundingrequests/#{id}"
|
56
|
-
get(path, options,
|
56
|
+
get(path, options, AvaTax::VERSION) end
|
57
57
|
end
|
58
58
|
end
|
59
59
|
end
|
data/lib/avatax/client/items.rb
CHANGED
@@ -19,7 +19,7 @@ module AvaTax
|
|
19
19
|
# @param itemId [Integer] The ID of the item you wish to delete the classifications.
|
20
20
|
# @return [ErrorDetail[]]
|
21
21
|
def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
22
|
-
delete(path, {},
|
22
|
+
delete(path, {}, AvaTax::VERSION) end
|
23
23
|
|
24
24
|
# Delete all parameters for an item
|
25
25
|
#
|
@@ -39,7 +39,7 @@ module AvaTax
|
|
39
39
|
# @param itemId [Integer] The ID of the item you wish to delete the parameters.
|
40
40
|
# @return [ErrorDetail[]]
|
41
41
|
def batch_delete_item_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
42
|
-
delete(path, {},
|
42
|
+
delete(path, {}, AvaTax::VERSION) end
|
43
43
|
|
44
44
|
# Bulk upload items from a product catalog
|
45
45
|
#
|
@@ -61,7 +61,7 @@ module AvaTax
|
|
61
61
|
# @param model [Object] The items you wish to upload.
|
62
62
|
# @return [Object]
|
63
63
|
def bulk_upload_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/upload"
|
64
|
-
post(path, model, {},
|
64
|
+
post(path, model, {}, AvaTax::VERSION) end
|
65
65
|
|
66
66
|
# Add classifications to an item.
|
67
67
|
#
|
@@ -82,7 +82,7 @@ module AvaTax
|
|
82
82
|
# @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
|
83
83
|
# @return [ItemClassificationOutputModel[]]
|
84
84
|
def create_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
85
|
-
post(path, model, {},
|
85
|
+
post(path, model, {}, AvaTax::VERSION) end
|
86
86
|
|
87
87
|
# Add parameters to an item.
|
88
88
|
#
|
@@ -107,7 +107,7 @@ module AvaTax
|
|
107
107
|
# @param model [ItemParameterModel[]] The item parameters you wish to create.
|
108
108
|
# @return [ItemParameterModel[]]
|
109
109
|
def create_item_parameters(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
110
|
-
post(path, model, {},
|
110
|
+
post(path, model, {}, AvaTax::VERSION) end
|
111
111
|
|
112
112
|
# Create a new item
|
113
113
|
#
|
@@ -129,7 +129,7 @@ module AvaTax
|
|
129
129
|
# @param model [ItemModel[]] The item you wish to create.
|
130
130
|
# @return [ItemModel[]]
|
131
131
|
def create_items(companyId, model) path = "/api/v2/companies/#{companyId}/items"
|
132
|
-
post(path, model, {},
|
132
|
+
post(path, model, {}, AvaTax::VERSION) end
|
133
133
|
|
134
134
|
# Create tags for a item
|
135
135
|
#
|
@@ -146,25 +146,25 @@ module AvaTax
|
|
146
146
|
# @param model [ItemTagDetailInputModel[]] Tags you wish to associate with the Item
|
147
147
|
# @return [ItemTagDetailOutputModel[]]
|
148
148
|
def create_item_tags(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
|
149
|
-
post(path, model, {},
|
149
|
+
post(path, model, {}, AvaTax::VERSION) end
|
150
150
|
|
151
151
|
# Create a new tax code classification request
|
152
152
|
#
|
153
153
|
# Creates a new tax code classification request.
|
154
154
|
#
|
155
155
|
# Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and
|
156
|
-
# major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes
|
157
|
-
# allowing them to take advantage of thousands of tax rules in the AvaTax engine
|
156
|
+
# major physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes
|
157
|
+
# allowing them to take advantage of thousands of tax rules in the AvaTax engine resulting in accurate taxability determinations.
|
158
158
|
#
|
159
159
|
# ### Security Policies
|
160
160
|
#
|
161
161
|
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
162
162
|
# Swagger Name: AvaTaxClient
|
163
|
-
# @param companyId [Integer] The ID of the company
|
163
|
+
# @param companyId [Integer] The ID of the company that creates this request.
|
164
164
|
# @param model [Object] The request you wish to create.
|
165
165
|
# @return [Object]
|
166
166
|
def create_tax_code_classification_request(companyId, model) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode"
|
167
|
-
post(path, model, {},
|
167
|
+
post(path, model, {}, AvaTax::VERSION) end
|
168
168
|
|
169
169
|
# Delete a single item
|
170
170
|
#
|
@@ -192,7 +192,7 @@ module AvaTax
|
|
192
192
|
# @param itemCode [String] The code of the item you want to delete.
|
193
193
|
# @return [ErrorDetail[]]
|
194
194
|
def delete_catalogue_item(companyId, itemCode) path = "/api/v2/companies/#{companyId}/itemcatalogue/#{itemCode}"
|
195
|
-
delete(path, {},
|
195
|
+
delete(path, {}, AvaTax::VERSION) end
|
196
196
|
|
197
197
|
# Delete a single item
|
198
198
|
#
|
@@ -214,7 +214,7 @@ module AvaTax
|
|
214
214
|
# @param id [Integer] The ID of the item you wish to delete.
|
215
215
|
# @return [ErrorDetail[]]
|
216
216
|
def delete_item(companyId, id) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
217
|
-
delete(path, {},
|
217
|
+
delete(path, {}, AvaTax::VERSION) end
|
218
218
|
|
219
219
|
# Delete a single item classification.
|
220
220
|
#
|
@@ -233,7 +233,7 @@ module AvaTax
|
|
233
233
|
# @param id [Integer] The item classification id.
|
234
234
|
# @return [ErrorDetail[]]
|
235
235
|
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
236
|
-
delete(path, {},
|
236
|
+
delete(path, {}, AvaTax::VERSION) end
|
237
237
|
|
238
238
|
# Delete a single item parameter
|
239
239
|
#
|
@@ -254,7 +254,7 @@ module AvaTax
|
|
254
254
|
# @param id [Integer] The parameter id
|
255
255
|
# @return [ErrorDetail[]]
|
256
256
|
def delete_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
257
|
-
delete(path, {},
|
257
|
+
delete(path, {}, AvaTax::VERSION) end
|
258
258
|
|
259
259
|
# Delete item tag by id
|
260
260
|
#
|
@@ -271,7 +271,7 @@ module AvaTax
|
|
271
271
|
# @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
|
272
272
|
# @return [ErrorDetail[]]
|
273
273
|
def delete_item_tag(companyId, itemId, itemTagDetailId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
|
274
|
-
delete(path, {},
|
274
|
+
delete(path, {}, AvaTax::VERSION) end
|
275
275
|
|
276
276
|
# Delete all item tags
|
277
277
|
#
|
@@ -287,15 +287,15 @@ module AvaTax
|
|
287
287
|
# @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
|
288
288
|
# @return [ErrorDetail[]]
|
289
289
|
def delete_item_tags(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
|
290
|
-
delete(path, {},
|
290
|
+
delete(path, {}, AvaTax::VERSION) end
|
291
291
|
|
292
|
-
# Get
|
292
|
+
# Get status of classification requests of a company
|
293
293
|
#
|
294
|
-
# Get
|
294
|
+
# Get status of tax code classification requests of a company.
|
295
295
|
#
|
296
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
|
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
299
|
#
|
300
300
|
# Enable includeClassificationDetails flag to get details of classification request status.
|
301
301
|
#
|
@@ -304,14 +304,14 @@ module AvaTax
|
|
304
304
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
305
305
|
# Swagger Name: AvaTaxClient
|
306
306
|
# @param companyId [Integer] The ID of the company that defined these items
|
307
|
-
# @param includeClassificationDetails [Boolean] A
|
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
|
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
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
310
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
311
311
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
312
312
|
# @return [FetchResult]
|
313
313
|
def get_classification_status(companyId, options={}) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode"
|
314
|
-
get(path, options,
|
314
|
+
get(path, options, AvaTax::VERSION) end
|
315
315
|
|
316
316
|
# Retrieve a single item
|
317
317
|
#
|
@@ -332,7 +332,7 @@ module AvaTax
|
|
332
332
|
# @param include [String] A comma separated list of additional data to retrieve.
|
333
333
|
# @return [Object]
|
334
334
|
def get_item(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
335
|
-
get(path, options,
|
335
|
+
get(path, options, AvaTax::VERSION) end
|
336
336
|
|
337
337
|
# Retrieve a single item classification.
|
338
338
|
#
|
@@ -351,7 +351,7 @@ module AvaTax
|
|
351
351
|
# @param id [Integer] The item classification id.
|
352
352
|
# @return [Object]
|
353
353
|
def get_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
354
|
-
get(path, {},
|
354
|
+
get(path, {}, AvaTax::VERSION) end
|
355
355
|
|
356
356
|
# Retrieve a single item parameter
|
357
357
|
#
|
@@ -372,7 +372,7 @@ module AvaTax
|
|
372
372
|
# @param id [Integer] The parameter id
|
373
373
|
# @return [Object]
|
374
374
|
def get_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
375
|
-
get(path, {},
|
375
|
+
get(path, {}, AvaTax::VERSION) end
|
376
376
|
|
377
377
|
# Retrieve tags for an item
|
378
378
|
#
|
@@ -391,7 +391,7 @@ module AvaTax
|
|
391
391
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
392
392
|
# @return [FetchResult]
|
393
393
|
def get_item_tags(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
|
394
|
-
get(path, options,
|
394
|
+
get(path, options, AvaTax::VERSION) end
|
395
395
|
|
396
396
|
# Retrieve premium classification for a company's item based on its ItemCode and SystemCode.
|
397
397
|
#
|
@@ -415,15 +415,15 @@ module AvaTax
|
|
415
415
|
# @param systemCode [String] The SystemCode for which you want to retrieve premium classification
|
416
416
|
# @return [Object]
|
417
417
|
def get_premium_classification(companyId, itemCode, systemCode) path = "/api/v2/companies/#{companyId}/items/#{itemCode}/premiumClassification/#{systemCode}"
|
418
|
-
get(path, {},
|
418
|
+
get(path, {}, AvaTax::VERSION) end
|
419
419
|
|
420
420
|
# Get tax code recommendations
|
421
421
|
#
|
422
422
|
# Get tax code recommendations.
|
423
423
|
#
|
424
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
|
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
427
|
#
|
428
428
|
# ### Security Policies
|
429
429
|
#
|
@@ -437,7 +437,7 @@ module AvaTax
|
|
437
437
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
438
438
|
# @return [FetchResult]
|
439
439
|
def get_tax_code_recommendations(companyId, requestId, options={}) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode/#{requestId}/recommendations"
|
440
|
-
get(path, options,
|
440
|
+
get(path, options, AvaTax::VERSION) end
|
441
441
|
|
442
442
|
# Retrieve Restrictions for Item by CountryOfImport
|
443
443
|
#
|
@@ -464,7 +464,7 @@ module AvaTax
|
|
464
464
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
465
465
|
# @return [FetchResult]
|
466
466
|
def list_import_restrictions(companyId, itemCode, countryOfImport, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemCode}/restrictions/import/#{countryOfImport}"
|
467
|
-
get(path, options,
|
467
|
+
get(path, options, AvaTax::VERSION) end
|
468
468
|
|
469
469
|
# Retrieve classifications for an item.
|
470
470
|
#
|
@@ -489,7 +489,7 @@ module AvaTax
|
|
489
489
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
490
490
|
# @return [FetchResult]
|
491
491
|
def list_item_classifications(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
492
|
-
get(path, options,
|
492
|
+
get(path, options, AvaTax::VERSION) end
|
493
493
|
|
494
494
|
# Retrieve parameters for an item
|
495
495
|
#
|
@@ -516,7 +516,7 @@ module AvaTax
|
|
516
516
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
517
517
|
# @return [FetchResult]
|
518
518
|
def list_item_parameters(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
519
|
-
get(path, options,
|
519
|
+
get(path, options, AvaTax::VERSION) end
|
520
520
|
|
521
521
|
# Retrieve items for this company
|
522
522
|
#
|
@@ -546,7 +546,7 @@ module AvaTax
|
|
546
546
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
547
547
|
# Swagger Name: AvaTaxClient
|
548
548
|
# @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, upc, classifications, parameters, tags, properties
|
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
|
550
550
|
# @param include [String] A comma separated list of additional data to retrieve.
|
551
551
|
# @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
552
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
@@ -554,7 +554,7 @@ module AvaTax
|
|
554
554
|
# @param tagName [String] Tag Name on the basis of which you want to filter Items
|
555
555
|
# @return [FetchResult]
|
556
556
|
def list_items_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/items"
|
557
|
-
get(path, options,
|
557
|
+
get(path, options, AvaTax::VERSION) end
|
558
558
|
|
559
559
|
# Retrieve all items
|
560
560
|
#
|
@@ -574,14 +574,14 @@ module AvaTax
|
|
574
574
|
#
|
575
575
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
576
576
|
# 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, upc, classifications, parameters, tags, properties
|
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
|
578
578
|
# @param include [String] A comma separated list of additional data to retrieve.
|
579
579
|
# @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
580
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
581
581
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
582
582
|
# @return [FetchResult]
|
583
583
|
def query_items(options={}) path = "/api/v2/items"
|
584
|
-
get(path, options,
|
584
|
+
get(path, options, AvaTax::VERSION) end
|
585
585
|
|
586
586
|
# Retrieve all items associated with given tag
|
587
587
|
#
|
@@ -603,14 +603,14 @@ module AvaTax
|
|
603
603
|
# Swagger Name: AvaTaxClient
|
604
604
|
# @param companyId [Integer] The ID of the company that defined these items.
|
605
605
|
# @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, upc, classifications, parameters, tags, properties
|
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
|
607
607
|
# @param include [String] A comma separated list of additional data to retrieve.
|
608
608
|
# @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
609
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
610
610
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
611
611
|
# @return [FetchResult]
|
612
612
|
def query_items_by_tag(companyId, tag, options={}) path = "/api/v2/companies/#{companyId}/items/bytags/#{tag}"
|
613
|
-
get(path, options,
|
613
|
+
get(path, options, AvaTax::VERSION) end
|
614
614
|
|
615
615
|
# Create or update items from a product catalog.
|
616
616
|
#
|
@@ -630,7 +630,7 @@ module AvaTax
|
|
630
630
|
# @param model [ItemCatalogueInputModel[]] The items you want to create or update.
|
631
631
|
# @return [Object]
|
632
632
|
def sync_item_catalogue(companyId, model) path = "/api/v2/companies/#{companyId}/itemcatalogue"
|
633
|
-
post(path, model, {},
|
633
|
+
post(path, model, {}, AvaTax::VERSION) end
|
634
634
|
|
635
635
|
# Sync items from a product catalog
|
636
636
|
#
|
@@ -655,7 +655,7 @@ module AvaTax
|
|
655
655
|
# @param model [Object] The request object.
|
656
656
|
# @return [Object]
|
657
657
|
def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/sync"
|
658
|
-
post(path, model, {},
|
658
|
+
post(path, model, {}, AvaTax::VERSION) end
|
659
659
|
|
660
660
|
# Update a single item
|
661
661
|
#
|
@@ -681,7 +681,7 @@ module AvaTax
|
|
681
681
|
# @param model [Object] The item object you wish to update.
|
682
682
|
# @return [Object]
|
683
683
|
def update_item(companyId, id, model) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
684
|
-
put(path, model, {},
|
684
|
+
put(path, model, {}, AvaTax::VERSION) end
|
685
685
|
|
686
686
|
# Update an item classification.
|
687
687
|
#
|
@@ -703,7 +703,7 @@ module AvaTax
|
|
703
703
|
# @param model [Object] The item object you wish to update.
|
704
704
|
# @return [Object]
|
705
705
|
def update_item_classification(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
706
|
-
put(path, model, {},
|
706
|
+
put(path, model, {}, AvaTax::VERSION) end
|
707
707
|
|
708
708
|
# Update an item parameter
|
709
709
|
#
|
@@ -725,7 +725,7 @@ module AvaTax
|
|
725
725
|
# @param model [Object] The item object you wish to update.
|
726
726
|
# @return [Object]
|
727
727
|
def update_item_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
728
|
-
put(path, model, {},
|
728
|
+
put(path, model, {}, AvaTax::VERSION) end
|
729
729
|
end
|
730
730
|
end
|
731
731
|
end
|
@@ -20,7 +20,7 @@ module AvaTax
|
|
20
20
|
# @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
|
21
21
|
# @return [JurisdictionOverrideModel[]]
|
22
22
|
def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
23
|
-
post(path, model, {},
|
23
|
+
post(path, model, {}, AvaTax::VERSION) end
|
24
24
|
|
25
25
|
# Delete a single override
|
26
26
|
#
|
@@ -34,7 +34,7 @@ module AvaTax
|
|
34
34
|
# @param id [Integer] The ID of the override you wish to delete
|
35
35
|
# @return [ErrorDetail[]]
|
36
36
|
def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
37
|
-
delete(path, {},
|
37
|
+
delete(path, {}, AvaTax::VERSION) end
|
38
38
|
|
39
39
|
# Retrieve a single override
|
40
40
|
#
|
@@ -53,7 +53,7 @@ module AvaTax
|
|
53
53
|
# @param id [Integer] The primary key of this override
|
54
54
|
# @return [Object]
|
55
55
|
def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
56
|
-
get(path, {},
|
56
|
+
get(path, {}, AvaTax::VERSION) end
|
57
57
|
|
58
58
|
# Retrieve overrides for this account
|
59
59
|
#
|
@@ -79,7 +79,7 @@ module AvaTax
|
|
79
79
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
80
80
|
# @return [FetchResult]
|
81
81
|
def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
82
|
-
get(path, options,
|
82
|
+
get(path, options, AvaTax::VERSION) end
|
83
83
|
|
84
84
|
# Retrieve all overrides
|
85
85
|
#
|
@@ -104,7 +104,7 @@ module AvaTax
|
|
104
104
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
105
105
|
# @return [FetchResult]
|
106
106
|
def query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
|
107
|
-
get(path, options,
|
107
|
+
get(path, options, AvaTax::VERSION) end
|
108
108
|
|
109
109
|
# Update a single jurisdictionoverride
|
110
110
|
#
|
@@ -119,7 +119,7 @@ module AvaTax
|
|
119
119
|
# @param model [Object] The jurisdictionoverride object you wish to update.
|
120
120
|
# @return [Object]
|
121
121
|
def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
122
|
-
put(path, model, {},
|
122
|
+
put(path, model, {}, AvaTax::VERSION) end
|
123
123
|
end
|
124
124
|
end
|
125
125
|
end
|