avatax 21.8.0 → 21.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +83 -83
  3. data/lib/avatax/client/addresses.rb +20 -20
  4. data/lib/avatax/client/advancedrules.rb +41 -41
  5. data/lib/avatax/client/avafileforms.rb +41 -41
  6. data/lib/avatax/client/batches.rb +62 -62
  7. data/lib/avatax/client/certexpressinvites.rb +27 -27
  8. data/lib/avatax/client/certificates.rb +111 -111
  9. data/lib/avatax/client/companies.rb +153 -153
  10. data/lib/avatax/client/contacts.rb +48 -48
  11. data/lib/avatax/client/customers.rb +97 -97
  12. data/lib/avatax/client/datasources.rb +48 -48
  13. data/lib/avatax/client/definitions.rb +550 -446
  14. data/lib/avatax/client/distancethresholds.rb +48 -48
  15. data/lib/avatax/client/ecommercetoken.rb +16 -16
  16. data/lib/avatax/client/filingcalendars.rb +39 -20
  17. data/lib/avatax/client/filings.rb +20 -20
  18. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  19. data/lib/avatax/client/free.rb +13 -13
  20. data/lib/avatax/client/fundingrequests.rb +20 -20
  21. data/lib/avatax/client/items.rb +181 -181
  22. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  23. data/lib/avatax/client/locations.rb +90 -90
  24. data/lib/avatax/client/multidocument.rb +76 -76
  25. data/lib/avatax/client/nexus.rb +131 -103
  26. data/lib/avatax/client/notices.rb +22 -22
  27. data/lib/avatax/client/notifications.rb +27 -27
  28. data/lib/avatax/client/provisioning.rb +20 -20
  29. data/lib/avatax/client/registrar.rb +83 -83
  30. data/lib/avatax/client/reports.rb +34 -34
  31. data/lib/avatax/client/settings.rb +48 -48
  32. data/lib/avatax/client/subscriptions.rb +27 -27
  33. data/lib/avatax/client/taxcodes.rb +48 -48
  34. data/lib/avatax/client/taxcontent.rb +41 -41
  35. data/lib/avatax/client/taxrules.rb +50 -50
  36. data/lib/avatax/client/transactions.rb +153 -153
  37. data/lib/avatax/client/upcs.rb +48 -48
  38. data/lib/avatax/client/users.rb +62 -62
  39. data/lib/avatax/client/utilities.rb +27 -27
  40. data/lib/avatax/version.rb +1 -1
  41. metadata +2 -2
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Transactions
4
-
5
-
6
- # Add lines to an existing unlocked transaction
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Transactions
4
+
5
+
6
+ # Add lines to an existing unlocked transaction
7
+ #
8
8
  # Add lines to an existing unlocked transaction.
9
9
  #
10
10
  # The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will
@@ -29,15 +29,15 @@ module AvaTax
29
29
  # ### Security Policies
30
30
  #
31
31
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
32
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
32
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
33
33
  # @param include [String] Specifies objects to include in the response after transaction is created
34
34
  # @param model [Object] information about the transaction and lines to be added
35
- # @return [Object]
36
- def add_lines(model, options={}) path = "/api/v2/companies/transactions/lines/add"
37
- post(path, model, options) end
38
-
39
- # Correct a previously created transaction
40
- #
35
+ # @return [Object]
36
+ def add_lines(model, options={}) path = "/api/v2/companies/transactions/lines/add"
37
+ post(path, model, options) end
38
+
39
+ # Correct a previously created transaction
40
+ #
41
41
  # Replaces the current transaction uniquely identified by this URL with a new transaction.
42
42
  #
43
43
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -71,18 +71,18 @@ module AvaTax
71
71
  # ### Security Policies
72
72
  #
73
73
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
74
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
74
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
75
75
  # @param companyCode [String] The company code of the company that recorded this transaction
76
76
  # @param transactionCode [String] The transaction code to adjust
77
77
  # @param documentType [String] (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)
78
78
  # @param include [String] Specifies objects to include in this fetch call
79
79
  # @param model [Object] The adjustment you wish to make
