avatax 22.5.0 → 22.8.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/.github/workflows/gem-push.yml +31 -0
- data/.gitignore +55 -55
- data/.rspec +1 -1
- data/.vs/VSWorkspaceState.json +5 -5
- data/.yardopts +4 -4
- data/Gemfile +2 -2
- data/LICENSE +201 -201
- data/README.md +98 -98
- data/Rakefile +9 -9
- data/avatax.gemspec +38 -38
- data/example/avatax.rb +47 -47
- data/example/credentials.example.yaml +5 -5
- data/lib/avatax/api.rb +27 -27
- data/lib/avatax/client/accounts.rb +22 -22
- data/lib/avatax/client/addresses.rb +4 -4
- data/lib/avatax/client/advancedrules.rb +5 -5
- data/lib/avatax/client/avafileforms.rb +7 -7
- data/lib/avatax/client/batches.rb +16 -16
- data/lib/avatax/client/certexpressinvites.rb +6 -6
- data/lib/avatax/client/certificates.rb +30 -30
- data/lib/avatax/client/companies.rb +47 -45
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/contacts.rb +12 -12
- data/lib/avatax/client/customers.rb +26 -26
- data/lib/avatax/client/datasources.rb +12 -12
- data/lib/avatax/client/definitions.rb +90 -75
- data/lib/avatax/client/distancethresholds.rb +12 -12
- data/lib/avatax/client/ecms.rb +73 -73
- data/lib/avatax/client/ecommercetoken.rb +4 -4
- data/lib/avatax/client/errortransactions.rb +61 -61
- data/lib/avatax/client/firmclientlinkages.rb +17 -17
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +10 -6
- data/lib/avatax/client/items.rb +64 -64
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -12
- data/lib/avatax/client/locations.rb +24 -24
- data/lib/avatax/client/multidocument.rb +20 -20
- data/lib/avatax/client/nexus.rb +30 -30
- data/lib/avatax/client/notices.rb +8 -8
- data/lib/avatax/client/notifications.rb +6 -6
- data/lib/avatax/client/onboarding.rb +55 -55
- data/lib/avatax/client/pointofsale.rb +21 -21
- data/lib/avatax/client/provisioning.rb +4 -4
- data/lib/avatax/client/registrar.rb +19 -19
- data/lib/avatax/client/reports.rb +7 -7
- data/lib/avatax/client/settings.rb +12 -12
- data/lib/avatax/client/subscriptions.rb +6 -6
- data/lib/avatax/client/taxcodes.rb +12 -12
- data/lib/avatax/client/taxcontent.rb +8 -8
- data/lib/avatax/client/taxprofiles.rb +42 -42
- data/lib/avatax/client/taxrules.rb +12 -12
- data/lib/avatax/client/transactions.rb +41 -41
- data/lib/avatax/client/upcs.rb +12 -12
- data/lib/avatax/client/userdefinedfields.rb +6 -6
- data/lib/avatax/client/users.rb +16 -16
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/client.rb +37 -37
- data/lib/avatax/configuration.rb +76 -76
- data/lib/avatax/connection.rb +53 -53
- data/lib/avatax/request.rb +51 -51
- data/lib/avatax/version.rb +3 -3
- data/lib/avatax.rb +26 -26
- data/spec/avatax/client/accounts_spec.rb +13 -13
- data/spec/avatax/client/transactions_spec.rb +80 -80
- data/spec/avatax/request_spec.rb +25 -25
- data/spec/avatax_spec.rb +45 -45
- data/spec/credentials.yaml.example +4 -4
- data/spec/fixtures/accounts.json +15 -15
- data/spec/spec_helper.rb +27 -27
- metadata +6 -6
- data/.travis.yml +0 -19
@@ -31,12 +31,12 @@ module AvaTax
|
|
31
31
|
#
|
32
32
|
# ### Security Policies
|
33
33
|
#
|
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.
|
34
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
35
35
|
# Swagger Name: AvaTaxClient
|
36
36
|
# @param id [Integer] The ID of the company to check if its integration is certified.
|
37
37
|
# @return [String]
|
38
38
|
def certify_integration(id) path = "/api/v2/companies/#{id}/certify"
|
39
|
-
get(path, {}, "22.
|
39
|
+
get(path, {}, "22.8.0") end
|
40
40
|
|
41
41
|
# Change the filing status of this company
|
42
42
|
#
|
@@ -56,13 +56,13 @@ module AvaTax
|
|
56
56
|
#
|
57
57
|
# ### Security Policies
|
58
58
|
#
|
59
|
-
# * 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.
|
59
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
60
60
|
# Swagger Name: AvaTaxClient
|
61
61
|
# @param id [Integer]
|
62
62
|
# @param model [Object]
|
63
63
|
# @return [String]
|
64
64
|
def change_filing_status(id, model) path = "/api/v2/companies/#{id}/filingstatus"
|
65
|
-
post(path, model, {}, "22.
|
65
|
+
post(path, model, {}, "22.8.0") end
|
66
66
|
|
67
67
|
# Quick setup for a company with a single physical address
|
68
68
|
#
|
@@ -81,12 +81,12 @@ module AvaTax
|
|
81
81
|
#
|
82
82
|
# ### Security Policies
|
83
83
|
#
|
84
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
84
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
85
85
|
# Swagger Name: AvaTaxClient
|
86
86
|
# @param model [Object] Information about the company you wish to create.
|
87
87
|
# @return [Object]
|
88
88
|
def company_initialize(model) path = "/api/v2/companies/initialize"
|
89
|
-
post(path, model, {}, "22.
|
89
|
+
post(path, model, {}, "22.8.0") end
|
90
90
|
|
91
91
|
# Create new companies
|
92
92
|
#
|
@@ -98,12 +98,12 @@ module AvaTax
|
|
98
98
|
#
|
99
99
|
# ### Security Policies
|
100
100
|
#
|
101
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
101
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
102
102
|
# Swagger Name: AvaTaxClient
|
103
103
|
# @param model [CompanyModel[]] Either a single company object or an array of companies to create
|
104
104
|
# @return [CompanyModel[]]
|
105
105
|
def create_companies(model) path = "/api/v2/companies"
|
106
|
-
post(path, model, {}, "22.
|
106
|
+
post(path, model, {}, "22.8.0") end
|
107
107
|
|
108
108
|
# Add parameters to a company.
|
109
109
|
#
|
@@ -121,13 +121,13 @@ module AvaTax
|
|
121
121
|
#
|
122
122
|
# ### Security Policies
|
123
123
|
#
|
124
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
124
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
125
125
|
# Swagger Name: AvaTaxClient
|
126
126
|
# @param companyId [Integer] The ID of the company that owns this company parameter.
|
127
127
|
# @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
|
128
128
|
# @return [CompanyParameterDetailModel[]]
|
129
129
|
def create_company_parameters(companyId, model) path = "/api/v2/companies/#{companyId}/parameters"
|
130
|
-
post(path, model, {}, "22.
|
130
|
+
post(path, model, {}, "22.8.0") end
|
131
131
|
|
132
132
|
# Request managed returns funding setup for a company
|
133
133
|
#
|
@@ -145,13 +145,15 @@ module AvaTax
|
|
145
145
|
# ### Security Policies
|
146
146
|
#
|
147
147
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
148
|
-
# * 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.
|
148
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
149
149
|
# Swagger Name: AvaTaxClient
|
150
150
|
# @param id [Integer] The unique identifier of the company
|
151
|
+
# @param businessUnit [String] The company's business unit (See POABusinessUnit::* for a list of allowable values)
|
152
|
+
# @param subscriptionType [String] The company's subscription type (See POASubscriptionType::* for a list of allowable values)
|
151
153
|
# @param model [Object] The funding initialization request
|
152
154
|
# @return [Object]
|
153
|
-
def create_funding_request(id, model) path = "/api/v2/companies/#{id}/funding/setup"
|
154
|
-
post(path, model,
|
155
|
+
def create_funding_request(id, model, options={}) path = "/api/v2/companies/#{id}/funding/setup"
|
156
|
+
post(path, model, options, "22.8.0") end
|
155
157
|
|
156
158
|
# Delete a single company
|
157
159
|
#
|
@@ -159,12 +161,12 @@ module AvaTax
|
|
159
161
|
#
|
160
162
|
# ### Security Policies
|
161
163
|
#
|
162
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
164
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
163
165
|
# Swagger Name: AvaTaxClient
|
164
166
|
# @param id [Integer] The ID of the company you wish to delete.
|
165
167
|
# @return [ErrorDetail[]]
|
166
168
|
def delete_company(id) path = "/api/v2/companies/#{id}"
|
167
|
-
delete(path, {}, "22.
|
169
|
+
delete(path, {}, "22.8.0") end
|
168
170
|
|
169
171
|
# Delete a single company parameter
|
170
172
|
#
|
@@ -177,13 +179,13 @@ module AvaTax
|
|
177
179
|
#
|
178
180
|
# ### Security Policies
|
179
181
|
#
|
180
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
182
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
181
183
|
# Swagger Name: AvaTaxClient
|
182
184
|
# @param companyId [Integer] The company id
|
183
185
|
# @param id [Integer] The parameter id
|
184
186
|
# @return [ErrorDetail[]]
|
185
187
|
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
186
|
-
delete(path, {}, "22.
|
188
|
+
delete(path, {}, "22.8.0") end
|
187
189
|
|
188
190
|
# Check the funding configuration of a company
|
189
191
|
#
|
@@ -194,13 +196,13 @@ module AvaTax
|
|
194
196
|
#
|
195
197
|
# ### Security Policies
|
196
198
|
#
|
197
|
-
# * 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.
|
199
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
198
200
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
199
201
|
# Swagger Name: AvaTaxClient
|
200
202
|
# @param companyId [Integer] The unique identifier of the company
|
201
203
|
# @return [Object]
|
202
204
|
def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
|
203
|
-
get(path, {}, "22.
|
205
|
+
get(path, {}, "22.8.0") end
|
204
206
|
|
205
207
|
# Check the funding configuration of a company
|
206
208
|
#
|
@@ -211,14 +213,14 @@ module AvaTax
|
|
211
213
|
#
|
212
214
|
# ### Security Policies
|
213
215
|
#
|
214
|
-
# * 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.
|
216
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
215
217
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
216
218
|
# Swagger Name: AvaTaxClient
|
217
219
|
# @param companyId [Integer] The unique identifier of the company
|
218
220
|
# @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
|
219
221
|
# @return [FundingConfigurationModel[]]
|
220
222
|
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
221
|
-
get(path, options, "22.
|
223
|
+
get(path, options, "22.8.0") end
|
222
224
|
|
223
225
|
# Retrieve a single company
|
224
226
|
#
|
@@ -238,13 +240,13 @@ module AvaTax
|
|
238
240
|
#
|
239
241
|
# ### Security Policies
|
240
242
|
#
|
241
|
-
# * 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.
|
243
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
242
244
|
# Swagger Name: AvaTaxClient
|
243
245
|
# @param id [Integer] The ID of the company to retrieve.
|
244
246
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
|
245
247
|
# @return [Object]
|
246
248
|
def get_company(id, options={}) path = "/api/v2/companies/#{id}"
|
247
|
-
get(path, options, "22.
|
249
|
+
get(path, options, "22.8.0") end
|
248
250
|
|
249
251
|
# Get configuration settings for this company
|
250
252
|
#
|
@@ -263,12 +265,12 @@ module AvaTax
|
|
263
265
|
#
|
264
266
|
# ### Security Policies
|
265
267
|
#
|
266
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
268
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
267
269
|
# Swagger Name: AvaTaxClient
|
268
270
|
# @param id [Integer]
|
269
271
|
# @return [CompanyConfigurationModel[]]
|
270
272
|
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
271
|
-
get(path, {}, "22.
|
273
|
+
get(path, {}, "22.8.0") end
|
272
274
|
|
273
275
|
# Retrieve a single company parameter
|
274
276
|
#
|
@@ -282,13 +284,13 @@ module AvaTax
|
|
282
284
|
#
|
283
285
|
# ### Security Policies
|
284
286
|
#
|
285
|
-
# * 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.
|
287
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
286
288
|
# Swagger Name: AvaTaxClient
|
287
289
|
# @param companyId [Integer]
|
288
290
|
# @param id [Integer]
|
289
291
|
# @return [Object]
|
290
292
|
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
291
|
-
get(path, {}, "22.
|
293
|
+
get(path, {}, "22.8.0") end
|
292
294
|
|
293
295
|
# Get this company's filing status
|
294
296
|
#
|
@@ -309,12 +311,12 @@ module AvaTax
|
|
309
311
|
#
|
310
312
|
# ### Security Policies
|
311
313
|
#
|
312
|
-
# * 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.
|
314
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
313
315
|
# Swagger Name: AvaTaxClient
|
314
316
|
# @param id [Integer]
|
315
317
|
# @return [String]
|
316
318
|
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
317
|
-
get(path, {}, "22.
|
319
|
+
get(path, {}, "22.8.0") end
|
318
320
|
|
319
321
|
# Get ACH entry detail report for company and period
|
320
322
|
#
|
@@ -326,14 +328,14 @@ module AvaTax
|
|
326
328
|
# ### Security Policies
|
327
329
|
#
|
328
330
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
329
|
-
# * 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.
|
331
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
330
332
|
# Swagger Name: AvaTaxClient
|
331
333
|
# @param id [Integer] The unique identifier of the company
|
332
334
|
# @param periodyear [Integer] The period year
|
333
335
|
# @param periodmonth [Integer] The period month
|
334
336
|
# @return [ACHEntryDetailModel[]]
|
335
337
|
def list_a_c_h_entry_details_for_company(id, periodyear, periodmonth) path = "/api/v2/companies/#{id}/paymentdetails/#{periodyear}/#{periodmonth}"
|
336
|
-
get(path, {}, "22.
|
338
|
+
get(path, {}, "22.8.0") end
|
337
339
|
|
338
340
|
# Retrieve parameters for a company
|
339
341
|
#
|
@@ -350,7 +352,7 @@ module AvaTax
|
|
350
352
|
#
|
351
353
|
# ### Security Policies
|
352
354
|
#
|
353
|
-
# * 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.
|
355
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
354
356
|
# Swagger Name: AvaTaxClient
|
355
357
|
# @param companyId [Integer] The company id
|
356
358
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* name, unit
|
@@ -359,7 +361,7 @@ module AvaTax
|
|
359
361
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
360
362
|
# @return [FetchResult]
|
361
363
|
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
362
|
-
get(path, options, "22.
|
364
|
+
get(path, options, "22.8.0") end
|
363
365
|
|
364
366
|
# Check managed returns funding status for a company
|
365
367
|
#
|
@@ -371,12 +373,12 @@ module AvaTax
|
|
371
373
|
# ### Security Policies
|
372
374
|
#
|
373
375
|
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
374
|
-
# * 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.
|
376
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
375
377
|
# Swagger Name: AvaTaxClient
|
376
378
|
# @param id [Integer] The unique identifier of the company
|
377
379
|
# @return [FundingStatusModel[]]
|
378
380
|
def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
|
379
|
-
get(path, {}, "22.
|
381
|
+
get(path, {}, "22.8.0") end
|
380
382
|
|
381
383
|
# Retrieve a list of MRS Companies with account
|
382
384
|
#
|
@@ -386,11 +388,11 @@ module AvaTax
|
|
386
388
|
#
|
387
389
|
# ### Security Policies
|
388
390
|
#
|
389
|
-
# * 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.
|
391
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
390
392
|
# Swagger Name: AvaTaxClient
|
391
393
|
# @return [FetchResult]
|
392
394
|
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
393
|
-
get(path, {}, "22.
|
395
|
+
get(path, {}, "22.8.0") end
|
394
396
|
|
395
397
|
# Retrieve all companies
|
396
398
|
#
|
@@ -414,7 +416,7 @@ module AvaTax
|
|
414
416
|
#
|
415
417
|
# ### Security Policies
|
416
418
|
#
|
417
|
-
# * 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.
|
419
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
418
420
|
# Swagger Name: AvaTaxClient
|
419
421
|
# @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
|
420
422
|
# @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
|
@@ -423,7 +425,7 @@ module AvaTax
|
|
423
425
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
424
426
|
# @return [FetchResult]
|
425
427
|
def query_companies(options={}) path = "/api/v2/companies"
|
426
|
-
get(path, options, "22.
|
428
|
+
get(path, options, "22.8.0") end
|
427
429
|
|
428
430
|
# Change configuration settings for this company
|
429
431
|
#
|
@@ -442,13 +444,13 @@ module AvaTax
|
|
442
444
|
#
|
443
445
|
# ### Security Policies
|
444
446
|
#
|
445
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
447
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
446
448
|
# Swagger Name: AvaTaxClient
|
447
449
|
# @param id [Integer]
|
448
450
|
# @param model [CompanyConfigurationModel[]]
|
449
451
|
# @return [CompanyConfigurationModel[]]
|
450
452
|
def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
|
451
|
-
post(path, model, {}, "22.
|
453
|
+
post(path, model, {}, "22.8.0") end
|
452
454
|
|
453
455
|
# Update a single company
|
454
456
|
#
|
@@ -466,13 +468,13 @@ module AvaTax
|
|
466
468
|
#
|
467
469
|
# ### Security Policies
|
468
470
|
#
|
469
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
471
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
470
472
|
# Swagger Name: AvaTaxClient
|
471
473
|
# @param id [Integer] The ID of the company you wish to update.
|
472
474
|
# @param model [Object] The company object you wish to update.
|
473
475
|
# @return [Object]
|
474
476
|
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
475
|
-
put(path, model, {}, "22.
|
477
|
+
put(path, model, {}, "22.8.0") end
|
476
478
|
|
477
479
|
# Update a company parameter
|
478
480
|
#
|
@@ -486,14 +488,14 @@ module AvaTax
|
|
486
488
|
#
|
487
489
|
# ### Security Policies
|
488
490
|
#
|
489
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
491
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
490
492
|
# Swagger Name: AvaTaxClient
|
491
493
|
# @param companyId [Integer] The company id.
|
492
494
|
# @param id [Integer] The company parameter id
|
493
495
|
# @param model [Object] The company parameter object you wish to update.
|
494
496
|
# @return [Object]
|
495
497
|
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
496
|
-
put(path, model, {}, "22.
|
498
|
+
put(path, model, {}, "22.8.0") end
|
497
499
|
end
|
498
500
|
end
|
499
501
|
end
|
@@ -21,7 +21,7 @@ module AvaTax
|
|
21
21
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
22
22
|
# @return [Object]
|
23
23
|
def query_tax_authority_jurisdiction_rates(options={}) path = "/api/v2/compliance/taxauthorityjurisdictionrates"
|
24
|
-
get(path, options, "22.
|
24
|
+
get(path, options, "22.8.0") end
|
25
25
|
end
|
26
26
|
end
|
27
27
|
end
|
@@ -11,13 +11,13 @@ module AvaTax
|
|
11
11
|
#
|
12
12
|
# ### Security Policies
|
13
13
|
#
|
14
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
14
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
15
15
|
# Swagger Name: AvaTaxClient
|
16
16
|
# @param companyId [Integer] The ID of the company that owns this contact.
|
17
17
|
# @param model [ContactModel[]] The contacts you wish to create.
|
18
18
|
# @return [ContactModel[]]
|
19
19
|
def create_contacts(companyId, model) path = "/api/v2/companies/#{companyId}/contacts"
|
20
|
-
post(path, model, {}, "22.
|
20
|
+
post(path, model, {}, "22.8.0") end
|
21
21
|
|
22
22
|
# Delete a single contact
|
23
23
|
#
|
@@ -25,13 +25,13 @@ module AvaTax
|
|
25
25
|
#
|
26
26
|
# ### Security Policies
|
27
27
|
#
|
28
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
28
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
29
29
|
# Swagger Name: AvaTaxClient
|
30
30
|
# @param companyId [Integer] The ID of the company that owns this contact.
|
31
31
|
# @param id [Integer] The ID of the contact you wish to delete.
|
32
32
|
# @return [ErrorDetail[]]
|
33
33
|
def delete_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
34
|
-
delete(path, {}, "22.
|
34
|
+
delete(path, {}, "22.8.0") end
|
35
35
|
|
36
36
|
# Retrieve a single contact
|
37
37
|
#
|
@@ -41,13 +41,13 @@ module AvaTax
|
|
41
41
|
#
|
42
42
|
# ### Security Policies
|
43
43
|
#
|
44
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
44
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
45
45
|
# Swagger Name: AvaTaxClient
|
46
46
|
# @param companyId [Integer] The ID of the company for this contact
|
47
47
|
# @param id [Integer] The primary key of this contact
|
48
48
|
# @return [Object]
|
49
49
|
def get_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
50
|
-
get(path, {}, "22.
|
50
|
+
get(path, {}, "22.8.0") end
|
51
51
|
|
52
52
|
# Retrieve contacts for this company
|
53
53
|
#
|
@@ -58,7 +58,7 @@ module AvaTax
|
|
58
58
|
#
|
59
59
|
# ### Security Policies
|
60
60
|
#
|
61
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
61
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
62
62
|
# Swagger Name: AvaTaxClient
|
63
63
|
# @param companyId [Integer] The ID of the company that owns these contacts
|
64
64
|
# @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/).
|
@@ -67,7 +67,7 @@ module AvaTax
|
|
67
67
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
68
68
|
# @return [FetchResult]
|
69
69
|
def list_contacts_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/contacts"
|
70
|
-
get(path, options, "22.
|
70
|
+
get(path, options, "22.8.0") end
|
71
71
|
|
72
72
|
# Retrieve all contacts
|
73
73
|
#
|
@@ -80,7 +80,7 @@ module AvaTax
|
|
80
80
|
#
|
81
81
|
# ### Security Policies
|
82
82
|
#
|
83
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
83
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
84
84
|
# Swagger Name: AvaTaxClient
|
85
85
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
|
86
86
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
@@ -88,7 +88,7 @@ module AvaTax
|
|
88
88
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
89
89
|
# @return [FetchResult]
|
90
90
|
def query_contacts(options={}) path = "/api/v2/contacts"
|
91
|
-
get(path, options, "22.
|
91
|
+
get(path, options, "22.8.0") end
|
92
92
|
|
93
93
|
# Update a single contact
|
94
94
|
#
|
@@ -100,14 +100,14 @@ module AvaTax
|
|
100
100
|
#
|
101
101
|
# ### Security Policies
|
102
102
|
#
|
103
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
103
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
104
104
|
# Swagger Name: AvaTaxClient
|
105
105
|
# @param companyId [Integer] The ID of the company that this contact belongs to.
|
106
106
|
# @param id [Integer] The ID of the contact you wish to update
|
107
107
|
# @param model [Object] The contact you wish to update.
|
108
108
|
# @return [Object]
|
109
109
|
def update_contact(companyId, id, model) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
110
|
-
put(path, model, {}, "22.
|
110
|
+
put(path, model, {}, "22.8.0") end
|
111
111
|
end
|
112
112
|
end
|
113
113
|
end
|