avatax 23.1.0 → 23.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/avatax.gemspec +1 -1
  3. data/lib/avatax/client/accounts.rb +17 -17
  4. data/lib/avatax/client/addresses.rb +2 -2
  5. data/lib/avatax/client/advancedrules.rb +5 -5
  6. data/lib/avatax/client/ageverification.rb +4 -4
  7. data/lib/avatax/client/avafileforms.rb +5 -5
  8. data/lib/avatax/client/batches.rb +8 -8
  9. data/lib/avatax/client/certexpressinvites.rb +3 -3
  10. data/lib/avatax/client/certificates.rb +15 -15
  11. data/lib/avatax/client/companies.rb +36 -36
  12. data/lib/avatax/client/compliance.rb +1 -1
  13. data/lib/avatax/client/contacts.rb +6 -6
  14. data/lib/avatax/client/customers.rb +13 -13
  15. data/lib/avatax/client/datasources.rb +9 -9
  16. data/lib/avatax/client/definitions.rb +82 -82
  17. data/lib/avatax/client/distancethresholds.rb +6 -6
  18. data/lib/avatax/client/ecommercetoken.rb +4 -4
  19. data/lib/avatax/client/firmclientlinkages.rb +11 -11
  20. data/lib/avatax/client/free.rb +1 -1
  21. data/lib/avatax/client/fundingrequests.rb +3 -3
  22. data/lib/avatax/client/items.rb +46 -46
  23. data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
  24. data/lib/avatax/client/locations.rb +18 -18
  25. data/lib/avatax/client/multidocument.rb +10 -10
  26. data/lib/avatax/client/nexus.rb +15 -15
  27. data/lib/avatax/client/notices.rb +4 -4
  28. data/lib/avatax/client/notifications.rb +6 -6
  29. data/lib/avatax/client/provisioning.rb +2 -2
  30. data/lib/avatax/client/registrar.rb +14 -14
  31. data/lib/avatax/client/reports.rb +4 -4
  32. data/lib/avatax/client/settings.rb +9 -9
  33. data/lib/avatax/client/shippingverification.rb +4 -4
  34. data/lib/avatax/client/subscriptions.rb +3 -3
  35. data/lib/avatax/client/taxcodes.rb +6 -6
  36. data/lib/avatax/client/taxcontent.rb +8 -8
  37. data/lib/avatax/client/taxrules.rb +6 -6
  38. data/lib/avatax/client/transactions.rb +24 -24
  39. data/lib/avatax/client/upcs.rb +6 -6
  40. data/lib/avatax/client/userdefinedfields.rb +4 -4
  41. data/lib/avatax/client/users.rb +12 -12
  42. data/lib/avatax/client/utilities.rb +3 -3
  43. data/lib/avatax/version.rb +1 -1
  44. data/spec/spec_helper.rb +1 -0
  45. metadata +4 -4
@@ -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, BatchServiceAdmin, 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, ECMUser, 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, {}, "23.1.0") end
39
+ get(path, {}, AvaTax::VERSION) 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, BatchServiceAdmin, 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, ECMUser, 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, {}, "23.1.0") end
65
+ post(path, model, {}, AvaTax::VERSION) end
66
66
 
67
67
  # Quick setup for a company with a single physical address
68
68
  #
@@ -86,7 +86,7 @@ module AvaTax
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, {}, "23.1.0") end
89
+ post(path, model, {}, AvaTax::VERSION) end
90
90
 
91
91
  # Create new companies
92
92
  #
@@ -103,7 +103,7 @@ module AvaTax
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, {}, "23.1.0") end
106
+ post(path, model, {}, AvaTax::VERSION) end
107
107
 
108
108
  # Add parameters to a company.
109
109
  #
@@ -127,7 +127,7 @@ module AvaTax
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, {}, "23.1.0") end
130
+ post(path, model, {}, AvaTax::VERSION) end
131
131
 
132
132
  # Request managed returns funding setup for a company
133
133
  #
@@ -145,7 +145,7 @@ 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, BatchServiceAdmin, 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, ECMUser, 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
151
  # @param businessUnit [String] The company's business unit (See POABusinessUnit::* for a list of allowable values)
@@ -153,7 +153,7 @@ module AvaTax
153
153
  # @param model [Object] The funding initialization request
154
154
  # @return [Object]
155
155
  def create_funding_request(id, model, options={}) path = "/api/v2/companies/#{id}/funding/setup"
156
- post(path, model, options, "23.1.0") end
156
+ post(path, model, options, AvaTax::VERSION) end
157
157
 