80
- # @return [Object]
81
- def adjust_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
82
- post(path, model, options) end
83
-
84
- # Get audit information about a transaction
85
- #
80
+ # @return [Object]
81
+ def adjust_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
82
+ post(path, model, options) end
83
+
84
+ # Get audit information about a transaction
85
+ #
86
86
  # Retrieve audit information about a transaction stored in AvaTax.
87
87
  #
88
88
  # The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit
@@ -110,15 +110,15 @@ module AvaTax
110
110
  # ### Security Policies
111
111
  #
112
112
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
113
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
113
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
114
114
  # @param companyCode [String] The code identifying the company that owns this transaction
115
115
  # @param transactionCode [String] The code identifying the transaction
116
- # @return [Object]
117
- def audit_transaction(companyCode, transactionCode) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
118
- get(path) end
119
-
120
- # Get audit information about a transaction
121
- #
116
+ # @return [Object]
117
+ def audit_transaction(companyCode, transactionCode) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
118
+ get(path) end
119
+
120
+ # Get audit information about a transaction
121
+ #
122
122
  # Retrieve audit information about a transaction stored in AvaTax.
123
123
  #
124
124
  # The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit
@@ -146,16 +146,16 @@ module AvaTax
146
146
  # ### Security Policies
147
147
  #
148
148
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
149
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
149
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
150
150
  # @param companyCode [String] The code identifying the company that owns this transaction
151
151
  # @param transactionCode [String] The code identifying the transaction
152
152
  # @param documentType [String] The document type of the original transaction (See DocumentType::* for a list of allowable values)
153
- # @return [Object]
154
- def audit_transaction_with_type(companyCode, transactionCode, documentType) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
155
- get(path) end
156
-
157
- # Lock a set of documents
158
- #
153
+ # @return [Object]
154
+ def audit_transaction_with_type(companyCode, transactionCode, documentType) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
155
+ get(path) end
156
+
157
+ # Lock a set of documents
158
+ #
159
159
  # This API is available by invitation only.
160
160
  #
161
161
  # Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once.
@@ -167,14 +167,14 @@ module AvaTax
167
167
  # ### Security Policies
168
168
  #
169
169
  # * This API requires the user role Compliance Root User.
170
- # * 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.
170
+ # * 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.
171
171
  # @param model [Object] bulk lock request
172
- # @return [Object]
173
- def bulk_lock_transaction(model) path = "/api/v2/transactions/lock"
174
- post(path, model) end
175
-
176
- # Change a transaction's code
177
- #
172
+ # @return [Object]
173
+ def bulk_lock_transaction(model) path = "/api/v2/transactions/lock"
174
+ post(path, model) end
175
+
176
+ # Change a transaction's code
177
+ #
178
178
  # Renames a transaction uniquely identified by this URL by changing its `code` value.
179
179
  #
180
180
  # This API is available as long as the transaction is in `saved` or `posted` status. When a transaction
@@ -208,18 +208,18 @@ module AvaTax
208
208
  # ### Security Policies
209
209
  #
210
210
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
211
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
211
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
212
212
  # @param companyCode [String] The company code of the company that recorded this transaction
213
213
  # @param transactionCode [String] The transaction code to change
214
214
  # @param documentType [String] (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
215
215
  # @param include [String] Specifies objects to include in this fetch call
216
216
  # @param model [Object] The code change request you wish to execute
