avatax 20.7.0 → 21.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/.vs/slnx.sqlite +0 -0
- data/lib/avatax/client/accounts.rb +22 -55
- data/lib/avatax/client/addresses.rb +7 -13
- data/lib/avatax/client/advancedrules.rb +10 -38
- data/lib/avatax/client/avafileforms.rb +15 -30
- data/lib/avatax/client/batches.rb +16 -40
- data/lib/avatax/client/certexpressinvites.rb +21 -30
- data/lib/avatax/client/certificates.rb +97 -142
- data/lib/avatax/client/companies.rb +137 -80
- data/lib/avatax/client/compliance.rb +2 -5
- data/lib/avatax/client/contacts.rb +12 -30
- data/lib/avatax/client/customers.rb +87 -126
- data/lib/avatax/client/datasources.rb +18 -36
- data/lib/avatax/client/definitions.rb +126 -303
- data/lib/avatax/client/distancethresholds.rb +12 -30
- 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 +17 -5
- data/lib/avatax/client/filings.rb +15 -7
- data/lib/avatax/client/firmclientlinkages.rb +18 -45
- data/lib/avatax/client/free.rb +2 -84
- data/lib/avatax/client/fundingrequests.rb +6 -12
- data/lib/avatax/client/items.rb +38 -95
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -30
- data/lib/avatax/client/locations.rb +128 -38
- data/lib/avatax/client/multidocument.rb +32 -62
- data/lib/avatax/client/nexus.rb +138 -37
- data/lib/avatax/client/notices.rb +47 -139
- data/lib/avatax/client/notifications.rb +6 -15
- data/lib/avatax/client/provisioning.rb +4 -10
- data/lib/avatax/client/registrar.rb +20 -50
- data/lib/avatax/client/reports.rb +17 -20
- data/lib/avatax/client/settings.rb +12 -30
- data/lib/avatax/client/subscriptions.rb +6 -15
- data/lib/avatax/client/taxcodes.rb +12 -30
- data/lib/avatax/client/taxcontent.rb +70 -16
- data/lib/avatax/client/taxprofiles.rb +14 -10
- data/lib/avatax/client/taxrules.rb +12 -30
- data/lib/avatax/client/transactions.rb +63 -126
- data/lib/avatax/client/upcs.rb +18 -36
- data/lib/avatax/client/users.rb +16 -40
- data/lib/avatax/client/utilities.rb +6 -15
- data/lib/avatax/configuration.rb +1 -1
- data/lib/avatax/request.rb +0 -2
- data/lib/avatax/version.rb +1 -1
- data/spec/avatax/request_spec.rb +25 -0
- metadata +4 -2
@@ -10,15 +10,12 @@ module AvaTax
|
|
10
10
|
# ### Security Policies
|
11
11
|
#
|
12
12
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
13
|
-
# * This API depends on the following active services
|
13
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
14
14
|
# @param companyId [Integer] The id of the company you which to create the datasources
|
15
15
|
# @param model [DataSourceModel[]]
|
16
16
|
# @return [DataSourceModel[]]
|
17
|
-
def create_data_sources(companyId, model)
|
18
|
-
path
|
19
|
-
post(path, model)
|
20
|
-
end
|
21
|
-
|
17
|
+
def create_data_sources(companyId, model) path = "/api/v2/companies/#{companyId}/datasources"
|
18
|
+
post(path, model) end
|
22
19
|
|
23
20
|
# Delete a datasource by datasource id for a company.
|
24
21
|
#
|
@@ -27,15 +24,12 @@ module AvaTax
|
|
27
24
|
# ### Security Policies
|
28
25
|
#
|
29
26
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
30
|
-
# * This API depends on the following active services
|
27
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
31
28
|
# @param companyId [Integer] The id of the company the datasource belongs to.
|
32
29
|
# @param id [Integer] The id of the datasource you wish to delete.
|
33
30
|
# @return [ErrorDetail[]]
|
34
|
-
def delete_data_source(companyId, id)
|
35
|
-
path
|
36
|
-
delete(path)
|
37
|
-
end
|
38
|
-
|
31
|
+
def delete_data_source(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
|
32
|
+
delete(path) end
|
39
33
|
|
40
34
|
# Get data source by data source id
|
41
35
|
#
|
@@ -44,15 +38,12 @@ module AvaTax
|
|
44
38
|
# ### Security Policies
|
45
39
|
#
|
46
40
|
# * 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.
|
47
|
-
# * This API depends on the following active services
|
41
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
48
42
|
# @param companyId [Integer]
|
49
43
|
# @param id [Integer] data source id
|
50
44
|
# @return [Object]
|
51
|
-
def get_data_source_by_id(companyId, id)
|
52
|
-
path
|
53
|
-
get(path)
|
54
|
-
end
|
55
|
-
|
45
|
+
def get_data_source_by_id(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
|
46
|
+
get(path) end
|
56
47
|
|
57
48
|
# Retrieve all datasources for this company
|
58
49
|
#
|
@@ -61,18 +52,15 @@ module AvaTax
|
|
61
52
|
# ### Security Policies
|
62
53
|
#
|
63
54
|
# * 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.
|
64
|
-
# * This API depends on the following active services
|
55
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
65
56
|
# @param companyId [Integer] The id of the company you wish to retrieve the datasources.
|
66
57
|
# @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:* isEnabled, isSynced, isAuthorized, name, externalState
|
67
58
|
# @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.
|
68
59
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
69
60
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
70
61
|
# @return [FetchResult]
|
71
|
-
def list_data_sources(companyId, options={})
|
72
|
-
path
|
73
|
-
get(path, options)
|
74
|
-
end
|
75
|
-
|
62
|
+
def list_data_sources(companyId, options={}) path = "/api/v2/companies/#{companyId}/datasources"
|
63
|
+
get(path, options) end
|
76
64
|
|
77
65
|
# Retrieve all datasources
|
78
66
|
#
|
@@ -84,17 +72,14 @@ module AvaTax
|
|
84
72
|
# ### Security Policies
|
85
73
|
#
|
86
74
|
# * 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.
|
87
|
-
# * This API depends on the following active services
|
75
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
88
76
|
# @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:* isEnabled, isSynced, isAuthorized, name, externalState
|
89
77
|
# @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.
|
90
78
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
91
79
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
92
80
|
# @return [FetchResult]
|
93
|
-
def query_data_sources(options={})
|
94
|
-
path
|
95
|
-
get(path, options)
|
96
|
-
end
|
97
|
-
|
81
|
+
def query_data_sources(options={}) path = "/api/v2/datasources"
|
82
|
+
get(path, options) end
|
98
83
|
|
99
84
|
# Update a datasource identified by id for a company
|
100
85
|
#
|
@@ -103,16 +88,13 @@ module AvaTax
|
|
103
88
|
# ### Security Policies
|
104
89
|
#
|
105
90
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
106
|
-
# * This API depends on the following active services
|
91
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
107
92
|
# @param companyId [Integer] The id of the company the datasource belongs to.
|
108
93
|
# @param id [Integer] The id of the datasource you wish to delete.
|
109
94
|
# @param model [Object]
|
110
95
|
# @return [Object]
|
111
|
-
def update_data_source(companyId, id, model)
|
112
|
-
path
|
113
|
-
put(path, model)
|
114
|
-
end
|
115
|
-
|
96
|
+
def update_data_source(companyId, id, model) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
|
97
|
+
put(path, model) end
|
116
98
|
end
|
117
99
|
end
|
118
100
|
end
|
@@ -18,15 +18,12 @@ module AvaTax
|
|
18
18
|
#
|
19
19
|
# ### Security Policies
|
20
20
|
#
|
21
|
-
# * This API depends on the following active services
|
21
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
22
22
|
# @param country [String] The name or code of the destination country.
|
23
23
|
# @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
|
24
24
|
# @return [FetchResult]
|
25
|
-
def get_cross_border_code(country, hsCode)
|
26
|
-
path
|
27
|
-
get(path)
|
28
|
-
end
|
29
|
-
|
25
|
+
def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
|
26
|
+
get(path) end
|
30
27
|
|
31
28
|
# Test whether a form supports online login verification
|
32
29
|
#
|
@@ -38,11 +35,8 @@ module AvaTax
|
|
38
35
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
39
36
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
40
37
|
# @return [FetchResult]
|
41
|
-
def get_login_verifier_by_form(form, options={})
|
42
|
-
path
|
43
|
-
get(path, options)
|
44
|
-
end
|
45
|
-
|
38
|
+
def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
|
39
|
+
get(path, options) end
|
46
40
|
|
47
41
|
# Retrieve the full list of the AvaFile Forms available
|
48
42
|
#
|
@@ -57,11 +51,8 @@ module AvaTax
|
|
57
51
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
58
52
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
59
53
|
# @return [FetchResult]
|
60
|
-
def list_ava_file_forms(options={})
|
61
|
-
path
|
62
|
-
get(path, options)
|
63
|
-
end
|
64
|
-
|
54
|
+
def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
|
55
|
+
get(path, options) end
|
65
56
|
|
66
57
|
# List certificate attributes used by a company
|
67
58
|
#
|
@@ -78,11 +69,8 @@ module AvaTax
|
|
78
69
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
79
70
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
80
71
|
# @return [FetchResult]
|
81
|
-
def list_certificate_attributes(options={})
|
82
|
-
path
|
83
|
-
get(path, options)
|
84
|
-
end
|
85
|
-
|
72
|
+
def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
|
73
|
+
get(path, options) end
|
86
74
|
|
87
75
|
# List the certificate exempt reasons defined by a company
|
88
76
|
#
|
@@ -98,11 +86,8 @@ module AvaTax
|
|
98
86
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
99
87
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
100
88
|
# @return [FetchResult]
|
101
|
-
def list_certificate_exempt_reasons(options={})
|
102
|
-
path
|
103
|
-
get(path, options)
|
104
|
-
end
|
105
|
-
|
89
|
+
def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
|
90
|
+
get(path, options) end
|
106
91
|
|
107
92
|
# List certificate exposure zones used by a company
|
108
93
|
#
|
@@ -118,11 +103,8 @@ module AvaTax
|
|
118
103
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
119
104
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
120
105
|
# @return [FetchResult]
|
121
|
-
def list_certificate_exposure_zones(options={})
|
122
|
-
path
|
123
|
-
get(path, options)
|
124
|
-
end
|
125
|
-
|
106
|
+
def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
|
107
|
+
get(path, options) end
|
126
108
|
|
127
109
|
# Retrieve the full list of communications service types
|
128
110
|
#
|
@@ -133,11 +115,8 @@ module AvaTax
|
|
133
115
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
134
116
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
135
117
|
# @return [FetchResult]
|
136
|
-
def list_communications_service_types(id, options={})
|
137
|
-
path
|
138
|
-
get(path, options)
|
139
|
-
end
|
140
|
-
|
118
|
+
def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
|
119
|
+
get(path, options) end
|
141
120
|
|
142
121
|
# Retrieve the full list of communications transactiontypes
|
143
122
|
#
|
@@ -148,11 +127,8 @@ module AvaTax
|
|
148
127
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
149
128
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
150
129
|
# @return [FetchResult]
|
151
|
-
def list_communications_transaction_types(options={})
|
152
|
-
path
|
153
|
-
get(path, options)
|
154
|
-
end
|
155
|
-
|
130
|
+
def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
|
131
|
+
get(path, options) end
|
156
132
|
|
157
133
|
# Retrieve the full list of communications transaction/service type pairs
|
158
134
|
#
|
@@ -163,11 +139,8 @@ module AvaTax
|
|
163
139
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
164
140
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
165
141
|
# @return [FetchResult]
|
166
|
-
def list_communications_t_s_pairs(options={})
|
167
|
-
path
|
168
|
-
get(path, options)
|
169
|
-
end
|
170
|
-
|
142
|
+
def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
|
143
|
+
get(path, options) end
|
171
144
|
|
172
145
|
# List all ISO 3166 countries
|
173
146
|
#
|
@@ -179,11 +152,8 @@ module AvaTax
|
|
179
152
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
180
153
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
181
154
|
# @return [FetchResult]
|
182
|
-
def list_countries(options={})
|
183
|
-
path
|
184
|
-
get(path, options)
|
185
|
-
end
|
186
|
-
|
155
|
+
def list_countries(options={}) path = "/api/v2/definitions/countries"
|
156
|
+
get(path, options) end
|
187
157
|
|
188
158
|
# List certificate exposure zones used by a company
|
189
159
|
#
|
@@ -200,11 +170,8 @@ module AvaTax
|
|
200
170
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
201
171
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
202
172
|
# @return [FetchResult]
|
203
|
-
def list_cover_letters(options={})
|
204
|
-
path
|
205
|
-
get(path, options)
|
206
|
-
end
|
207
|
-
|
173
|
+
def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
|
174
|
+
get(path, options) end
|
208
175
|
|
209
176
|
# Lists the next level of HS Codes given a destination country and HS Code prefix.
|
210
177
|
#
|
@@ -219,7 +186,7 @@ module AvaTax
|
|
219
186
|
#
|
220
187
|
# ### Security Policies
|
221
188
|
#
|
222
|
-
# * This API depends on the following active services
|
189
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
223
190
|
# @param country [String] The name or code of the destination country.
|
224
191
|
# @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
|
225
192
|
# @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:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength
|
@@ -227,11 +194,8 @@ module AvaTax
|
|
227
194
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
228
195
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
229
196
|
# @return [FetchResult]
|
230
|
-
def list_cross_border_codes(country, hsCode, options={})
|
231
|
-
path
|
232
|
-
get(path, options)
|
233
|
-
end
|
234
|
-
|
197
|
+
def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
|
198
|
+
get(path, options) end
|
235
199
|
|
236
200
|
# List top level HS Code Sections.
|
237
201
|
#
|
@@ -244,13 +208,10 @@ module AvaTax
|
|
244
208
|
#
|
245
209
|
# ### Security Policies
|
246
210
|
#
|
247
|
-
# * This API depends on the following active services
|
211
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
248
212
|
# @return [FetchResult]
|
249
|
-
def list_cross_border_sections()
|
250
|
-
path
|
251
|
-
get(path)
|
252
|
-
end
|
253
|
-
|
213
|
+
def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
|
214
|
+
get(path) end
|
254
215
|
|
255
216
|
# List all ISO 4217 currencies supported by AvaTax.
|
256
217
|
#
|
@@ -263,11 +224,8 @@ module AvaTax
|
|
263
224
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
264
225
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
265
226
|
# @return [FetchResult]
|
266
|
-
def list_currencies(options={})
|
267
|
-
path
|
268
|
-
get(path, options)
|
269
|
-
end
|
270
|
-
|
227
|
+
def list_currencies(options={}) path = "/api/v2/definitions/currencies"
|
228
|
+
get(path, options) end
|
271
229
|
|
272
230
|
# Retrieve the full list of Avalara-supported entity use codes
|
273
231
|
#
|
@@ -281,11 +239,8 @@ module AvaTax
|
|
281
239
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
282
240
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
283
241
|
# @return [FetchResult]
|
284
|
-
def list_entity_use_codes(options={})
|
285
|
-
path
|
286
|
-
get(path, options)
|
287
|
-
end
|
288
|
-
|
242
|
+
def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
|
243
|
+
get(path, options) end
|
289
244
|
|
290
245
|
# Retrieve the full list of Avalara-supported filing frequencies.
|
291
246
|
#
|
@@ -296,18 +251,15 @@ module AvaTax
|
|
296
251
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
297
252
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
298
253
|
# @return [FetchResult]
|
299
|
-
def list_filing_frequencies(options={})
|
300
|
-
path
|
301
|
-
get(path, options)
|
302
|
-
end
|
303
|
-
|
254
|
+
def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
|
255
|
+
get(path, options) end
|
304
256
|
|
305
257
|
# List jurisdictions based on the filter provided
|
306
258
|
#
|
307
259
|
# Returns a list of all Avalara-supported taxing jurisdictions.
|
308
260
|
#
|
309
261
|
# This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
|
310
|
-
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate
|
262
|
+
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
|
311
263
|
#
|
312
264
|
# The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
|
313
265
|
# @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:* rate, salesRate, signatureCode, useRate
|
@@ -315,11 +267,8 @@ module AvaTax
|
|
315
267
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
316
268
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
317
269
|
# @return [FetchResult]
|
318
|
-
def list_jurisdictions(options={})
|
319
|
-
path
|
320
|
-
get(path, options)
|
321
|
-
end
|
322
|
-
|
270
|
+
def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
|
271
|
+
get(path, options) end
|
323
272
|
|
324
273
|
# List jurisdictions near a specific address
|
325
274
|
#
|
@@ -342,11 +291,8 @@ module AvaTax
|
|
342
291
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
343
292
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
344
293
|
# @return [FetchResult]
|
345
|
-
def list_jurisdictions_by_address(options={})
|
346
|
-
path
|
347
|
-
get(path, options)
|
348
|
-
end
|
349
|
-
|
294
|
+
def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
|
295
|
+
get(path, options) end
|
350
296
|
|
351
297
|
# Retrieve the list of questions that are required for a tax location
|
352
298
|
#
|
@@ -370,11 +316,8 @@ module AvaTax
|
|
370
316
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
371
317
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
372
318
|
# @return [FetchResult]
|
373
|
-
def list_location_questions_by_address(options={})
|
374
|
-
path
|
375
|
-
get(path, options)
|
376
|
-
end
|
377
|
-
|
319
|
+
def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
|
320
|
+
get(path, options) end
|
378
321
|
|
379
322
|
# List all forms where logins can be verified automatically
|
380
323
|
#
|
@@ -386,11 +329,8 @@ module AvaTax
|
|
386
329
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
387
330
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
388
331
|
# @return [FetchResult]
|
389
|
-
def list_login_verifiers(options={})
|
390
|
-
path
|
391
|
-
get(path, options)
|
392
|
-
end
|
393
|
-
|
332
|
+
def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
|
333
|
+
get(path, options) end
|
394
334
|
|
395
335
|
# Retrieve the list of locations for a marketplace.
|
396
336
|
#
|
@@ -400,27 +340,21 @@ module AvaTax
|
|
400
340
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
401
341
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
402
342
|
# @return [FetchResult]
|
403
|
-
def list_marketplace_locations(options={})
|
404
|
-
path
|
405
|
-
get(path, options)
|
406
|
-
end
|
407
|
-
|
343
|
+
def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
|
344
|
+
get(path, options) end
|
408
345
|
|
409
346
|
# Retrieve the full list of Avalara-supported nexus for all countries and regions.
|
410
347
|
#
|
411
348
|
# Returns the full list of all Avalara-supported nexus for all countries and regions.
|
412
349
|
#
|
413
350
|
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
414
|
-
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
|
351
|
+
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
|
415
352
|
# @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.
|
416
353
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
417
354
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
418
355
|
# @return [FetchResult]
|
419
|
-
def list_nexus(options={})
|
420
|
-
path
|
421
|
-
get(path, options)
|
422
|
-
end
|
423
|
-
|
356
|
+
def list_nexus(options={}) path = "/api/v2/definitions/nexus"
|
357
|
+
get(path, options) end
|
424
358
|
|
425
359
|
# List all nexus that apply to a specific address.
|
426
360
|
#
|
@@ -436,16 +370,13 @@ module AvaTax
|
|
436
370
|
# @param region [String] Name or ISO 3166 code identifying the region portion of the address. 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`.
|
437
371
|
# @param postalCode [String] The postal code or zip code portion of this address.
|
438
372
|
# @param country [String] Name or ISO 3166 code identifying the country portion of this address. 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`.
|
439
|
-
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
|
373
|
+
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
|
440
374
|
# @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.
|
441
375
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
442
376
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
443
377
|
# @return [FetchResult]
|
444
|
-
def list_nexus_by_address(options={})
|
445
|
-
path
|
446
|
-
get(path, options)
|
447
|
-
end
|
448
|
-
|
378
|
+
def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
|
379
|
+
get(path, options) end
|
449
380
|
|
450
381
|
# Retrieve the full list of Avalara-supported nexus for a country.
|
451
382
|
#
|
@@ -453,16 +384,13 @@ module AvaTax
|
|
453
384
|
#
|
454
385
|
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
|
455
386
|
# @param country [String] The country in which you want to fetch the system nexus
|
456
|
-
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
|
387
|
+
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
|
457
388
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
458
389
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
459
390
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
460
391
|
# @return [FetchResult]
|
461
|
-
def list_nexus_by_country(country, options={})
|
462
|
-
path
|
463
|
-
get(path, options)
|
464
|
-
end
|
465
|
-
|
392
|
+
def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
|
393
|
+
get(path, options) end
|
466
394
|
|
467
395
|
# Retrieve the full list of Avalara-supported nexus for a country and region.
|
468
396
|
#
|
@@ -471,16 +399,13 @@ module AvaTax
|
|
471
399
|
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
|
472
400
|
# @param country [String] The two-character ISO-3166 code for the country.
|
473
401
|
# @param region [String] The two or three character region code for the region.
|
474
|
-
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
|
402
|
+
# @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
|
475
403
|
# @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.
|
476
404
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
477
405
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
478
406
|
# @return [FetchResult]
|
479
|
-
def list_nexus_by_country_and_region(country, region, options={})
|
480
|
-
path
|
481
|
-
get(path, options)
|
482
|
-
end
|
483
|
-
|
407
|
+
def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
|
408
|
+
get(path, options) end
|
484
409
|
|
485
410
|
# List nexus related to a tax form
|
486
411
|
#
|
@@ -501,11 +426,8 @@ module AvaTax
|
|
501
426
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
502
427
|
# @param formCode [String] The form code that we are looking up the nexus for
|
503
428
|
# @return [Object]
|
504
|
-
def list_nexus_by_form_code(formCode)
|
505
|
-
path
|
506
|
-
get(path)
|
507
|
-
end
|
508
|
-
|
429
|
+
def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
|
430
|
+
get(path) end
|
509
431
|
|
510
432
|
# Retrieve the full list of nexus tax type groups
|
511
433
|
#
|
@@ -516,11 +438,8 @@ module AvaTax
|
|
516
438
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
517
439
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
518
440
|
# @return [FetchResult]
|
519
|
-
def list_nexus_tax_type_groups(options={})
|
520
|
-
path
|
521
|
-
get(path, options)
|
522
|
-
end
|
523
|
-
|
441
|
+
def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
|
442
|
+
get(path, options) end
|
524
443
|
|
525
444
|
# Retrieve the full list of Avalara-supported tax notice customer funding options.
|
526
445
|
#
|
@@ -531,11 +450,8 @@ module AvaTax
|
|
531
450
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
532
451
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
533
452
|
# @return [FetchResult]
|
534
|
-
def list_notice_customer_funding_options(options={})
|
535
|
-
path
|
536
|
-
get(path, options)
|
537
|
-
end
|
538
|
-
|
453
|
+
def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
|
454
|
+
get(path, options) end
|
539
455
|
|
540
456
|
# Retrieve the full list of Avalara-supported tax notice customer types.
|
541
457
|
#
|
@@ -546,11 +462,8 @@ module AvaTax
|
|
546
462
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
547
463
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
548
464
|
# @return [FetchResult]
|
549
|
-
def list_notice_customer_types(options={})
|
550
|
-
path
|
551
|
-
get(path, options)
|
552
|
-
end
|
553
|
-
|
465
|
+
def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
|
466
|
+
get(path, options) end
|
554
467
|
|
555
468
|
# Retrieve the full list of Avalara-supported tax notice filing types.
|
556
469
|
#
|
@@ -561,11 +474,8 @@ module AvaTax
|
|
561
474
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
562
475
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
563
476
|
# @return [FetchResult]
|
564
|
-
def list_notice_filingtypes(options={})
|
565
|
-
path
|
566
|
-
get(path, options)
|
567
|
-
end
|
568
|
-
|
477
|
+
def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
|
478
|
+
get(path, options) end
|
569
479
|
|
570
480
|
# Retrieve the full list of Avalara-supported tax notice priorities.
|
571
481
|
#
|
@@ -576,11 +486,8 @@ module AvaTax
|
|
576
486
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
577
487
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
578
488
|
# @return [FetchResult]
|
579
|
-
def list_notice_priorities(options={})
|
580
|
-
path
|
581
|
-
get(path, options)
|
582
|
-
end
|
583
|
-
|
489
|
+
def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
|
490
|
+
get(path, options) end
|
584
491
|
|
585
492
|
# Retrieve the full list of Avalara-supported tax notice reasons.
|
586
493
|
#
|
@@ -591,11 +498,8 @@ module AvaTax
|
|
591
498
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
592
499
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
593
500
|
# @return [FetchResult]
|
594
|
-
def list_notice_reasons(options={})
|
595
|
-
path
|
596
|
-
get(path, options)
|
597
|
-
end
|
598
|
-
|
501
|
+
def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
|
502
|
+
get(path, options) end
|
599
503
|
|
600
504
|
# Retrieve the full list of Avalara-supported tax notice responsibility ids
|
601
505
|
#
|
@@ -606,11 +510,8 @@ module AvaTax
|
|
606
510
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
607
511
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
608
512
|
# @return [FetchResult]
|
609
|
-
def list_notice_responsibilities(options={})
|
610
|
-
path
|
611
|
-
get(path, options)
|
612
|
-
end
|
613
|
-
|
513
|
+
def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
|
514
|
+
get(path, options) end
|
614
515
|
|
615
516
|
# Retrieve the full list of Avalara-supported tax notice root causes
|
616
517
|
#
|
@@ -621,11 +522,8 @@ module AvaTax
|
|
621
522
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
622
523
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
623
524
|
# @return [FetchResult]
|
624
|
-
def list_notice_root_causes(options={})
|
625
|
-
path
|
626
|
-
get(path, options)
|
627
|
-
end
|
628
|
-
|
525
|
+
def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
|
526
|
+
get(path, options) end
|
629
527
|
|
630
528
|
# Retrieve the full list of Avalara-supported tax notice statuses.
|
631
529
|
#
|
@@ -636,11 +534,8 @@ module AvaTax
|
|
636
534
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
637
535
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
638
536
|
# @return [FetchResult]
|
639
|
-
def list_notice_statuses(options={})
|
640
|
-
path
|
641
|
-
get(path, options)
|
642
|
-
end
|
643
|
-
|
537
|
+
def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
|
538
|
+
get(path, options) end
|
644
539
|
|
645
540
|
# Retrieve the full list of Avalara-supported tax notice types.
|
646
541
|
#
|
@@ -651,11 +546,8 @@ module AvaTax
|
|
651
546
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
652
547
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
653
548
|
# @return [FetchResult]
|
654
|
-
def list_notice_types(options={})
|
655
|
-
path
|
656
|
-
get(path, options)
|
657
|
-
end
|
658
|
-
|
549
|
+
def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
|
550
|
+
get(path, options) end
|
659
551
|
|
660
552
|
# Retrieve the full list of Avalara-supported extra parameters for creating transactions.
|
661
553
|
#
|
@@ -667,11 +559,8 @@ module AvaTax
|
|
667
559
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
668
560
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
669
561
|
# @return [FetchResult]
|
670
|
-
def list_parameters(options={})
|
671
|
-
path
|
672
|
-
get(path, options)
|
673
|
-
end
|
674
|
-
|
562
|
+
def list_parameters(options={}) path = "/api/v2/definitions/parameters"
|
563
|
+
get(path, options) end
|
675
564
|
|
676
565
|
# Retrieve the parameters by companyCode and itemCode.
|
677
566
|
#
|
@@ -687,11 +576,8 @@ module AvaTax
|
|
687
576
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
688
577
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
689
578
|
# @return [FetchResult]
|
690
|
-
def list_parameters_by_item(companyCode, itemCode, options={})
|
691
|
-
path
|
692
|
-
get(path, options)
|
693
|
-
end
|
694
|
-
|
579
|
+
def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
|
580
|
+
get(path, options) end
|
695
581
|
|
696
582
|
# Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
|
697
583
|
#
|
@@ -703,11 +589,8 @@ module AvaTax
|
|
703
589
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
704
590
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
705
591
|
# @return [FetchResult]
|
706
|
-
def list_parameters_usage(options={})
|
707
|
-
path
|
708
|
-
get(path, options)
|
709
|
-
end
|
710
|
-
|
592
|
+
def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
|
593
|
+
get(path, options) end
|
711
594
|
|
712
595
|
# Retrieve the full list of Avalara-supported permissions
|
713
596
|
#
|
@@ -716,11 +599,8 @@ module AvaTax
|
|
716
599
|
# @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.
|
717
600
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
718
601
|
# @return [FetchResult]
|
719
|
-
def list_permissions(options={})
|
720
|
-
path
|
721
|
-
get(path, options)
|
722
|
-
end
|
723
|
-
|
602
|
+
def list_permissions(options={}) path = "/api/v2/definitions/permissions"
|
603
|
+
get(path, options) end
|
724
604
|
|
725
605
|
# Retrieve the full list of Avalara-supported postal codes.
|
726
606
|
#
|
@@ -730,11 +610,8 @@ module AvaTax
|
|
730
610
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
731
611
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
732
612
|
# @return [FetchResult]
|
733
|
-
def list_postal_codes(options={})
|
734
|
-
path
|
735
|
-
get(path, options)
|
736
|
-
end
|
737
|
-
|
613
|
+
def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
|
614
|
+
get(path, options) end
|
738
615
|
|
739
616
|
# List all customs duty programs recognized by AvaTax
|
740
617
|
#
|
@@ -752,11 +629,8 @@ module AvaTax
|
|
752
629
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
753
630
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
754
631
|
# @return [FetchResult]
|
755
|
-
def list_preferred_programs(options={})
|
756
|
-
path
|
757
|
-
get(path, options)
|
758
|
-
end
|
759
|
-
|
632
|
+
def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
|
633
|
+
get(path, options) end
|
760
634
|
|
761
635
|
# List all available product classification systems.
|
762
636
|
#
|
@@ -770,11 +644,8 @@ module AvaTax
|
|
770
644
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
771
645
|
# @param countryCode [String] If not null, return all records with this code.
|
772
646
|
# @return [FetchResult]
|
773
|
-
def list_product_classification_systems(options={})
|
774
|
-
path
|
775
|
-
get(path, options)
|
776
|
-
end
|
777
|
-
|
647
|
+
def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
|
648
|
+
get(path, options) end
|
778
649
|
|
779
650
|
# List all product classification systems available to a company based on its nexus.
|
780
651
|
#
|
@@ -789,11 +660,8 @@ module AvaTax
|
|
789
660
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
790
661
|
# @param countryCode [String] If not null, return all records with this code.
|
791
662
|
# @return [FetchResult]
|
792
|
-
def list_product_classification_systems_by_company(companyCode, options={})
|
793
|
-
path
|
794
|
-
get(path, options)
|
795
|
-
end
|
796
|
-
|
663
|
+
def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
|
664
|
+
get(path, options) end
|
797
665
|
|
798
666
|
# Retrieve the full list of rate types for each country
|
799
667
|
#
|
@@ -805,11 +673,8 @@ module AvaTax
|
|
805
673
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
806
674
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
807
675
|
# @return [FetchResult]
|
808
|
-
def list_rate_types_by_country(country, options={})
|
809
|
-
path
|
810
|
-
get(path, options)
|
811
|
-
end
|
812
|
-
|
676
|
+
def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
|
677
|
+
get(path, options) end
|
813
678
|
|
814
679
|
# List all ISO 3166 regions
|
815
680
|
#
|
@@ -821,11 +686,8 @@ module AvaTax
|
|
821
686
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
822
687
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
823
688
|
# @return [FetchResult]
|
824
|
-
def list_regions(options={})
|
825
|
-
path
|
826
|
-
get(path, options)
|
827
|
-
end
|
828
|
-
|
689
|
+
def list_regions(options={}) path = "/api/v2/definitions/regions"
|
690
|
+
get(path, options) end
|
829
691
|
|
830
692
|
# List all ISO 3166 regions for a country
|
831
693
|
#
|
@@ -838,11 +700,8 @@ module AvaTax
|
|
838
700
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
839
701
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
840
702
|
# @return [FetchResult]
|
841
|
-
def list_regions_by_country(country, options={})
|
842
|
-
path
|
843
|
-
get(path, options)
|
844
|
-
end
|
845
|
-
|
703
|
+
def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
|
704
|
+
get(path, options) end
|
846
705
|
|
847
706
|
# Retrieve the full list of Avalara-supported resource file types
|
848
707
|
#
|
@@ -853,11 +712,8 @@ module AvaTax
|
|
853
712
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
854
713
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
855
714
|
# @return [FetchResult]
|
856
|
-
def list_resource_file_types(options={})
|
857
|
-
path
|
858
|
-
get(path, options)
|
859
|
-
end
|
860
|
-
|
715
|
+
def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
|
716
|
+
get(path, options) end
|
861
717
|
|
862
718
|
# Retrieve the full list of Avalara-supported permissions
|
863
719
|
#
|
@@ -869,11 +725,8 @@ module AvaTax
|
|
869
725
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
870
726
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
871
727
|
# @return [FetchResult]
|
872
|
-
def list_security_roles(options={})
|
873
|
-
path
|
874
|
-
get(path, options)
|
875
|
-
end
|
876
|
-
|
728
|
+
def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
|
729
|
+
get(path, options) end
|
877
730
|
|
878
731
|
# Retrieve the full list of Avalara-supported subscription types
|
879
732
|
#
|
@@ -886,11 +739,8 @@ module AvaTax
|
|
886
739
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
887
740
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
888
741
|
# @return [FetchResult]
|
889
|
-
def list_subscription_types(options={})
|
890
|
-
path
|
891
|
-
get(path, options)
|
892
|
-
end
|
893
|
-
|
742
|
+
def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
|
743
|
+
get(path, options) end
|
894
744
|
|
895
745
|
# Retrieve the full list of Avalara-supported tax authorities.
|
896
746
|
#
|
@@ -901,11 +751,8 @@ module AvaTax
|
|
901
751
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
902
752
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
903
753
|
# @return [FetchResult]
|
904
|
-
def list_tax_authorities(options={})
|
905
|
-
path
|
906
|
-
get(path, options)
|
907
|
-
end
|
908
|
-
|
754
|
+
def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
|
755
|
+
get(path, options) end
|
909
756
|
|
910
757
|
# Retrieve the full list of Avalara-supported forms for each tax authority.
|
911
758
|
#
|
@@ -918,11 +765,8 @@ module AvaTax
|
|
918
765
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
919
766
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
920
767
|
# @return [FetchResult]
|
921
|
-
def list_tax_authority_forms(options={})
|
922
|
-
path
|
923
|
-
get(path, options)
|
924
|
-
end
|
925
|
-
|
768
|
+
def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
|
769
|
+
get(path, options) end
|
926
770
|
|
927
771
|
# Retrieve the full list of Avalara-supported tax authority types.
|
928
772
|
#
|
@@ -933,11 +777,8 @@ module AvaTax
|
|
933
777
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
934
778
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
935
779
|
# @return [FetchResult]
|
936
|
-
def list_tax_authority_types(options={})
|
937
|
-
path
|
938
|
-
get(path, options)
|
939
|
-
end
|
940
|
-
|
780
|
+
def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
|
781
|
+
get(path, options) end
|
941
782
|
|
942
783
|
# Retrieve the full list of Avalara-supported tax codes.
|
943
784
|
#
|
@@ -955,11 +796,8 @@ module AvaTax
|
|
955
796
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
956
797
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
957
798
|
# @return [FetchResult]
|
958
|
-
def list_tax_codes(options={})
|
959
|
-
path
|
960
|
-
get(path, options)
|
961
|
-
end
|
962
|
-
|
799
|
+
def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
|
800
|
+
get(path, options) end
|
963
801
|
|
964
802
|
# Retrieve the full list of Avalara-supported tax code types.
|
965
803
|
#
|
@@ -969,11 +807,8 @@ module AvaTax
|
|
969
807
|
# @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.
|
970
808
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
971
809
|
# @return [Object]
|
972
|
-
def list_tax_code_types(options={})
|
973
|
-
path
|
974
|
-
get(path, options)
|
975
|
-
end
|
976
|
-
|
810
|
+
def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
|
811
|
+
get(path, options) end
|
977
812
|
|
978
813
|
# Retrieve the full list of the Tax Forms available
|
979
814
|
#
|
@@ -984,11 +819,8 @@ module AvaTax
|
|
984
819
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
985
820
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
986
821
|
# @return [FetchResult]
|
987
|
-
def list_tax_forms(options={})
|
988
|
-
path
|
989
|
-
get(path, options)
|
990
|
-
end
|
991
|
-
|
822
|
+
def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
|
823
|
+
get(path, options) end
|
992
824
|
|
993
825
|
# Retrieve the full list of tax sub types
|
994
826
|
#
|
@@ -999,11 +831,8 @@ module AvaTax
|
|
999
831
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1000
832
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1001
833
|
# @return [FetchResult]
|
1002
|
-
def list_tax_sub_types(options={})
|
1003
|
-
path
|
1004
|
-
get(path, options)
|
1005
|
-
end
|
1006
|
-
|
834
|
+
def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
|
835
|
+
get(path, options) end
|
1007
836
|
|
1008
837
|
# Retrieve the full list of tax type groups
|
1009
838
|
#
|
@@ -1014,11 +843,8 @@ module AvaTax
|
|
1014
843
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1015
844
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1016
845
|
# @return [FetchResult]
|
1017
|
-
def list_tax_type_groups(options={})
|
1018
|
-
path
|
1019
|
-
get(path, options)
|
1020
|
-
end
|
1021
|
-
|
846
|
+
def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
|
847
|
+
get(path, options) end
|
1022
848
|
|
1023
849
|
# List all defined units of measurement
|
1024
850
|
#
|
@@ -1030,11 +856,8 @@ module AvaTax
|
|
1030
856
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
1031
857
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
1032
858
|
# @return [FetchResult]
|
1033
|
-
def list_unit_of_measurement(options={})
|
1034
|
-
path
|
1035
|
-
get(path, options)
|
1036
|
-
end
|
1037
|
-
|
859
|
+
def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
|
860
|
+
get(path, options) end
|
1038
861
|
end
|
1039
862
|
end
|
1040
863
|
end
|