158
158
  # Delete a single company
159
159
  #
@@ -166,7 +166,7 @@ module AvaTax
166
166
  # @param id [Integer] The ID of the company you wish to delete.
167
167
  # @return [ErrorDetail[]]
168
168
  def delete_company(id) path = "/api/v2/companies/#{id}"
169
- delete(path, {}, "23.1.0") end
169
+ delete(path, {}, AvaTax::VERSION) end
170
170
 
171
171
  # Delete a single company parameter
172
172
  #
@@ -185,7 +185,7 @@ module AvaTax
185
185
  # @param id [Integer] The parameter id
186
186
  # @return [ErrorDetail[]]
187
187
  def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
188
- delete(path, {}, "23.1.0") end
188
+ delete(path, {}, AvaTax::VERSION) end
189
189
 
190
190
  # Check the funding configuration of a company
191
191
  #
@@ -196,13 +196,13 @@ module AvaTax
196
196
  #
197
197
  # ### Security Policies
198
198
  #
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.
199
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
200
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.
201
201
  # Swagger Name: AvaTaxClient
202
202
  # @param companyId [Integer] The unique identifier of the company
203
203
  # @return [Object]
204
204
  def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
205
- get(path, {}, "23.1.0") end
205
+ get(path, {}, AvaTax::VERSION) end
206
206
 
207
207
  # Check the funding configuration of a company
208
208
  #
@@ -213,14 +213,14 @@ module AvaTax
213
213
  #
214
214
  # ### Security Policies
215
215
  #
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.
216
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
217
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.
218
218
  # Swagger Name: AvaTaxClient
219
219
  # @param companyId [Integer] The unique identifier of the company
220
220
  # @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
221
221
  # @return [FundingConfigurationModel[]]
222
222
  def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
223
- get(path, options, "23.1.0") end
223
+ get(path, options, AvaTax::VERSION) end
224
224
 
225
225
  # Retrieve a single company
226
226
  #
@@ -240,13 +240,13 @@ module AvaTax
240
240
  #
241
241
  # ### Security Policies
242
242
  #
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.
243
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
244
244
  # Swagger Name: AvaTaxClient
245
245
  # @param id [Integer] The ID of the company to retrieve.
246
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.
247
247
  # @return [Object]
248
248
  def get_company(id, options={}) path = "/api/v2/companies/#{id}"
249
- get(path, options, "23.1.0") end
249
+ get(path, options, AvaTax::VERSION) end
250
250
 
251
251
  # Get configuration settings for this company
252
252
  #
@@ -265,12 +265,12 @@ module AvaTax
265
265
  #
266
266
  # ### Security Policies
267
267
  #
268
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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, ECMUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
269
269
  # Swagger Name: AvaTaxClient
270
270
  # @param id [Integer]
271
271
  # @return [CompanyConfigurationModel[]]
272
272
  def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
273
- get(path, {}, "23.1.0") end
273
+ get(path, {}, AvaTax::VERSION) end
274
274
 
275
275
  # Retrieve a single company parameter
276
276
  #
@@ -284,13 +284,13 @@ module AvaTax
284
284
  #
285
285
  # ### Security Policies
286
286
  #
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.
287
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
288
288
  # Swagger Name: AvaTaxClient
289
289
  # @param companyId [Integer]
290
290
  # @param id [Integer]
291
291
  # @return [Object]
292
292
  def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
293
- get(path, {}, "23.1.0") end
293
+ get(path, {}, AvaTax::VERSION) end
294
294
 
295
295
  # Get this company's filing status
296
296
  #
@@ -311,12 +311,12 @@ module AvaTax
311
311
  #
312
312
  # ### Security Policies
313
313
  #
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.
314
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
315
315
  # Swagger Name: AvaTaxClient
316
316
  # @param id [Integer]
317
317
  # @return [String]
318
318
  def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
319
- get(path, {}, "23.1.0") end
319
+ get(path, {}, AvaTax::VERSION) end
320
320
 
321
321
  # Get ACH entry detail report for company and period
322
322
  #
@@ -328,14 +328,14 @@ module AvaTax
328
328
  # ### Security Policies
329
329
  #
330
330
  # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
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.
331
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
332
332
  # Swagger Name: AvaTaxClient
333
333
  # @param id [Integer] The unique identifier of the company
334
334
  # @param periodyear [Integer] The period year
335
335
  # @param periodmonth [Integer] The period month
336
336
  # @return [ACHEntryDetailModel[]]