217
- # @return [Object]
218
- def change_transaction_code(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
219
- post(path, model, options) end
220
-
221
- # Commit a transaction for reporting
222
- #
217
+ # @return [Object]
218
+ def change_transaction_code(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
219
+ post(path, model, options) end
220
+
221
+ # Commit a transaction for reporting
222
+ #
223
223
  # Marks a transaction by changing its status to `Committed`.
224
224
  #
225
225
  # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -251,18 +251,18 @@ module AvaTax
251
251
  #
252
252
  # ### Security Policies
253
253
  #
254
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
254
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
255
255
  # @param companyCode [String] The company code of the company that recorded this transaction
256
256
  # @param transactionCode [String] The transaction code to commit
257
257
  # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
258
258
  # @param include [String] Specifies objects to include in this fetch call
259
259
  # @param model [Object] The commit request you wish to execute
260
- # @return [Object]
261
- def commit_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
262
- post(path, model, options) end
263
-
264
- # Create or adjust a transaction
265
- #
260
+ # @return [Object]
261
+ def commit_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
262
+ post(path, model, options) end
263
+
264
+ # Create or adjust a transaction
265
+ #
266
266
  # Records a new transaction or adjust an existing transaction in AvaTax.
267
267
  #
268
268
  # The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API
@@ -300,15 +300,15 @@ module AvaTax
300
300
  # ### Security Policies
301
301
  #
302
302
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
303
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
303
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
304
304
  # @param include [String] Specifies objects to include in the response after transaction is created
305
305
  # @param model [Object] The transaction you wish to create or adjust
306
- # @return [Object]
307
- def create_or_adjust_transaction(model, options={}) path = "/api/v2/transactions/createoradjust"
308
- post(path, model, options) end
309
-
310
- # Create a new transaction
311
- #
306
+ # @return [Object]
307
+ def create_or_adjust_transaction(model, options={}) path = "/api/v2/transactions/createoradjust"
308
+ post(path, model, options) end
309
+
310
+ # Create a new transaction
311
+ #
312
312
  # Records a new transaction in AvaTax.
313
313
  #
314
314
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -353,15 +353,15 @@ module AvaTax
353
353
  # ### Security Policies
354
354
  #
355
355
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
356
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
356
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
357
357
  # @param include [String] Specifies objects to include in the response after transaction is created
358
358
  # @param model [Object] The transaction you wish to create
359
- # @return [Object]
360
- def create_transaction(model, options={}) path = "/api/v2/transactions/create"
361
- post(path, model, options) end
362
-
363
- # Remove lines from an existing unlocked transaction
364
- #
359
+ # @return [Object]
360
+ def create_transaction(model, options={}) path = "/api/v2/transactions/create"
361
+ post(path, model, options) end
362
+
363
+ # Remove lines from an existing unlocked transaction
364
+ #
365
365
  # Remove lines to an existing unlocked transaction.
366
366
  #
367
367
  # The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will
@@ -383,15 +383,15 @@ module AvaTax
383
383
  # ### Security Policies
384
384
  #
385
385
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
386
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
386
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
387
387
  # @param include [String] Specifies objects to include in the response after transaction is created
388
388
  # @param model [Object] information about the transaction and lines to be removed
389
- # @return [Object]
390
- def delete_lines(model, options={}) path = "/api/v2/companies/transactions/lines/delete"
391
- post(path, model, options) end
392
-
393
- # Retrieve a single transaction by code
394
- #
389
+ # @return [Object]
390
+ def delete_lines(model, options={}) path = "/api/v2/companies/transactions/lines/delete"
391
+ post(path, model, options) end
392
+
393
+ # Retrieve a single transaction by code
394
+ #
395
395
  # Get the current transaction identified by this company code, transaction code, and document type.
396
396
  #
397
397
  # A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`.
@@ -422,17 +422,17 @@ module AvaTax
422
422
  # ### Security Policies
423
423
  #
424
424
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
425
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
425
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
426
426
  # @param companyCode [String] The company code of the company that recorded this transaction
427
427
  # @param transactionCode [String] The transaction code to retrieve
428
428
  # @param documentType [String] (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)
429
429
  # @param include [String] Specifies objects to include in this fetch call
430
- # @return [Object]
431
- def get_transaction_by_code(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
432
- get(path, options) end
433
-
434
- # Retrieve a single transaction by code
435
- #
430
+ # @return [Object]
431
+ def get_transaction_by_code(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
432
+ get(path, options) end
433
+
434
+ # Retrieve a single transaction by code
435
+ #
436
436
  # DEPRECATED: Please use the `GetTransactionByCode` API instead.
437
437
  #
438
438
  # NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
@@ -446,17 +446,17 @@ module AvaTax
446
446
  # ### Security Policies
447
447
  #
448
448
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
449
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
449
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
450
450
  # @param companyCode [String] The company code of the company that recorded this transaction
451
451
  # @param transactionCode [String] The transaction code to retrieve
452
452
  # @param documentType [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
453
453
  # @param include [String] Specifies objects to include in this fetch call
454
- # @return [Object]
455
- def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
456
- get(path, options) end
457
-
458
- # Retrieve a single transaction by ID
459
- #
454
+ # @return [Object]
455
+ def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
456
+ get(path, options) end
457
+
458
+ # Retrieve a single transaction by ID
459
+ #
460
460
  # Get the unique transaction identified by this URL.
461
461
  #
462
462
  # This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted
@@ -478,15 +478,15 @@ module AvaTax
478
478
  # ### Security Policies
479
479
  #
480
480
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
481
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
481
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
482
482
  # @param id [Integer] The unique ID number of the transaction to retrieve
483
483
  # @param include [String] Specifies objects to include in this fetch call
484
- # @return [Object]
485
- def get_transaction_by_id(id, options={}) path = "/api/v2/transactions/#{id}"
486
- get(path, options) end
487
-
488
- # Retrieve all transactions
489
- #
484
+ # @return [Object]
485
+ def get_transaction_by_id(id, options={}) path = "/api/v2/transactions/#{id}"
486
+ get(path, options) end
487
+
488
+ # Retrieve all transactions
489
+ #
490
490
  # List all transactions attached to this company.
491
491
  #
492
492
  # This endpoint is limited to returning 1,000 transactions at a time maximum.
@@ -520,7 +520,7 @@ module AvaTax
520
520
  # ### Security Policies
521
521
  #
522
522
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
523
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
523
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
524
524
  # @param companyCode [String] The company code of the company that recorded this transaction
525
525
  # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
526
526
  # @param include [String] Specifies objects to include in this fetch call
@@ -528,12 +528,12 @@ module AvaTax
528
528
  # @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.
529
529
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
530
530
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
531
- # @return [FetchResult]
532
- def list_transactions_by_company(companyCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions"
533
- get(path, options) end
534
-
535
- # Lock a single transaction
536
- #
531
+ # @return [FetchResult]
532
+ def list_transactions_by_company(companyCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions"
533
+ get(path, options) end
534
+
535
+ # Lock a single transaction
536
+ #
537
537
  # Lock a transaction uniquely identified by this URL.
538
538
  #
539
539
  # This API is mainly used for connector developers to simulate what happens when the Returns product locks a document.
@@ -567,18 +567,18 @@ module AvaTax
567
567
  # ### Security Policies
568
568
  #
569
569
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
570
- # * 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.
570
+ # * 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.
571
571
  # @param companyCode [String] The company code of the company that recorded this transaction
572
572
  # @param transactionCode [String] The transaction code to lock
573
573
  # @param documentType [String] (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
574
574
  # @param include [String] Specifies objects to include in this fetch call
575
575
  # @param model [Object] The lock request you wish to execute
576
- # @return [Object]
577
- def lock_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
578
- post(path, model, options) end
579
-
580
- # Create a refund for a transaction
581
- #
576
+ # @return [Object]
577
+ def lock_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
578
+ post(path, model, options) end
579
+
580
+ # Create a refund for a transaction
581
+ #
582
582
  # Create a refund for a transaction.
583
583
  #
584
584
  # The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund
@@ -622,19 +622,19 @@ module AvaTax
622
622
  # ### Security Policies
623
623
  #
624
624
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
625
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
625
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
626
626
  # @param companyCode [String] The code of the company that made the original sale
627
627
  # @param transactionCode [String] The transaction code of the original sale
628
628
  # @param include [String] Specifies objects to include in the response after transaction is created
629
629
  # @param documentType [String] (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
630
630
  # @param useTaxDateOverride [Boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
631
631
  # @param model [Object] Information about the refund to create
632
- # @return [Object]
633
- def refund_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
634
- post(path, model, options) end
635
-
636
- # Perform multiple actions on a transaction
637
- #
632
+ # @return [Object]
633
+ def refund_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
634
+ post(path, model, options) end
635
+
636
+ # Perform multiple actions on a transaction
637
+ #
638
638
  # Performs one or more actions against the current transaction uniquely identified by this URL.
639
639
  #
640
640
  # The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`.
@@ -666,18 +666,18 @@ module AvaTax
666
666
  #
667
667
  # ### Security Policies
668
668
  #
669
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
669
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
670
670
  # @param companyCode [String] The company code of the company that recorded this transaction
671
671
  # @param transactionCode [String] The transaction code to settle
672
672
  # @param documentType [String] (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
673
673
  # @param include [String] Specifies objects to include in this fetch call
674
674
  # @param model [Object] The data from an external system to reconcile against AvaTax
675
- # @return [Object]
676
- def settle_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
677
- post(path, model, options) end
678
-
679
- # Uncommit a transaction for reporting
680
- #
675
+ # @return [Object]
676
+ def settle_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
677
+ post(path, model, options) end
678
+
679
+ # Uncommit a transaction for reporting
680
+ #
681
681
  # Adjusts a transaction by changing it to an uncommitted status.
682
682
  #
683
683
  # Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are
@@ -704,17 +704,17 @@ module AvaTax
704
704
  # ### Security Policies
705
705
  #
706
706
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
707
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
707
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
708
708
  # @param companyCode [String] The company code of the company that recorded this transaction
709
709
  # @param transactionCode [String] The transaction code to Uncommit
710
710
  # @param documentType [String] (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
711
711
  # @param include [String] Specifies objects to include in this fetch call
712
- # @return [Object]
713
- def uncommit_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
714
- post(path, options) end
715
-
716
- # Unvoids a transaction
717
- #
712
+ # @return [Object]
713
+ def uncommit_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
714
+ post(path, options) end
715
+
716
+ # Unvoids a transaction
717
+ #
718
718
  # Unvoids a voided transaction
719
719
  #
720
720
  # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
@@ -738,17 +738,17 @@ module AvaTax
738
738
  # ### Security Policies
739
739
  #
740
740
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
741
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
741
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
742
742
  # @param companyCode [String] The company code of the company that recorded this transaction
743
743
  # @param transactionCode [String] The transaction code to commit
744
744
  # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
745
745
  # @param include [String] Specifies objects to include in this fetch call
746
- # @return [Object]
747
- def unvoid_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
748
- post(path, options) end
749
-
750
- # Verify a transaction
751
- #
746
+ # @return [Object]
747
+ def unvoid_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
748
+ post(path, options) end
749
+
750
+ # Verify a transaction
751
+ #
752
752
  # Verifies that the transaction uniquely identified by this URL matches certain expected values.
753
753
  #
754
754
  # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
@@ -779,18 +779,18 @@ module AvaTax
779
779
  # ### Security Policies
780
780
  #
781
781
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
782
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
782
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
783
783
  # @param companyCode [String] The company code of the company that recorded this transaction
784
784
  # @param transactionCode [String] The transaction code to settle
785
785
  # @param documentType [String] (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
786
786
  # @param include [String] Specifies objects to include in this fetch call
787
787
  # @param model [Object] The data from an external system to reconcile against AvaTax
788
- # @return [Object]
789
- def verify_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
790
- post(path, model, options) end
791
-
792
- # Void a transaction
793
- #
788
+ # @return [Object]
789
+ def verify_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
790
+ post(path, model, options) end
791
+
792
+ # Void a transaction
793
+ #
794
794
  # Voids the current transaction uniquely identified by this URL.
795
795
  #
796
796
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -823,15 +823,15 @@ module AvaTax
823
823
  # ### Security Policies
824
824
  #
825
825
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
826
- # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
826
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
827
827
  # @param companyCode [String] The company code of the company that recorded this transaction
828
828
  # @param transactionCode [String] The transaction code to void
829
829
  # @param documentType [String] (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
830
830
  # @param include [String] Specifies objects to include in this fetch call
831
831
  # @param model [Object] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
832
- # @return [Object]
833
- def void_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
834
- post(path, model, options) end
835
- end
836
- end
832
+ # @return [Object]
833
+ def void_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
834
+ post(path, model, options) end
835
+ end
836
+ end
837
837
  end