avatax 20.5.0 → 20.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.vs/slnx.sqlite +0 -0
- data/avatax.gemspec +0 -1
- data/lib/avatax/client/accounts.rb +83 -83
- data/lib/avatax/client/addresses.rb +21 -21
- data/lib/avatax/client/advancedrules.rb +51 -41
- data/lib/avatax/client/avafileforms.rb +41 -41
- data/lib/avatax/client/batches.rb +101 -48
- data/lib/avatax/client/certexpressinvites.rb +39 -39
- data/lib/avatax/client/certificates.rb +163 -163
- data/lib/avatax/client/companies.rb +226 -121
- data/lib/avatax/client/compliance.rb +13 -13
- data/lib/avatax/client/contacts.rb +48 -48
- data/lib/avatax/client/customers.rb +145 -145
- data/lib/avatax/client/datasources.rb +48 -48
- data/lib/avatax/client/definitions.rb +422 -420
- data/lib/avatax/client/distancethresholds.rb +48 -48
- data/lib/avatax/client/ecms.rb +26 -31
- data/lib/avatax/client/ecommercetoken.rb +37 -0
- data/lib/avatax/client/errortransactions.rb +27 -15
- data/lib/avatax/client/filingcalendars.rb +28 -13
- data/lib/avatax/client/filings.rb +25 -14
- data/lib/avatax/client/firmclientlinkages.rb +69 -69
- data/lib/avatax/client/free.rb +27 -27
- data/lib/avatax/client/fundingrequests.rb +20 -20
- data/lib/avatax/client/items.rb +139 -139
- data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
- data/lib/avatax/client/locations.rb +168 -57
- data/lib/avatax/client/multidocument.rb +98 -78
- data/lib/avatax/client/nexus.rb +104 -104
- data/lib/avatax/client/notices.rb +47 -139
- data/lib/avatax/client/notifications.rb +27 -27
- data/lib/avatax/client/provisioning.rb +20 -20
- data/lib/avatax/client/registrar.rb +76 -76
- data/lib/avatax/client/reports.rb +34 -34
- data/lib/avatax/client/settings.rb +48 -48
- data/lib/avatax/client/subscriptions.rb +27 -27
- data/lib/avatax/client/taxcodes.rb +48 -48
- data/lib/avatax/client/taxcontent.rb +27 -27
- data/lib/avatax/client/taxprofiles.rb +14 -10
- data/lib/avatax/client/taxrules.rb +48 -48
- data/lib/avatax/client/transactions.rb +185 -155
- data/lib/avatax/client/upcs.rb +48 -48
- data/lib/avatax/client/users.rb +62 -62
- data/lib/avatax/client/utilities.rb +27 -27
- data/lib/avatax/connection.rb +2 -2
- data/lib/avatax/version.rb +1 -1
- metadata +3 -16
@@ -1,22 +1,22 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module FirmClientLinkages
|
4
|
-
|
5
|
-
|
6
|
-
# Approves linkage to a firm for a client account
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module FirmClientLinkages
|
4
|
+
|
5
|
+
|
6
|
+
# Approves linkage to a firm for a client account
|
7
|
+
#
|
8
8
|
# This API enables the account admin of a client account to approve linkage request by a firm.
|
9
9
|
#
|
10
10
|
# ### Security Policies
|
11
11
|
#
|
12
|
-
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
12
|
+
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
13
13
|
# @param id [Integer]
|
14
|
-
# @return [Object]
|
15
|
-
def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
|
16
|
-
post(path) end
|
17
|
-
|
18
|
-
# Request a new FirmClient account and create an approved linkage to it
|
19
|
-
#
|
14
|
+
# @return [Object]
|
15
|
+
def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
|
16
|
+
post(path) end
|
17
|
+
|
18
|
+
# Request a new FirmClient account and create an approved linkage to it
|
19
|
+
#
|
20
20
|
# This API is for use by Firms only.
|
21
21
|
#
|
22
22
|
# Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
|
@@ -30,95 +30,95 @@ module AvaTax
|
|
30
30
|
#
|
31
31
|
# ### Security Policies
|
32
32
|
#
|
33
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
|
33
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
|
34
34
|
# @param model [Object] Information about the account you wish to create.
|
35
|
-
# @return [Object]
|
36
|
-
def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
|
37
|
-
post(path, model) end
|
38
|
-
|
39
|
-
# Links a firm account with the client account
|
40
|
-
#
|
35
|
+
# @return [Object]
|
36
|
+
def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
|
37
|
+
post(path, model) end
|
38
|
+
|
39
|
+
# Links a firm account with the client account
|
40
|
+
#
|
41
41
|
# This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
|
42
42
|
#
|
43
43
|
# ### Security Policies
|
44
44
|
#
|
45
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
45
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
46
46
|
# @param model [Object] FirmClientLinkageInputModel
|
47
|
-
# @return [Object]
|
48
|
-
def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
|
49
|
-
post(path, model) end
|
50
|
-
|
51
|
-
# Delete a linkage
|
52
|
-
#
|
47
|
+
# @return [Object]
|
48
|
+
def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
|
49
|
+
post(path, model) end
|
50
|
+
|
51
|
+
# Delete a linkage
|
52
|
+
#
|
53
53
|
# This API marks a linkage between a firm and client as deleted.
|
54
54
|
#
|
55
55
|
# ### Security Policies
|
56
56
|
#
|
57
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
57
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
58
58
|
# @param id [Integer]
|
59
|
-
# @return [ErrorDetail[]]
|
60
|
-
def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
|
61
|
-
delete(path) end
|
62
|
-
|
63
|
-
# Get linkage between a firm and client by id
|
64
|
-
#
|
59
|
+
# @return [ErrorDetail[]]
|
60
|
+
def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
|
61
|
+
delete(path) end
|
62
|
+
|
63
|
+
# Get linkage between a firm and client by id
|
64
|
+
#
|
65
65
|
# This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
|
66
66
|
#
|
67
67
|
# ### Security Policies
|
68
68
|
#
|
69
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
69
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
70
70
|
# @param id [Integer]
|
71
|
-
# @return [Object]
|
72
|
-
def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
|
73
|
-
get(path) end
|
74
|
-
|
75
|
-
# List client linkages for a firm or client
|
76
|
-
#
|
71
|
+
# @return [Object]
|
72
|
+
def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
|
73
|
+
get(path) end
|
74
|
+
|
75
|
+
# List client linkages for a firm or client
|
76
|
+
#
|
77
77
|
# This API enables the firm or account users to request the associated linkages to the account.
|
78
78
|
#
|
79
79
|
# ### Security Policies
|
80
80
|
#
|
81
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
81
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
82
82
|
# @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
|
83
|
-
# @return [FetchResult]
|
84
|
-
def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
|
85
|
-
get(path, options) end
|
86
|
-
|
87
|
-
# Rejects linkage to a firm for a client account
|
88
|
-
#
|
83
|
+
# @return [FetchResult]
|
84
|
+
def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
|
85
|
+
get(path, options) end
|
86
|
+
|
87
|
+
# Rejects linkage to a firm for a client account
|
88
|
+
#
|
89
89
|
# This API enables the account admin of a client account to reject linkage request by a firm.
|
90
90
|
#
|
91
91
|
# ### Security Policies
|
92
92
|
#
|
93
|
-
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
93
|
+
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
94
94
|
# @param id [Integer]
|
95
|
-
# @return [Object]
|
96
|
-
def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
|
97
|
-
post(path) end
|
98
|
-
|
99
|
-
# Reset linkage status between a client and firm back to requested
|
100
|
-
#
|
95
|
+
# @return [Object]
|
96
|
+
def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
|
97
|
+
post(path) end
|
98
|
+
|
99
|
+
# Reset linkage status between a client and firm back to requested
|
100
|
+
#
|
101
101
|
# This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
|
102
102
|
#
|
103
103
|
# ### Security Policies
|
104
104
|
#
|
105
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
105
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
106
106
|
# @param id [Integer]
|
107
|
-
# @return [Object]
|
108
|
-
def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
|
109
|
-
post(path) end
|
110
|
-
|
111
|
-
# Revokes previously approved linkage to a firm for a client account
|
112
|
-
#
|
107
|
+
# @return [Object]
|
108
|
+
def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
|
109
|
+
post(path) end
|
110
|
+
|
111
|
+
# Revokes previously approved linkage to a firm for a client account
|
112
|
+
#
|
113
113
|
# This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
|
114
114
|
#
|
115
115
|
# ### Security Policies
|
116
116
|
#
|
117
|
-
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
117
|
+
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
118
118
|
# @param id [Integer]
|
119
|
-
# @return [Object]
|
120
|
-
def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
|
121
|
-
post(path) end
|
122
|
-
end
|
123
|
-
end
|
119
|
+
# @return [Object]
|
120
|
+
def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
|
121
|
+
post(path) end
|
122
|
+
end
|
123
|
+
end
|
124
124
|
end
|
data/lib/avatax/client/free.rb
CHANGED
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Free
|
4
|
-
|
5
|
-
|
6
|
-
# FREE API - Request a free trial of AvaTax
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Free
|
4
|
+
|
5
|
+
|
6
|
+
# FREE API - Request a free trial of AvaTax
|
7
|
+
#
|
8
8
|
# Call this API to obtain a free AvaTax account.
|
9
9
|
#
|
10
10
|
# This API is free to use. No authentication credentials are required to call this API. You must read and
|
@@ -18,14 +18,14 @@ module AvaTax
|
|
18
18
|
#
|
19
19
|
# ### Security Policies
|
20
20
|
#
|
21
|
-
# * This API may be called without providing authentication credentials.
|
21
|
+
# * This API may be called without providing authentication credentials.
|
22
22
|
# @param model [Object] Required information to provision a free trial account.
|
23
|
-
# @return [Object]
|
24
|
-
def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
|
25
|
-
post(path, model) end
|
26
|
-
|
27
|
-
# FREE API - Sales tax rates for a specified address
|
28
|
-
#
|
23
|
+
# @return [Object]
|
24
|
+
def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
|
25
|
+
post(path, model) end
|
26
|
+
|
27
|
+
# FREE API - Sales tax rates for a specified address
|
28
|
+
#
|
29
29
|
# # Free-To-Use
|
30
30
|
#
|
31
31
|
# The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
|
@@ -50,7 +50,7 @@ module AvaTax
|
|
50
50
|
# * And more!
|
51
51
|
#
|
52
52
|
# Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
|
53
|
-
# for information on how to upgrade to the full AvaTax CreateTransaction API.
|
53
|
+
# for information on how to upgrade to the full AvaTax CreateTransaction API.
|
54
54
|
# @param line1 [String] The street address of the location.
|
55
55
|
# @param line2 [String] The street address of the location.
|
56
56
|
# @param line3 [String] The street address of the location.
|
@@ -58,12 +58,12 @@ module AvaTax
|
|
58
58
|
# @param region [String] Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
|
59
59
|
# @param postalCode [String] The postal code of the location.
|
60
60
|
# @param country [String] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
|
61
|
-
# @return [Object]
|
62
|
-
def tax_rates_by_address(options={}) path = "/api/v2/taxrates/byaddress"
|
63
|
-
get(path, options) end
|
64
|
-
|
65
|
-
# FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
|
66
|
-
#
|
61
|
+
# @return [Object]
|
62
|
+
def tax_rates_by_address(options={}) path = "/api/v2/taxrates/byaddress"
|
63
|
+
get(path, options) end
|
64
|
+
|
65
|
+
# FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
|
66
|
+
#
|
67
67
|
# # Free-To-Use
|
68
68
|
#
|
69
69
|
# This API is only available for a US postal codes.
|
@@ -90,12 +90,12 @@ module AvaTax
|
|
90
90
|
# * And more!
|
91
91
|
#
|
92
92
|
# Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
|
93
|
-
# for information on how to upgrade to the full AvaTax CreateTransaction API.
|
93
|
+
# for information on how to upgrade to the full AvaTax CreateTransaction API.
|
94
94
|
# @param country [String] Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
|
95
95
|
# @param postalCode [String] The postal code of the location.
|
96
|
-
# @return [Object]
|
97
|
-
def tax_rates_by_postal_code(options={}) path = "/api/v2/taxrates/bypostalcode"
|
98
|
-
get(path, options) end
|
99
|
-
end
|
100
|
-
end
|
96
|
+
# @return [Object]
|
97
|
+
def tax_rates_by_postal_code(options={}) path = "/api/v2/taxrates/bypostalcode"
|
98
|
+
get(path, options) end
|
99
|
+
end
|
100
|
+
end
|
101
101
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module FundingRequests
|
4
|
-
|
5
|
-
|
6
|
-
# Request the javascript for a funding setup widget
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module FundingRequests
|
4
|
+
|
5
|
+
|
6
|
+
# Request the javascript for a funding setup widget
|
7
|
+
#
|
8
8
|
# This API is available by invitation only.
|
9
9
|
# Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
|
10
10
|
# required to setup their funding configuration before Avalara can begin filing tax returns on their
|
@@ -21,14 +21,14 @@ module AvaTax
|
|
21
21
|
# ### Security Policies
|
22
22
|
#
|
23
23
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
24
|
-
# * This API depends on the following active services
|
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
|
# @param id [Integer] The unique ID number of this funding request
|
26
|
-
# @return [Object]
|
27
|
-
def activate_funding_request(id) path = "/api/v2/fundingrequests/#{id}/widget"
|
28
|
-
get(path) end
|
29
|
-
|
30
|
-
# Retrieve status about a funding setup request
|
31
|
-
#
|
26
|
+
# @return [Object]
|
27
|
+
def activate_funding_request(id) path = "/api/v2/fundingrequests/#{id}/widget"
|
28
|
+
get(path) end
|
29
|
+
|
30
|
+
# Retrieve status about a funding setup request
|
31
|
+
#
|
32
32
|
# This API is available by invitation only.
|
33
33
|
# Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
|
34
34
|
# required to setup their funding configuration before Avalara can begin filing tax returns on their
|
@@ -43,11 +43,11 @@ module AvaTax
|
|
43
43
|
# ### Security Policies
|
44
44
|
#
|
45
45
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
46
|
-
# * This API depends on the following active services
|
46
|
+
# * 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.
|
47
47
|
# @param id [Integer] The unique ID number of this funding request
|
48
|
-
# @return [Object]
|
49
|
-
def funding_request_status(id) path = "/api/v2/fundingrequests/#{id}"
|
50
|
-
get(path) end
|
51
|
-
end
|
52
|
-
end
|
48
|
+
# @return [Object]
|
49
|
+
def funding_request_status(id) path = "/api/v2/fundingrequests/#{id}"
|
50
|
+
get(path) end
|
51
|
+
end
|
52
|
+
end
|
53
53
|
end
|
data/lib/avatax/client/items.rb
CHANGED
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Items
|
4
|
-
|
5
|
-
|
6
|
-
# Delete all classifications for an item
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Items
|
4
|
+
|
5
|
+
|
6
|
+
# Delete all classifications for an item
|
7
|
+
#
|
8
8
|
# Delete all the classifications for a given item.
|
9
9
|
#
|
10
10
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
@@ -13,15 +13,15 @@ module AvaTax
|
|
13
13
|
#
|
14
14
|
# ### Security Policies
|
15
15
|
#
|
16
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
16
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
17
17
|
# @param companyId [Integer] The ID of the company that owns this item.
|
18
18
|
# @param itemId [Integer] The ID of the item you wish to delete the classifications.
|
19
|
-
# @return [ErrorDetail[]]
|
20
|
-
def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
21
|
-
delete(path) end
|
22
|
-
|
23
|
-
# Delete all parameters for an item
|
24
|
-
#
|
19
|
+
# @return [ErrorDetail[]]
|
20
|
+
def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
21
|
+
delete(path) end
|
22
|
+
|
23
|
+
# Delete all parameters for an item
|
24
|
+
#
|
25
25
|
# Delete all the parameters for a given item.
|
26
26
|
#
|
27
27
|
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -32,15 +32,15 @@ module AvaTax
|
|
32
32
|
#
|
33
33
|
# ### Security Policies
|
34
34
|
#
|
35
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
35
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
36
36
|
# @param companyId [Integer] The ID of the company that owns this item.
|
37
37
|
# @param itemId [Integer] The ID of the item you wish to delete the parameters.
|
38
|
-
# @return [ErrorDetail[]]
|
39
|
-
def batch_delete_item_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
40
|
-
delete(path) end
|
41
|
-
|
42
|
-
# Add classifications to an item.
|
43
|
-
#
|
38
|
+
# @return [ErrorDetail[]]
|
39
|
+
def batch_delete_item_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
40
|
+
delete(path) end
|
41
|
+
|
42
|
+
# Add classifications to an item.
|
43
|
+
#
|
44
44
|
# Add classifications to an item.
|
45
45
|
#
|
46
46
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
@@ -51,16 +51,16 @@ module AvaTax
|
|
51
51
|
#
|
52
52
|
# ### Security Policies
|
53
53
|
#
|
54
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
54
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
55
55
|
# @param companyId [Integer] The company id.
|
56
56
|
# @param itemId [Integer] The item id.
|
57
57
|
# @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
|
58
|
-
# @return [ItemClassificationOutputModel[]]
|
59
|
-
def create_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
60
|
-
post(path, model) end
|
61
|
-
|
62
|
-
# Add parameters to an item.
|
63
|
-
#
|
58
|
+
# @return [ItemClassificationOutputModel[]]
|
59
|
+
def create_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
60
|
+
post(path, model) end
|
61
|
+
|
62
|
+
# Add parameters to an item.
|
63
|
+
#
|
64
64
|
# Add parameters to an item.
|
65
65
|
#
|
66
66
|
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -75,16 +75,16 @@ module AvaTax
|
|
75
75
|
#
|
76
76
|
# ### Security Policies
|
77
77
|
#
|
78
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
78
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
79
79
|
# @param companyId [Integer] The ID of the company that owns this item parameter.
|
80
80
|
# @param itemId [Integer] The item id.
|
81
81
|
# @param model [ItemParameterModel[]] The item parameters you wish to create.
|
82
|
-
# @return [ItemParameterModel[]]
|
83
|
-
def create_item_parameters(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
84
|
-
post(path, model) end
|
85
|
-
|
86
|
-
# Create a new item
|
87
|
-
#
|
82
|
+
# @return [ItemParameterModel[]]
|
83
|
+
def create_item_parameters(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
84
|
+
post(path, model) end
|
85
|
+
|
86
|
+
# Create a new item
|
87
|
+
#
|
88
88
|
# Creates one or more new item objects attached to this company.
|
89
89
|
#
|
90
90
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
@@ -97,15 +97,15 @@ module AvaTax
|
|
97
97
|
#
|
98
98
|
# ### Security Policies
|
99
99
|
#
|
100
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
100
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
101
101
|
# @param companyId [Integer] The ID of the company that owns this item.
|
102
102
|
# @param model [ItemModel[]] The item you wish to create.
|
103
|
-
# @return [ItemModel[]]
|
104
|
-
def create_items(companyId, model) path = "/api/v2/companies/#{companyId}/items"
|
105
|
-
post(path, model) end
|
106
|
-
|
107
|
-
# Delete a single item
|
108
|
-
#
|
103
|
+
# @return [ItemModel[]]
|
104
|
+
def create_items(companyId, model) path = "/api/v2/companies/#{companyId}/items"
|
105
|
+
post(path, model) end
|
106
|
+
|
107
|
+
# Delete a single item
|
108
|
+
#
|
109
109
|
# Deletes the item object at this URL.
|
110
110
|
#
|
111
111
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
@@ -118,15 +118,15 @@ module AvaTax
|
|
118
118
|
#
|
119
119
|
# ### Security Policies
|
120
120
|
#
|
121
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
121
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
122
122
|
# @param companyId [Integer] The ID of the company that owns this item.
|
123
123
|
# @param id [Integer] The ID of the item you wish to delete.
|
124
|
-
# @return [ErrorDetail[]]
|
125
|
-
def delete_item(companyId, id) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
126
|
-
delete(path) end
|
127
|
-
|
128
|
-
# Delete a single item classification.
|
129
|
-
#
|
124
|
+
# @return [ErrorDetail[]]
|
125
|
+
def delete_item(companyId, id) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
126
|
+
delete(path) end
|
127
|
+
|
128
|
+
# Delete a single item classification.
|
129
|
+
#
|
130
130
|
# Delete a single item classification.
|
131
131
|
#
|
132
132
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
@@ -135,16 +135,16 @@ module AvaTax
|
|
135
135
|
#
|
136
136
|
# ### Security Policies
|
137
137
|
#
|
138
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
138
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
139
139
|
# @param companyId [Integer] The company id.
|
140
140
|
# @param itemId [Integer] The item id.
|
141
141
|
# @param id [Integer] The item classification id.
|
142
|
-
# @return [ErrorDetail[]]
|
143
|
-
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
144
|
-
delete(path) end
|
145
|
-
|
146
|
-
# Delete a single item parameter
|
147
|
-
#
|
142
|
+
# @return [ErrorDetail[]]
|
143
|
+
def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
144
|
+
delete(path) end
|
145
|
+
|
146
|
+
# Delete a single item parameter
|
147
|
+
#
|
148
148
|
# Delete a single item parameter.
|
149
149
|
#
|
150
150
|
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -155,16 +155,16 @@ module AvaTax
|
|
155
155
|
#
|
156
156
|
# ### Security Policies
|
157
157
|
#
|
158
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
158
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
159
159
|
# @param companyId [Integer] The company id
|
160
160
|
# @param itemId [Integer] The item id
|
161
161
|
# @param id [Integer] The parameter id
|
162
|
-
# @return [ErrorDetail[]]
|
163
|
-
def delete_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
164
|
-
delete(path) end
|
165
|
-
|
166
|
-
# Retrieve a single item
|
167
|
-
#
|
162
|
+
# @return [ErrorDetail[]]
|
163
|
+
def delete_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
164
|
+
delete(path) end
|
165
|
+
|
166
|
+
# Retrieve a single item
|
167
|
+
#
|
168
168
|
# Get the `Item` object identified by this URL.
|
169
169
|
#
|
170
170
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
@@ -175,16 +175,16 @@ module AvaTax
|
|
175
175
|
#
|
176
176
|
# ### Security Policies
|
177
177
|
#
|
178
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
178
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
179
179
|
# @param companyId [Integer] The ID of the company that owns this item object
|
180
180
|
# @param id [Integer] The primary key of this item
|
181
181
|
# @param include [String] A comma separated list of additional data to retrieve.
|
182
|
-
# @return [Object]
|
183
|
-
def get_item(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
184
|
-
get(path, options) end
|
185
|
-
|
186
|
-
# Retrieve a single item classification.
|
187
|
-
#
|
182
|
+
# @return [Object]
|
183
|
+
def get_item(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
184
|
+
get(path, options) end
|
185
|
+
|
186
|
+
# Retrieve a single item classification.
|
187
|
+
#
|
188
188
|
# Retrieve a single item classification.
|
189
189
|
#
|
190
190
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
@@ -193,16 +193,16 @@ module AvaTax
|
|
193
193
|
#
|
194
194
|
# ### Security Policies
|
195
195
|
#
|
196
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
196
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
197
197
|
# @param companyId [Integer] The company id.
|
198
198
|
# @param itemId [Integer] The item id.
|
199
199
|
# @param id [Integer] The item classification id.
|
200
|
-
# @return [Object]
|
201
|
-
def get_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
202
|
-
get(path) end
|
203
|
-
|
204
|
-
# Retrieve a single item parameter
|
205
|
-
#
|
200
|
+
# @return [Object]
|
201
|
+
def get_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
202
|
+
get(path) end
|
203
|
+
|
204
|
+
# Retrieve a single item parameter
|
205
|
+
#
|
206
206
|
# Retrieve a single item parameter.
|
207
207
|
#
|
208
208
|
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -213,16 +213,16 @@ module AvaTax
|
|
213
213
|
#
|
214
214
|
# ### Security Policies
|
215
215
|
#
|
216
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
216
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
217
217
|
# @param companyId [Integer] The company id
|
218
218
|
# @param itemId [Integer] The item id
|
219
219
|
# @param id [Integer] The parameter id
|
220
|
-
# @return [Object]
|
221
|
-
def get_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
222
|
-
get(path) end
|
223
|
-
|
224
|
-
# Retrieve classifications for an item.
|
225
|
-
#
|
220
|
+
# @return [Object]
|
221
|
+
def get_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
222
|
+
get(path) end
|
223
|
+
|
224
|
+
# Retrieve classifications for an item.
|
225
|
+
#
|
226
226
|
# List classifications for an item.
|
227
227
|
#
|
228
228
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
@@ -234,19 +234,19 @@ module AvaTax
|
|
234
234
|
#
|
235
235
|
# ### Security Policies
|
236
236
|
#
|
237
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
237
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
238
238
|
# @param companyId [Integer] The company id.
|
239
239
|
# @param itemId [Integer] The item id.
|
240
240
|
# @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:* productCode, systemCode
|
241
241
|
# @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.
|
242
242
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
243
243
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
244
|
-
# @return [FetchResult]
|
245
|
-
def list_item_classifications(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
246
|
-
get(path, options) end
|
247
|
-
|
248
|
-
# Retrieve parameters for an item
|
249
|
-
#
|
244
|
+
# @return [FetchResult]
|
245
|
+
def list_item_classifications(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
|
246
|
+
get(path, options) end
|
247
|
+
|
248
|
+
# Retrieve parameters for an item
|
249
|
+
#
|
250
250
|
# List parameters for an item.
|
251
251
|
#
|
252
252
|
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -260,19 +260,19 @@ module AvaTax
|
|
260
260
|
#
|
261
261
|
# ### Security Policies
|
262
262
|
#
|
263
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
263
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
264
264
|
# @param companyId [Integer] The company id
|
265
265
|
# @param itemId [Integer] The item id
|
266
266
|
# @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:* name, unit
|
267
267
|
# @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.
|
268
268
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
269
269
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
270
|
-
# @return [FetchResult]
|
271
|
-
def list_item_parameters(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
272
|
-
get(path, options) end
|
273
|
-
|
274
|
-
# Retrieve items for this company
|
275
|
-
#
|
270
|
+
# @return [FetchResult]
|
271
|
+
def list_item_parameters(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
|
272
|
+
get(path, options) end
|
273
|
+
|
274
|
+
# Retrieve items for this company
|
275
|
+
#
|
276
276
|
# List all items defined for the current company.
|
277
277
|
#
|
278
278
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
@@ -292,19 +292,19 @@ module AvaTax
|
|
292
292
|
#
|
293
293
|
# ### Security Policies
|
294
294
|
#
|
295
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
295
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
296
296
|
# @param companyId [Integer] The ID of the company that defined these items
|
297
297
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, classifications, parameters
|
298
298
|
# @param include [String] A comma separated list of additional data to retrieve.
|
299
299
|
# @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.
|
300
300
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
301
301
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
302
|
-
# @return [FetchResult]
|
303
|
-
def list_items_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/items"
|
304
|
-
get(path, options) end
|
305
|
-
|
306
|
-
# Retrieve all items
|
307
|
-
#
|
302
|
+
# @return [FetchResult]
|
303
|
+
def list_items_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/items"
|
304
|
+
get(path, options) end
|
305
|
+
|
306
|
+
# Retrieve all items
|
307
|
+
#
|
308
308
|
# Get multiple item objects across all companies.
|
309
309
|
#
|
310
310
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
@@ -319,18 +319,18 @@ module AvaTax
|
|
319
319
|
#
|
320
320
|
# ### Security Policies
|
321
321
|
#
|
322
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
322
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
323
323
|
# @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, classifications, parameters
|
324
324
|
# @param include [String] A comma separated list of additional data to retrieve.
|
325
325
|
# @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.
|
326
326
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
327
327
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
328
|
-
# @return [FetchResult]
|
329
|
-
def query_items(options={}) path = "/api/v2/items"
|
330
|
-
get(path, options) end
|
331
|
-
|
332
|
-
# Sync items from a product catalog
|
333
|
-
#
|
328
|
+
# @return [FetchResult]
|
329
|
+
def query_items(options={}) path = "/api/v2/items"
|
330
|
+
get(path, options) end
|
331
|
+
|
332
|
+
# Sync items from a product catalog
|
333
|
+
#
|
334
334
|
# Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs
|
335
335
|
# with AvaTax.
|
336
336
|
#
|
@@ -346,15 +346,15 @@ module AvaTax
|
|
346
346
|
#
|
347
347
|
# ### Security Policies
|
348
348
|
#
|
349
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
349
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
350
350
|
# @param companyId [Integer] The ID of the company that owns this item.
|
351
351
|
# @param model [Object] The request object.
|
352
|
-
# @return [Object]
|
353
|
-
def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/sync"
|
354
|
-
post(path, model) end
|
355
|
-
|
356
|
-
# Update a single item
|
357
|
-
#
|
352
|
+
# @return [Object]
|
353
|
+
def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/sync"
|
354
|
+
post(path, model) end
|
355
|
+
|
356
|
+
# Update a single item
|
357
|
+
#
|
358
358
|
# Replace the existing `Item` object at this URL with an updated object.
|
359
359
|
#
|
360
360
|
# Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
|
@@ -370,16 +370,16 @@ module AvaTax
|
|
370
370
|
#
|
371
371
|
# ### Security Policies
|
372
372
|
#
|
373
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
373
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
374
374
|
# @param companyId [Integer] The ID of the company that this item belongs to.
|
375
375
|
# @param id [Integer] The ID of the item you wish to update
|
376
376
|
# @param model [Object] The item object you wish to update.
|
377
|
-
# @return [Object]
|
378
|
-
def update_item(companyId, id, model) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
379
|
-
put(path, model) end
|
380
|
-
|
381
|
-
# Update an item classification.
|
382
|
-
#
|
377
|
+
# @return [Object]
|
378
|
+
def update_item(companyId, id, model) path = "/api/v2/companies/#{companyId}/items/#{id}"
|
379
|
+
put(path, model) end
|
380
|
+
|
381
|
+
# Update an item classification.
|
382
|
+
#
|
383
383
|
# Update an item classification.
|
384
384
|
#
|
385
385
|
# A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
|
@@ -390,17 +390,17 @@ module AvaTax
|
|
390
390
|
#
|
391
391
|
# ### Security Policies
|
392
392
|
#
|
393
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
393
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
394
394
|
# @param companyId [Integer] The company id.
|
395
395
|
# @param itemId [Integer] The item id.
|
396
396
|
# @param id [Integer] The item classification id.
|
397
397
|
# @param model [Object] The item object you wish to update.
|
398
|
-
# @return [Object]
|
399
|
-
def update_item_classification(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
400
|
-
put(path, model) end
|
401
|
-
|
402
|
-
# Update an item parameter
|
403
|
-
#
|
398
|
+
# @return [Object]
|
399
|
+
def update_item_classification(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
|
400
|
+
put(path, model) end
|
401
|
+
|
402
|
+
# Update an item parameter
|
403
|
+
#
|
404
404
|
# Update an item parameter.
|
405
405
|
#
|
406
406
|
# Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -411,14 +411,14 @@ module AvaTax
|
|
411
411
|
#
|
412
412
|
# ### Security Policies
|
413
413
|
#
|
414
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
414
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
415
415
|
# @param companyId [Integer] The company id.
|
416
416
|
# @param itemId [Integer] The item id
|
417
417
|
# @param id [Integer] The item parameter id
|
418
418
|
# @param model [Object] The item object you wish to update.
|
419
|
-
# @return [Object]
|
420
|
-
def update_item_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
421
|
-
put(path, model) end
|
422
|
-
end
|
423
|
-
end
|
419
|
+
# @return [Object]
|
420
|
+
def update_item_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
|
421
|
+
put(path, model) end
|
422
|
+
end
|
423
|
+
end
|
424
424
|
end
|