337
337
  def list_a_c_h_entry_details_for_company(id, periodyear, periodmonth) path = "/api/v2/companies/#{id}/paymentdetails/#{periodyear}/#{periodmonth}"
338
- get(path, {}, "23.1.0") end
338
+ get(path, {}, AvaTax::VERSION) end
339
339
 
340
340
  # Retrieve parameters for a company
341
341
  #
@@ -352,7 +352,7 @@ module AvaTax
352
352
  #
353
353
  # ### Security Policies
354
354
  #
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.
355
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
356
356
  # Swagger Name: AvaTaxClient
357
357
  # @param companyId [Integer] The company id
358
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
@@ -361,7 +361,7 @@ module AvaTax
361
361
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
362
362
  # @return [FetchResult]
363
363
  def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
364
- get(path, options, "23.1.0") end
364
+ get(path, options, AvaTax::VERSION) end
365
365
 
366
366
  # Check managed returns funding status for a company
367
367
  #
@@ -373,12 +373,12 @@ module AvaTax
373
373
  # ### Security Policies
374
374
  #
375
375
  # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
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.
376
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
377
377
  # Swagger Name: AvaTaxClient
378
378
  # @param id [Integer] The unique identifier of the company
379
379
  # @return [FundingStatusModel[]]
380
380
  def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
381
- get(path, {}, "23.1.0") end
381
+ get(path, {}, AvaTax::VERSION) end
382
382
 
383
383
  # Retrieve a list of MRS Companies with account
384
384
  #
@@ -388,11 +388,11 @@ module AvaTax
388
388
  #
389
389
  # ### Security Policies
390
390
  #
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.
391
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
392
392
  # Swagger Name: AvaTaxClient
393
393
  # @return [FetchResult]
394
394
  def list_mrs_companies() path = "/api/v2/companies/mrs"
395
- get(path, {}, "23.1.0") end
395
+ get(path, {}, AvaTax::VERSION) end
396
396
 
397
397
  # Retrieve all companies
398
398
  #
@@ -416,7 +416,7 @@ module AvaTax
416
416
  #
417
417
  # ### Security Policies
418
418
  #
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.
419
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
420
420
  # Swagger Name: AvaTaxClient
421
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.
422
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
@@ -425,7 +425,7 @@ module AvaTax
425
425
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
426
426
  # @return [FetchResult]
427
427
  def query_companies(options={}) path = "/api/v2/companies"
428
- get(path, options, "23.1.0") end
428
+ get(path, options, AvaTax::VERSION) end
429
429
 
430
430
  # Change configuration settings for this company
431
431
  #
@@ -450,7 +450,7 @@ module AvaTax
450
450
  # @param model [CompanyConfigurationModel[]]
451
451
  # @return [CompanyConfigurationModel[]]
452
452
  def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
453
- post(path, model, {}, "23.1.0") end
453
+ post(path, model, {}, AvaTax::VERSION) end
454
454
 
455
455
  # Update a single company
456
456
  #
@@ -474,7 +474,7 @@ module AvaTax
474
474
  # @param model [Object] The company object you wish to update.
475
475
  # @return [Object]
476
476
  def update_company(id, model) path = "/api/v2/companies/#{id}"
477
- put(path, model, {}, "23.1.0") end
477
+ put(path, model, {}, AvaTax::VERSION) end
478
478
 
479
479
  # Update a company parameter
480
480
  #
@@ -495,7 +495,7 @@ module AvaTax
495
495
  # @param model [Object] The company parameter object you wish to update.
496
496
  # @return [Object]
497
497
  def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
498
- put(path, model, {}, "23.1.0") end
498
+ put(path, model, {}, AvaTax::VERSION) end
499
499
  end
500
500
  end
501
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, "23.1.0") end
24
+ get(path, options, AvaTax::VERSION) end
25
25
  end
26
26
  end
27
27
  end
@@ -17,7 +17,7 @@ module AvaTax
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, {}, "23.1.0") end
20
+ post(path, model, {}, AvaTax::VERSION) end
21
21
 
22
22
  # Delete a single contact
23
23
  #
@@ -31,7 +31,7 @@ module AvaTax
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, {}, "23.1.0") end
34
+ delete(path, {}, AvaTax::VERSION) end
35
35
 
36
36
  # Retrieve a single contact
37
37
  #
@@ -47,7 +47,7 @@ module AvaTax
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, {}, "23.1.0") end
50
+ get(path, {}, AvaTax::VERSION) end
51
51
 
52
52
  # Retrieve contacts for this company
53
53
  #
