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,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Settings
|
4
|
-
|
5
|
-
|
6
|
-
# Create a new setting
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Settings
|
4
|
+
|
5
|
+
|
6
|
+
# Create a new setting
|
7
|
+
#
|
8
8
|
# Create one or more new setting objects attached to this company.
|
9
9
|
#
|
10
10
|
# The company settings system is a metadata system that you can use to store extra information
|
@@ -18,15 +18,15 @@ module AvaTax
|
|
18
18
|
#
|
19
19
|
# ### Security Policies
|
20
20
|
#
|
21
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
21
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
22
22
|
# @param companyId [Integer] The ID of the company that owns this setting.
|
23
23
|
# @param model [SettingModel[]] The setting you wish to create.
|
24
|
-
# @return [SettingModel[]]
|
25
|
-
def create_settings(companyId, model) path = "/api/v2/companies/#{companyId}/settings"
|
26
|
-
post(path, model) end
|
27
|
-
|
28
|
-
# Delete a single setting
|
29
|
-
#
|
24
|
+
# @return [SettingModel[]]
|
25
|
+
def create_settings(companyId, model) path = "/api/v2/companies/#{companyId}/settings"
|
26
|
+
post(path, model) end
|
27
|
+
|
28
|
+
# Delete a single setting
|
29
|
+
#
|
30
30
|
# Mark the setting object at this URL as deleted.
|
31
31
|
#
|
32
32
|
# The company settings system is a metadata system that you can use to store extra information
|
@@ -40,15 +40,15 @@ module AvaTax
|
|
40
40
|
#
|
41
41
|
# ### Security Policies
|
42
42
|
#
|
43
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
43
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
44
44
|
# @param companyId [Integer] The ID of the company that owns this setting.
|
45
45
|
# @param id [Integer] The ID of the setting you wish to delete.
|
46
|
-
# @return [ErrorDetail[]]
|
47
|
-
def delete_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
48
|
-
delete(path) end
|
49
|
-
|
50
|
-
# Retrieve a single setting
|
51
|
-
#
|
46
|
+
# @return [ErrorDetail[]]
|
47
|
+
def delete_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
48
|
+
delete(path) end
|
49
|
+
|
50
|
+
# Retrieve a single setting
|
51
|
+
#
|
52
52
|
# Get a single setting object by its unique ID.
|
53
53
|
#
|
54
54
|
# The company settings system is a metadata system that you can use to store extra information
|
@@ -62,15 +62,15 @@ module AvaTax
|
|
62
62
|
#
|
63
63
|
# ### Security Policies
|
64
64
|
#
|
65
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
65
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
66
66
|
# @param companyId [Integer] The ID of the company that owns this setting
|
67
67
|
# @param id [Integer] The primary key of this setting
|
68
|
-
# @return [Object]
|
69
|
-
def get_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
70
|
-
get(path) end
|
71
|
-
|
72
|
-
# Retrieve all settings for this company
|
73
|
-
#
|
68
|
+
# @return [Object]
|
69
|
+
def get_setting(companyId, id) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
70
|
+
get(path) end
|
71
|
+
|
72
|
+
# Retrieve all settings for this company
|
73
|
+
#
|
74
74
|
# List all setting objects attached to this company.
|
75
75
|
#
|
76
76
|
# The company settings system is a metadata system that you can use to store extra information
|
@@ -87,19 +87,19 @@ module AvaTax
|
|
87
87
|
#
|
88
88
|
# ### Security Policies
|
89
89
|
#
|
90
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
90
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
91
91
|
# @param companyId [Integer] The ID of the company that owns these settings
|
92
92
|
# @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/).
|
93
93
|
# @param include [String] A comma separated list of additional data to retrieve.
|
94
94
|
# @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.
|
95
95
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
96
96
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
97
|
-
# @return [FetchResult]
|
98
|
-
def list_settings_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/settings"
|
99
|
-
get(path, options) end
|
100
|
-
|
101
|
-
# Retrieve all settings
|
102
|
-
#
|
97
|
+
# @return [FetchResult]
|
98
|
+
def list_settings_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/settings"
|
99
|
+
get(path, options) end
|
100
|
+
|
101
|
+
# Retrieve all settings
|
102
|
+
#
|
103
103
|
# Get multiple setting objects across all companies.
|
104
104
|
#
|
105
105
|
# The company settings system is a metadata system that you can use to store extra information
|
@@ -116,18 +116,18 @@ module AvaTax
|
|
116
116
|
#
|
117
117
|
# ### Security Policies
|
118
118
|
#
|
119
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
119
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
120
120
|
# @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/).
|
121
121
|
# @param include [String] A comma separated list of additional data to retrieve.
|
122
122
|
# @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.
|
123
123
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
124
124
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
125
|
-
# @return [FetchResult]
|
126
|
-
def query_settings(options={}) path = "/api/v2/settings"
|
127
|
-
get(path, options) end
|
128
|
-
|
129
|
-
# Update a single setting
|
130
|
-
#
|
125
|
+
# @return [FetchResult]
|
126
|
+
def query_settings(options={}) path = "/api/v2/settings"
|
127
|
+
get(path, options) end
|
128
|
+
|
129
|
+
# Update a single setting
|
130
|
+
#
|
131
131
|
# Replace the existing setting object at this URL with an updated object.
|
132
132
|
#
|
133
133
|
# The company settings system is a metadata system that you can use to store extra information
|
@@ -145,13 +145,13 @@ module AvaTax
|
|
145
145
|
#
|
146
146
|
# ### Security Policies
|
147
147
|
#
|
148
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
148
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
149
149
|
# @param companyId [Integer] The ID of the company that this setting belongs to.
|
150
150
|
# @param id [Integer] The ID of the setting you wish to update
|
151
151
|
# @param model [Object] The setting you wish to update.
|
152
|
-
# @return [Object]
|
153
|
-
def update_setting(companyId, id, model) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
154
|
-
put(path, model) end
|
155
|
-
end
|
156
|
-
end
|
152
|
+
# @return [Object]
|
153
|
+
def update_setting(companyId, id, model) path = "/api/v2/companies/#{companyId}/settings/#{id}"
|
154
|
+
put(path, model) end
|
155
|
+
end
|
156
|
+
end
|
157
157
|
end
|
@@ -1,25 +1,25 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Subscriptions
|
4
|
-
|
5
|
-
|
6
|
-
# Retrieve a single subscription
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Subscriptions
|
4
|
+
|
5
|
+
|
6
|
+
# Retrieve a single subscription
|
7
|
+
#
|
8
8
|
# Get the subscription object identified by this URL.
|
9
9
|
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
10
10
|
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
11
11
|
#
|
12
12
|
# ### Security Policies
|
13
13
|
#
|
14
|
-
# * 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.
|
14
|
+
# * 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.
|
15
15
|
# @param accountId [Integer] The ID of the account that owns this subscription
|
16
16
|
# @param id [Integer] The primary key of this subscription
|
17
|
-
# @return [Object]
|
18
|
-
def get_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
19
|
-
get(path) end
|
20
|
-
|
21
|
-
# Retrieve subscriptions for this account
|
22
|
-
#
|
17
|
+
# @return [Object]
|
18
|
+
def get_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
19
|
+
get(path) end
|
20
|
+
|
21
|
+
# Retrieve subscriptions for this account
|
22
|
+
#
|
23
23
|
# List all subscription objects attached to this account.
|
24
24
|
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
25
25
|
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
@@ -29,18 +29,18 @@ module AvaTax
|
|
29
29
|
#
|
30
30
|
# ### Security Policies
|
31
31
|
#
|
32
|
-
# * 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.
|
32
|
+
# * 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.
|
33
33
|
# @param accountId [Integer] The ID of the account that owns these subscriptions
|
34
34
|
# @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:* subscriptionDescription
|
35
35
|
# @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.
|
36
36
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
37
37
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
38
|
-
# @return [FetchResult]
|
39
|
-
def list_subscriptions_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/subscriptions"
|
40
|
-
get(path, options) end
|
41
|
-
|
42
|
-
# Retrieve all subscriptions
|
43
|
-
#
|
38
|
+
# @return [FetchResult]
|
39
|
+
def list_subscriptions_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/subscriptions"
|
40
|
+
get(path, options) end
|
41
|
+
|
42
|
+
# Retrieve all subscriptions
|
43
|
+
#
|
44
44
|
# Get multiple subscription objects across all accounts.
|
45
45
|
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
46
46
|
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
@@ -50,14 +50,14 @@ module AvaTax
|
|
50
50
|
#
|
51
51
|
# ### Security Policies
|
52
52
|
#
|
53
|
-
# * 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.
|
53
|
+
# * 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.
|
54
54
|
# @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:* subscriptionDescription
|
55
55
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
56
56
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
57
57
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
58
|
-
# @return [FetchResult]
|
59
|
-
def query_subscriptions(options={}) path = "/api/v2/subscriptions"
|
60
|
-
get(path, options) end
|
61
|
-
end
|
62
|
-
end
|
58
|
+
# @return [FetchResult]
|
59
|
+
def query_subscriptions(options={}) path = "/api/v2/subscriptions"
|
60
|
+
get(path, options) end
|
61
|
+
end
|
62
|
+
end
|
63
63
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module TaxCodes
|
4
|
-
|
5
|
-
|
6
|
-
# Create a new tax code
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module TaxCodes
|
4
|
+
|
5
|
+
|
6
|
+
# Create a new tax code
|
7
|
+
#
|
8
8
|
# Create one or more new taxcode objects attached to this company.
|
9
9
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
10
10
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -13,28 +13,28 @@ 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 tax code.
|
18
18
|
# @param model [TaxCodeModel[]] The tax code you wish to create.
|
19
|
-
# @return [TaxCodeModel[]]
|
20
|
-
def create_tax_codes(companyId, model) path = "/api/v2/companies/#{companyId}/taxcodes"
|
21
|
-
post(path, model) end
|
22
|
-
|
23
|
-
# Delete a single tax code
|
24
|
-
#
|
19
|
+
# @return [TaxCodeModel[]]
|
20
|
+
def create_tax_codes(companyId, model) path = "/api/v2/companies/#{companyId}/taxcodes"
|
21
|
+
post(path, model) end
|
22
|
+
|
23
|
+
# Delete a single tax code
|
24
|
+
#
|
25
25
|
# Marks the existing TaxCode object at this URL as deleted.
|
26
26
|
#
|
27
27
|
# ### Security Policies
|
28
28
|
#
|
29
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
29
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
30
30
|
# @param companyId [Integer] The ID of the company that owns this tax code.
|
31
31
|
# @param id [Integer] The ID of the tax code you wish to delete.
|
32
|
-
# @return [ErrorDetail[]]
|
33
|
-
def delete_tax_code(companyId, id) path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
|
34
|
-
delete(path) end
|
35
|
-
|
36
|
-
# Retrieve a single tax code
|
37
|
-
#
|
32
|
+
# @return [ErrorDetail[]]
|
33
|
+
def delete_tax_code(companyId, id) path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
|
34
|
+
delete(path) end
|
35
|
+
|
36
|
+
# Retrieve a single tax code
|
37
|
+
#
|
38
38
|
# Get the taxcode object identified by this URL.
|
39
39
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
40
40
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -43,15 +43,15 @@ module AvaTax
|
|
43
43
|
#
|
44
44
|
# ### Security Policies
|
45
45
|
#
|
46
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
46
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
47
47
|
# @param companyId [Integer] The ID of the company that owns this tax code
|
48
48
|
# @param id [Integer] The primary key of this tax code
|
49
|
-
# @return [Object]
|
50
|
-
def get_tax_code(companyId, id) path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
|
51
|
-
get(path) end
|
52
|
-
|
53
|
-
# Retrieve tax codes for this company
|
54
|
-
#
|
49
|
+
# @return [Object]
|
50
|
+
def get_tax_code(companyId, id) path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
|
51
|
+
get(path) end
|
52
|
+
|
53
|
+
# Retrieve tax codes for this company
|
54
|
+
#
|
55
55
|
# List all taxcode objects attached to this company.
|
56
56
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
57
57
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -63,19 +63,19 @@ module AvaTax
|
|
63
63
|
#
|
64
64
|
# ### Security Policies
|
65
65
|
#
|
66
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
66
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
67
67
|
# @param companyId [Integer] The ID of the company that owns these tax codes
|
68
68
|
# @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/).
|
69
69
|
# @param include [String] A comma separated list of additional data to retrieve.
|
70
70
|
# @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.
|
71
71
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
72
72
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
73
|
-
# @return [FetchResult]
|
74
|
-
def list_tax_codes_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/taxcodes"
|
75
|
-
get(path, options) end
|
76
|
-
|
77
|
-
# Retrieve all tax codes
|
78
|
-
#
|
73
|
+
# @return [FetchResult]
|
74
|
+
def list_tax_codes_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/taxcodes"
|
75
|
+
get(path, options) end
|
76
|
+
|
77
|
+
# Retrieve all tax codes
|
78
|
+
#
|
79
79
|
# Get multiple taxcode objects across all companies.
|
80
80
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
81
81
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -87,18 +87,18 @@ module AvaTax
|
|
87
87
|
#
|
88
88
|
# ### Security Policies
|
89
89
|
#
|
90
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
90
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
91
91
|
# @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/).
|
92
92
|
# @param include [String] A comma separated list of additional data to retrieve.
|
93
93
|
# @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.
|
94
94
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
95
95
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
96
|
-
# @return [FetchResult]
|
97
|
-
def query_tax_codes(options={}) path = "/api/v2/taxcodes"
|
98
|
-
get(path, options) end
|
99
|
-
|
100
|
-
# Update a single tax code
|
101
|
-
#
|
96
|
+
# @return [FetchResult]
|
97
|
+
def query_tax_codes(options={}) path = "/api/v2/taxcodes"
|
98
|
+
get(path, options) end
|
99
|
+
|
100
|
+
# Update a single tax code
|
101
|
+
#
|
102
102
|
# Replace the existing taxcode object at this URL with an updated object.
|
103
103
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
104
104
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -109,13 +109,13 @@ module AvaTax
|
|
109
109
|
#
|
110
110
|
# ### Security Policies
|
111
111
|
#
|
112
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
112
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
113
113
|
# @param companyId [Integer] The ID of the company that this tax code belongs to.
|
114
114
|
# @param id [Integer] The ID of the tax code you wish to update
|
115
115
|
# @param model [Object] The tax code you wish to update.
|
116
|
-
# @return [Object]
|
117
|
-
def update_tax_code(companyId, id, model) path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
|
118
|
-
put(path, model) end
|
119
|
-
end
|
120
|
-
end
|
116
|
+
# @return [Object]
|
117
|
+
def update_tax_code(companyId, id, model) path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
|
118
|
+
put(path, model) end
|
119
|
+
end
|
120
|
+
end
|
121
121
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module TaxContent
|
4
|
-
|
5
|
-
|
6
|
-
# Build a multi-location tax content file
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module TaxContent
|
4
|
+
|
5
|
+
|
6
|
+
# Build a multi-location tax content file
|
7
|
+
#
|
8
8
|
# Builds a tax content file containing information useful for a retail point-of-sale solution.
|
9
9
|
#
|
10
10
|
# Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
|
@@ -32,14 +32,14 @@ module AvaTax
|
|
32
32
|
# ### Security Policies
|
33
33
|
#
|
34
34
|
# * 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.
|
35
|
-
# * This API depends on the following active services
|
35
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
36
36
|
# @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
|
37
|
-
# @return [Object]
|
38
|
-
def build_tax_content_file(model) path = "/api/v2/pointofsaledata/build"
|
39
|
-
post(path, model) end
|
40
|
-
|
41
|
-
# Build a tax content file for a single location
|
42
|
-
#
|
37
|
+
# @return [Object]
|
38
|
+
def build_tax_content_file(model) path = "/api/v2/pointofsaledata/build"
|
39
|
+
post(path, model) end
|
40
|
+
|
41
|
+
# Build a tax content file for a single location
|
42
|
+
#
|
43
43
|
# Builds a tax content file containing information useful for a retail point-of-sale solution.
|
44
44
|
#
|
45
45
|
# Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
|
@@ -67,19 +67,19 @@ module AvaTax
|
|
67
67
|
# ### Security Policies
|
68
68
|
#
|
69
69
|
# * 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.
|
70
|
-
# * This API depends on the following active services
|
70
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
|
71
71
|
# @param companyId [Integer] The ID number of the company that owns this location.
|
72
72
|
# @param id [Integer] The ID number of the location to retrieve point-of-sale data.
|
73
73
|
# @param date [DateTime] The date for which point-of-sale data would be calculated (today by default)
|
74
74
|
# @param format [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
|
75
75
|
# @param partnerId [String] If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)
|
76
76
|
# @param includeJurisCodes [Boolean] When true, the file will include jurisdiction codes in the result.
|
77
|
-
# @return [Object]
|
78
|
-
def build_tax_content_file_for_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
|
79
|
-
get(path, options) end
|
80
|
-
|
81
|
-
# Download a file listing tax rates by postal code
|
82
|
-
#
|
77
|
+
# @return [Object]
|
78
|
+
def build_tax_content_file_for_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
|
79
|
+
get(path, options) end
|
80
|
+
|
81
|
+
# Download a file listing tax rates by postal code
|
82
|
+
#
|
83
83
|
# Download a CSV file containing all five digit postal codes in the United States and their sales
|
84
84
|
# and use tax rates for tangible personal property.
|
85
85
|
#
|
@@ -123,12 +123,12 @@ module AvaTax
|
|
123
123
|
#
|
124
124
|
# ### Security Policies
|
125
125
|
#
|
126
|
-
# * 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.
|
126
|
+
# * 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.
|
127
127
|
# @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
|
128
128
|
# @param region [String] A two character region code which limits results to a specific region.
|
129
|
-
# @return [Object]
|
130
|
-
def download_tax_rates_by_zip_code(date, options={}) path = "/api/v2/taxratesbyzipcode/download/#{date}"
|
131
|
-
get(path, options) end
|
132
|
-
end
|
133
|
-
end
|
129
|
+
# @return [Object]
|
130
|
+
def download_tax_rates_by_zip_code(date, options={}) path = "/api/v2/taxratesbyzipcode/download/#{date}"
|
131
|
+
get(path, options) end
|
132
|
+
end
|
133
|
+
end
|
134
134
|
end
|