@@ -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, "23.1.0") end
70
+ get(path, options, AvaTax::VERSION) end
71
71
 
72
72
  # Retrieve all contacts
73
73
  #
@@ -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, "23.1.0") end
91
+ get(path, options, AvaTax::VERSION) end
92
92
 
93
93
  # Update a single contact
94
94
  #
@@ -107,7 +107,7 @@ module AvaTax
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, {}, "23.1.0") end
110
+ put(path, model, {}, AvaTax::VERSION) end
111
111
  end
112
112
  end
113
113
  end
@@ -30,7 +30,7 @@ module AvaTax
30
30
  # @param model [CustomerModel[]] The list of customer objects to be created
31
31
  # @return [CustomerModel[]]
32
32
  def create_customers(companyId, model) path = "/api/v2/companies/#{companyId}/customers"
33
- post(path, model, {}, "23.1.0") end
33
+ post(path, model, {}, AvaTax::VERSION) end
34
34
 
35
35
  # Delete a customer record
36
36
  #
@@ -56,7 +56,7 @@ module AvaTax
56
56
  # @param customerCode [String] The unique code representing this customer
57
57
  # @return [Object]
58
58
  def delete_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
59
- delete(path, {}, "23.1.0") end
59
+ delete(path, {}, AvaTax::VERSION) end
60
60
 
61
61
  # Retrieve a single customer
62
62
  #
@@ -89,7 +89,7 @@ module AvaTax
89
89
  # @param include [String] Specify optional additional objects to include in this fetch request
90
90
  # @return [Object]
91
91
  def get_customer(companyId, customerCode, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
92
- get(path, options, "23.1.0") end
92
+ get(path, options, AvaTax::VERSION) end
93
93
 
94
94
  # Link attributes to a customer
95
95
  #
@@ -119,7 +119,7 @@ module AvaTax
119
119
  # @param model [CustomerAttributeModel[]] The list of attributes to link to the customer.
120
120
  # @return [FetchResult]
121
121
  def link_attributes_to_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/link"
122
- put(path, model, {}, "23.1.0") end
122
+ put(path, model, {}, AvaTax::VERSION) end
123
123
 
124
124
  # Link certificates to a customer
125
125
  #
@@ -146,7 +146,7 @@ module AvaTax
146
146
  # @param model [Object] The list of certificates to link to this customer
147
147
  # @return [FetchResult]
148
148
  def link_certificates_to_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/link"
149
- post(path, model, {}, "23.1.0") end
149
+ post(path, model, {}, AvaTax::VERSION) end
150
150
 
151
151
  # Link two customer records together
152
152
  #
@@ -174,7 +174,7 @@ module AvaTax
174
174
  # @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
175
175
  # @return [Object]
176
176
  def link_ship_to_customers_to_bill_customer(companyId, code, model) path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
177
- post(path, model, {}, "23.1.0") end
177
+ post(path, model, {}, AvaTax::VERSION) end
178
178
 
179
179
  # Retrieve a customer's attributes
180
180
  #
@@ -203,7 +203,7 @@ module AvaTax
203
203
  # @param customerCode [String] The unique code representing the current customer
204
204
  # @return [FetchResult]
205
205
  def list_attributes_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes"
206
- get(path, {}, "23.1.0") end
206
+ get(path, {}, AvaTax::VERSION) end
207
207
 
208
208
  # List certificates linked to a customer
209
209
  #
@@ -234,7 +234,7 @@ module AvaTax
234
234
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
235
235
  # @return [FetchResult]
236
236
  def list_certificates_for_customer(companyId, customerCode, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
237
- get(path, options, "23.1.0") end
237
+ get(path, options, AvaTax::VERSION) end
238
238
 
239
239
  # List valid certificates for a location
240
240
  #
@@ -265,7 +265,7 @@ module AvaTax
265
265
  # @param region [String] Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.
266
266
  # @return [Object]
267
267
  def list_valid_certificates_for_customer(companyId, customerCode, country, region) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/#{country}/#{region}"
268
- get(path, {}, "23.1.0") end
268
+ get(path, {}, AvaTax::VERSION) end
269
269
 
270
270
  # List all customers for this company
271
271
  #
@@ -300,7 +300,7 @@ module AvaTax
300
300
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
301
301
  # @return [FetchResult]
302
302
  def query_customers(companyId, options={}) path = "/api/v2/companies/#{companyId}/customers"
303
- get(path, options, "23.1.0") end
303
+ get(path, options, AvaTax::VERSION) end
304
304
 
305
305
  # Unlink attributes from a customer
306
306
  #
@@ -330,7 +330,7 @@ module AvaTax
330
330
  # @param model [CustomerAttributeModel[]] The list of attributes to unlink from the customer.
331
331
  # @return [FetchResult]
332
332
  def unlink_attributes_from_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/unlink"
333
- put(path, model, {}, "23.1.0") end
333
+ put(path, model, {}, AvaTax::VERSION) end
334
334
 
335
335
  # Unlink certificates from a customer
336
336
  #
@@ -357,7 +357,7 @@ module AvaTax
357
357
  # @param model [Object] The list of certificates to link to this customer
358
358
  # @return [FetchResult]
359
359
  def unlink_certificates_from_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/unlink"
360
- post(path, model, {}, "23.1.0") end
360
+ post(path, model, {}, AvaTax::VERSION) end
361
361
 
362
362
  # Update a single customer
363
363
  #
@@ -384,7 +384,7 @@ module AvaTax
384
384
  # @param model [Object] The new customer model that will replace the existing record at this URL
385
385
  # @return [Object]
386
386
  def update_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
387
- put(path, model, {}, "23.1.0") end
387
+ put(path, model, {}, AvaTax::VERSION) end
388
388
  end
389
389
  end
390
390
  end
@@ -16,7 +16,7 @@ module AvaTax
16
16
  # @param model [DataSourceModel[]]
17
17
  # @return [DataSourceModel[]]
18
18
  def create_data_sources(companyId, model) path = "/api/v2/companies/#{companyId}/datasources"
19
- post(path, model, {}, "23.1.0") end
19
+ post(path, model, {}, AvaTax::VERSION) end
20
20
 
21
21
  # Delete a datasource by datasource id for a company.
22
22
  #
@@ -31,7 +31,7 @@ module AvaTax
31
31
  # @param id [Integer] The id of the datasource you wish to delete.
32
32
  # @return [ErrorDetail[]]
33
33
  def delete_data_source(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
34
- delete(path, {}, "23.1.0") end
34
+ delete(path, {}, AvaTax::VERSION) end
35
35
 
36
36
  # Get data source by data source id
37
37
  #
@@ -39,14 +39,14 @@ module AvaTax
39
39
  #
40
40
  # ### Security Policies
41
41
  #
42
- # * 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.
42
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
43
43
  # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
44
44
  # Swagger Name: AvaTaxClient
45
45
  # @param companyId [Integer]
46
46
  # @param id [Integer] data source id
47
47
  # @return [Object]
48
48
  def get_data_source_by_id(companyId, id) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
49
- get(path, {}, "23.1.0") end
49
+ get(path, {}, AvaTax::VERSION) end
50
50
 
51
51
  # Retrieve all datasources for this company
52
52
  #
@@ -54,7 +54,7 @@ module AvaTax
54
54
  #
55
55
  # ### Security Policies
56
56
  #
57
- # * 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.
57
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
58
58
  # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
59
59
  # Swagger Name: AvaTaxClient
60
60
  # @param companyId [Integer] The id of the company you wish to retrieve the datasources.
@@ -64,7 +64,7 @@ module AvaTax
64
64
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
65
65
  # @return [FetchResult]
66
66
  def list_data_sources(companyId, options={}) path = "/api/v2/companies/#{companyId}/datasources"
67
- get(path, options, "23.1.0") end
67
+ get(path, options, AvaTax::VERSION) end
68
68
 
69
69
  # Retrieve all datasources
70
70
  #
@@ -75,7 +75,7 @@ module AvaTax
75
75
  #
76
76
  # ### Security Policies
77
77
  #
78
- # * 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.
78
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
79
79
  # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
80
80
  # Swagger Name: AvaTaxClient
81
81
  # @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
@@ -84,7 +84,7 @@ module AvaTax
84
84
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
85
85
  # @return [FetchResult]
86
86
  def query_data_sources(options={}) path = "/api/v2/datasources"
87
- get(path, options, "23.1.0") end
87
+ get(path, options, AvaTax::VERSION) end
88
88
 
89
89
  # Update a datasource identified by id for a company
90
90
  #
@@ -100,7 +100,7 @@ module AvaTax
100
100
  # @param model [Object]
101
101
  # @return [Object]
102
102
  def update_data_source(companyId, id, model) path = "/api/v2/companies/#{companyId}/datasources/#{id}"
103
- put(path, model, {}, "23.1.0") end
103
+ put(path, model, {}, AvaTax::VERSION) end
104
104
  end
105
105
  end
106
106
  end