avatax 20.5.0 → 20.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.vs/slnx.sqlite +0 -0
  3. data/avatax.gemspec +0 -1
  4. data/lib/avatax/client/accounts.rb +83 -83
  5. data/lib/avatax/client/addresses.rb +21 -21
  6. data/lib/avatax/client/advancedrules.rb +51 -41
  7. data/lib/avatax/client/avafileforms.rb +41 -41
  8. data/lib/avatax/client/batches.rb +101 -48
  9. data/lib/avatax/client/certexpressinvites.rb +39 -39
  10. data/lib/avatax/client/certificates.rb +163 -163
  11. data/lib/avatax/client/companies.rb +226 -121
  12. data/lib/avatax/client/compliance.rb +13 -13
  13. data/lib/avatax/client/contacts.rb +48 -48
  14. data/lib/avatax/client/customers.rb +145 -145
  15. data/lib/avatax/client/datasources.rb +48 -48
  16. data/lib/avatax/client/definitions.rb +422 -420
  17. data/lib/avatax/client/distancethresholds.rb +48 -48
  18. data/lib/avatax/client/ecms.rb +26 -31
  19. data/lib/avatax/client/ecommercetoken.rb +37 -0
  20. data/lib/avatax/client/errortransactions.rb +27 -15
  21. data/lib/avatax/client/filingcalendars.rb +28 -13
  22. data/lib/avatax/client/filings.rb +25 -14
  23. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  24. data/lib/avatax/client/free.rb +27 -27
  25. data/lib/avatax/client/fundingrequests.rb +20 -20
  26. data/lib/avatax/client/items.rb +139 -139
  27. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  28. data/lib/avatax/client/locations.rb +168 -57
  29. data/lib/avatax/client/multidocument.rb +98 -78
  30. data/lib/avatax/client/nexus.rb +104 -104
  31. data/lib/avatax/client/notices.rb +47 -139
  32. data/lib/avatax/client/notifications.rb +27 -27
  33. data/lib/avatax/client/provisioning.rb +20 -20
  34. data/lib/avatax/client/registrar.rb +76 -76
  35. data/lib/avatax/client/reports.rb +34 -34
  36. data/lib/avatax/client/settings.rb +48 -48
  37. data/lib/avatax/client/subscriptions.rb +27 -27
  38. data/lib/avatax/client/taxcodes.rb +48 -48
  39. data/lib/avatax/client/taxcontent.rb +27 -27
  40. data/lib/avatax/client/taxprofiles.rb +14 -10
  41. data/lib/avatax/client/taxrules.rb +48 -48
  42. data/lib/avatax/client/transactions.rb +185 -155
  43. data/lib/avatax/client/upcs.rb +48 -48
  44. data/lib/avatax/client/users.rb +62 -62
  45. data/lib/avatax/client/utilities.rb +27 -27
  46. data/lib/avatax/connection.rb +2 -2
  47. data/lib/avatax/version.rb +1 -1
  48. metadata +3 -16
@@ -12,28 +12,32 @@ module AvaTax
12
12
  #
13
13
  # This API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this
14
14
  # profile to a different company or compare it over time to see if your profile has been changed.
15
+ #
16
+ # ### Security Policies
17
+ #
18
+ # * 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.
19
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
15
20
  # @param companyId [Integer] The unique ID number of the company whose profile you wish to retrieve.
16
21
  # @return [Object]
17
- def export_tax_profile(companyId)
18
- path = "/api/v2/companies/#{companyId}/taxprofile"
19
- get(path)
20
- end
21
-
22
+ def export_tax_profile(companyId) path = "/api/v2/companies/#{companyId}/taxprofile"
23
+ get(path) end
22
24
 
23
25
  # Import a tax profile.
24
26
  #
25
27
  # Imports a tax profile to a new company, along with the option to import account settings.
28
+ #
29
+ # ### Security Policies
30
+ #
31
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
32
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
26
33
  # @param accountId [Integer] The account id of the account to which the tax profile will be imported.
27
34
  # @param newCompanyCode [String] The companyCode to use for the imported company.
28
35
  # @param replaceAccountSettings [Boolean] Replace the current account settings with the ones in the tax profile.
29
36
  # @param bypassNexusValidation [Boolean] Enable invalid nexus to be imported.
30
37
  # @param taxProfile [Object] The taxProfile
31
38
  # @return [Object]
32
- def import_tax_profile()
33
- path = "/api/v2/taxprofile"
34
- post(path)
35
- end
36
-
39
+ def import_tax_profile() path = "/api/v2/taxprofile"
40
+ post(path) end
37
41
  end
38
42
  end
39
43
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module TaxRules
4
-
5
-
6
- # Create a new tax rule
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module TaxRules
4
+
5
+
6
+ # Create a new tax rule
7
+ #
8
8
  # Create one or more custom tax rules attached to this company.
9
9
  #
10
10
  # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -21,15 +21,15 @@ module AvaTax
21
21
  #
22
22
  # ### Security Policies
23
23
  #
24
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
24
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
25
25
  # @param companyId [Integer] The ID of the company that owns this tax rule.
26
26
  # @param model [TaxRuleModel[]] The tax rule you wish to create.
27
- # @return [TaxRuleModel[]]
28
- def create_tax_rules(companyId, model) path = "/api/v2/companies/#{companyId}/taxrules"
29
- post(path, model) end
30
-
31
- # Delete a single tax rule
32
- #
27
+ # @return [TaxRuleModel[]]
28
+ def create_tax_rules(companyId, model) path = "/api/v2/companies/#{companyId}/taxrules"
29
+ post(path, model) end
30
+
31
+ # Delete a single tax rule
32
+ #
33
33
  # Mark the custom tax rule identified by this URL as deleted.
34
34
  #
35
35
  # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -46,15 +46,15 @@ module AvaTax
46
46
  #
47
47
  # ### Security Policies
48
48
  #
49
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
49
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
50
50
  # @param companyId [Integer] The ID of the company that owns this tax rule.
51
51
  # @param id [Integer] The ID of the tax rule you wish to delete.
52
- # @return [ErrorDetail[]]
53
- def delete_tax_rule(companyId, id) path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
54
- delete(path) end
55
-
56
- # Retrieve a single tax rule
57
- #
52
+ # @return [ErrorDetail[]]
53
+ def delete_tax_rule(companyId, id) path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
54
+ delete(path) end
55
+
56
+ # Retrieve a single tax rule
57
+ #
58
58
  # Get the taxrule object identified by this URL.
59
59
  #
60
60
  # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -71,15 +71,15 @@ module AvaTax
71
71
  #
72
72
  # ### Security Policies
73
73
  #
74
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
74
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
75
75
  # @param companyId [Integer] The ID of the company that owns this tax rule
76
76
  # @param id [Integer] The primary key of this tax rule
77
- # @return [Object]
78
- def get_tax_rule(companyId, id) path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
79
- get(path) end
80
-
81
- # Retrieve tax rules for this company
82
- #
77
+ # @return [Object]
78
+ def get_tax_rule(companyId, id) path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
79
+ get(path) end
80
+
81
+ # Retrieve tax rules for this company
82
+ #
83
83
  # List all taxrule objects attached to this company.
84
84
  #
85
85
  # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -99,19 +99,19 @@ module AvaTax
99
99
  #
100
100
  # ### Security Policies
101
101
  #
102
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
102
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
103
103
  # @param companyId [Integer] The ID of the company that owns these tax rules
104
104
  # @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:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
105
105
  # @param include [String] A comma separated list of additional data to retrieve.
106
106
  # @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.
107
107
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
108
108
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
109
- # @return [FetchResult]
110
- def list_tax_rules(companyId, options={}) path = "/api/v2/companies/#{companyId}/taxrules"
111
- get(path, options) end
112
-
113
- # Retrieve all tax rules
114
- #
109
+ # @return [FetchResult]
110
+ def list_tax_rules(companyId, options={}) path = "/api/v2/companies/#{companyId}/taxrules"
111
+ get(path, options) end
112
+
113
+ # Retrieve all tax rules
114
+ #
115
115
  # Get multiple taxrule objects across all companies.
116
116
  #
117
117
  # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -131,18 +131,18 @@ module AvaTax
131
131
  #
132
132
  # ### Security Policies
133
133
  #
134
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
134
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
135
135
  # @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:* taxCode, rateTypeCode, taxTypeGroup, taxSubType
136
136
  # @param include [String] A comma separated list of additional data to retrieve.
137
137
  # @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.
138
138
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
139
139
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
140
- # @return [FetchResult]
141
- def query_tax_rules(options={}) path = "/api/v2/taxrules"
142
- get(path, options) end
143
-
144
- # Update a single tax rule
145
- #
140
+ # @return [FetchResult]
141
+ def query_tax_rules(options={}) path = "/api/v2/taxrules"
142
+ get(path, options) end
143
+
144
+ # Update a single tax rule
145
+ #
146
146
  # Replace the existing custom tax rule object at this URL with an updated object.
147
147
  #
148
148
  # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
@@ -159,13 +159,13 @@ module AvaTax
159
159
  #
160
160
  # ### Security Policies
161
161
  #
162
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
162
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
163
163
  # @param companyId [Integer] The ID of the company that this tax rule belongs to.
164
164
  # @param id [Integer] The ID of the tax rule you wish to update
165
165
  # @param model [Object] The tax rule you wish to update.
166
- # @return [Object]
167
- def update_tax_rule(companyId, id, model) path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
168
- put(path, model) end
169
- end
170
- end
166
+ # @return [Object]
167
+ def update_tax_rule(companyId, id, model) path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
168
+ put(path, model) end
169
+ end
170
+ end
171
171
  end
@@ -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<br />*Required* (all): AvaTaxPro.
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
@@ -64,23 +64,25 @@ module AvaTax
64
64
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
65
65
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
66
66
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
67
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
68
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
67
69
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
68
70
  #
69
71
  # ### Security Policies
70
72
  #
71
73
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
72
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
74
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
73
75
  # @param companyCode [String] The company code of the company that recorded this transaction
74
76
  # @param transactionCode [String] The transaction code to adjust
75
77
  # @param documentType [String] (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)
76
78
  # @param include [String] Specifies objects to include in this fetch call
77
79
  # @param model [Object] The adjustment you wish to make
78
- # @return [Object]
79
- def adjust_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
80
- post(path, model, options) end
81
-
82
- # Get audit information about a transaction
83
- #
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
+ #
84
86
  # Retrieve audit information about a transaction stored in AvaTax.
85
87
  #
86
88
  # The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit
@@ -101,20 +103,22 @@ module AvaTax
101
103
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
102
104
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
103
105
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
106
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
107
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
104
108
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
105
109
  #
106
110
  # ### Security Policies
107
111
  #
108
112
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
109
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
113
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
110
114
  # @param companyCode [String] The code identifying the company that owns this transaction
111
115
  # @param transactionCode [String] The code identifying the transaction
112
- # @return [Object]
113
- def audit_transaction(companyCode, transactionCode) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
114
- get(path) end
115
-
116
- # Get audit information about a transaction
117
- #
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
+ #
118
122
  # Retrieve audit information about a transaction stored in AvaTax.
119
123
  #
120
124
  # The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit
@@ -135,21 +139,23 @@ module AvaTax
135
139
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
136
140
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
137
141
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
142
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
143
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
138
144
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
139
145
  #
140
146
  # ### Security Policies
141
147
  #
142
148
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
143
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
149
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
144
150
  # @param companyCode [String] The code identifying the company that owns this transaction
145
151
  # @param transactionCode [String] The code identifying the transaction
146
152
  # @param documentType [String] The document type of the original transaction (See DocumentType::* for a list of allowable values)
147
- # @return [Object]
148
- def audit_transaction_with_type(companyCode, transactionCode, documentType) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
149
- get(path) end
150
-
151
- # Lock a set of documents
152
- #
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
159
  # This API is available by invitation only.
154
160
  #
155
161
  # Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once.
@@ -161,14 +167,14 @@ module AvaTax
161
167
  # ### Security Policies
162
168
  #
163
169
  # * This API requires the user role Compliance Root User.
164
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*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.
165
171
  # @param model [Object] bulk lock request
166
- # @return [Object]
167
- def bulk_lock_transaction(model) path = "/api/v2/transactions/lock"
168
- post(path, model) end
169
-
170
- # Change a transaction's code
171
- #
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
178
  # Renames a transaction uniquely identified by this URL by changing its `code` value.
173
179
  #
174
180
  # This API is available as long as the transaction is in `saved` or `posted` status. When a transaction
@@ -195,23 +201,25 @@ module AvaTax
195
201
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
196
202
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
197
203
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
204
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
205
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
198
206
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
199
207
  #
200
208
  # ### Security Policies
201
209
  #
202
210
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
203
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
211
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
204
212
  # @param companyCode [String] The company code of the company that recorded this transaction
205
213
  # @param transactionCode [String] The transaction code to change
206
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)
207
215
  # @param include [String] Specifies objects to include in this fetch call
208
216
  # @param model [Object] The code change request you wish to execute
209
- # @return [Object]
210
- def change_transaction_code(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
211
- post(path, model, options) end
212
-
213
- # Commit a transaction for reporting
214
- #
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
+ #
215
223
  # Marks a transaction by changing its status to `Committed`.
216
224
  #
217
225
  # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -237,22 +245,24 @@ module AvaTax
237
245
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
238
246
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
239
247
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
248
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
249
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
240
250
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
241
251
  #
242
252
  # ### Security Policies
243
253
  #
244
- # * 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.
245
255
  # @param companyCode [String] The company code of the company that recorded this transaction
246
256
  # @param transactionCode [String] The transaction code to commit
247
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)
248
258
  # @param include [String] Specifies objects to include in this fetch call
249
259
  # @param model [Object] The commit request you wish to execute
250
- # @return [Object]
251
- def commit_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
252
- post(path, model, options) end
253
-
254
- # Create or adjust a transaction
255
- #
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
+ #
256
266
  # Records a new transaction or adjust an existing transaction in AvaTax.
257
267
  #
258
268
  # The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API
@@ -290,15 +300,15 @@ module AvaTax
290
300
  # ### Security Policies
291
301
  #
292
302
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
293
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
303
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
294
304
  # @param include [String] Specifies objects to include in the response after transaction is created
295
305
  # @param model [Object] The transaction you wish to create or adjust
296
- # @return [Object]
297
- def create_or_adjust_transaction(model, options={}) path = "/api/v2/transactions/createoradjust"
298
- post(path, model, options) end
299
-
300
- # Create a new transaction
301
- #
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
+ #
302
312
  # Records a new transaction in AvaTax.
303
313
  #
304
314
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -343,15 +353,15 @@ module AvaTax
343
353
  # ### Security Policies
344
354
  #
345
355
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
346
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
356
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
347
357
  # @param include [String] Specifies objects to include in the response after transaction is created
348
358
  # @param model [Object] The transaction you wish to create
349
- # @return [Object]
350
- def create_transaction(model, options={}) path = "/api/v2/transactions/create"
351
- post(path, model, options) end
352
-
353
- # Remove lines from an existing unlocked transaction
354
- #
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
+ #
355
365
  # Remove lines to an existing unlocked transaction.
356
366
  #
357
367
  # The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will
@@ -373,15 +383,15 @@ module AvaTax
373
383
  # ### Security Policies
374
384
  #
375
385
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
376
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
386
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
377
387
  # @param include [String] Specifies objects to include in the response after transaction is created
378
388
  # @param model [Object] information about the transaction and lines to be removed
379
- # @return [Object]
380
- def delete_lines(model, options={}) path = "/api/v2/companies/transactions/lines/delete"
381
- post(path, model, options) end
382
-
383
- # Retrieve a single transaction by code
384
- #
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
+ #
385
395
  # Get the current transaction identified by this company code, transaction code, and document type.
386
396
  #
387
397
  # A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`.
@@ -405,44 +415,48 @@ module AvaTax
405
415
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
406
416
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
407
417
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
418
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
419
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
408
420
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
409
421
  #
410
422
  # ### Security Policies
411
423
  #
412
424
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
413
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
425
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
414
426
  # @param companyCode [String] The company code of the company that recorded this transaction
415
427
  # @param transactionCode [String] The transaction code to retrieve
416
428
  # @param documentType [String] (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)
417
429
  # @param include [String] Specifies objects to include in this fetch call
418
- # @return [Object]
419
- def get_transaction_by_code(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
420
- get(path, options) end
421
-
422
- # Retrieve a single transaction by code
423
- #
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
+ #
424
436
  # DEPRECATED: Please use the `GetTransactionByCode` API instead.
425
437
  #
426
438
  # NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
427
439
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
428
440
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
429
441
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
442
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
443
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
430
444
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
431
445
  #
432
446
  # ### Security Policies
433
447
  #
434
448
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
435
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
449
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
436
450
  # @param companyCode [String] The company code of the company that recorded this transaction
437
451
  # @param transactionCode [String] The transaction code to retrieve
438
452
  # @param documentType [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
439
453
  # @param include [String] Specifies objects to include in this fetch call
440
- # @return [Object]
441
- def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
442
- get(path, options) end
443
-
444
- # Retrieve a single transaction by ID
445
- #
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
+ #
446
460
  # Get the unique transaction identified by this URL.
447
461
  #
448
462
  # This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted
@@ -464,15 +478,15 @@ module AvaTax
464
478
  # ### Security Policies
465
479
  #
466
480
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
467
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
481
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
468
482
  # @param id [Integer] The unique ID number of the transaction to retrieve
469
483
  # @param include [String] Specifies objects to include in this fetch call
470
- # @return [Object]
471
- def get_transaction_by_id(id, options={}) path = "/api/v2/transactions/#{id}"
472
- get(path, options) end
473
-
474
- # Retrieve all transactions
475
- #
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
+ #
476
490
  # List all transactions attached to this company.
477
491
  #
478
492
  # This endpoint is limited to returning 1,000 transactions at a time maximum.
@@ -499,28 +513,30 @@ module AvaTax
499
513
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
500
514
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
501
515
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
516
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
517
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
502
518
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
503
519
  #
504
520
  # ### Security Policies
505
521
  #
506
522
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
507
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
523
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
508
524
  # @param companyCode [String] The company code of the company that recorded this transaction
509
525
  # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
510
526
  # @param include [String] Specifies objects to include in this fetch call
511
- # @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:* totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction
527
+ # @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction
512
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.
513
529
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
514
530
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
515
- # @return [FetchResult]
516
- def list_transactions_by_company(companyCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions"
517
- get(path, options) end
518
-
519
- # Lock a single transaction
520
- #
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
+ #
521
537
  # Lock a transaction uniquely identified by this URL.
522
538
  #
523
- # This API is mainly used for connector developer to simulate what happens when Returns product locks a document.
539
+ # This API is mainly used for connector developers to simulate what happens when the Returns product locks a document.
524
540
  # After this API call succeeds, the document will be locked and can't be voided or adjusted.
525
541
  #
526
542
  # This API is only available to customers in Sandbox with AvaTaxPro subscription. On production servers, this API is available by invitation only.
@@ -544,23 +560,25 @@ module AvaTax
544
560
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
545
561
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
546
562
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
563
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
564
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
547
565
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
548
566
  #
549
567
  # ### Security Policies
550
568
  #
551
569
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
552
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*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.
553
571
  # @param companyCode [String] The company code of the company that recorded this transaction
554
572
  # @param transactionCode [String] The transaction code to lock
555
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)
556
574
  # @param include [String] Specifies objects to include in this fetch call
557
575
  # @param model [Object] The lock request you wish to execute
558
- # @return [Object]
559
- def lock_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
560
- post(path, model, options) end
561
-
562
- # Create a refund for a transaction
563
- #
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
+ #
564
582
  # Create a refund for a transaction.
565
583
  #
566
584
  # The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund
@@ -597,24 +615,26 @@ module AvaTax
597
615
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
598
616
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
599
617
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
618
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
619
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
600
620
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
601
621
  #
602
622
  # ### Security Policies
603
623
  #
604
624
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
605
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
625
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
606
626
  # @param companyCode [String] The code of the company that made the original sale
607
627
  # @param transactionCode [String] The transaction code of the original sale
608
628
  # @param include [String] Specifies objects to include in the response after transaction is created
609
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)
610
630
  # @param useTaxDateOverride [Boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
611
631
  # @param model [Object] Information about the refund to create
612
- # @return [Object]
613
- def refund_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
614
- post(path, model, options) end
615
-
616
- # Perform multiple actions on a transaction
617
- #
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
+ #
618
638
  # Performs one or more actions against the current transaction uniquely identified by this URL.
619
639
  #
620
640
  # The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`.
@@ -640,22 +660,24 @@ module AvaTax
640
660
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
641
661
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
642
662
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
663
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
664
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
643
665
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
644
666
  #
645
667
  # ### Security Policies
646
668
  #
647
- # * 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.
648
670
  # @param companyCode [String] The company code of the company that recorded this transaction
649
671
  # @param transactionCode [String] The transaction code to settle
650
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)
651
673
  # @param include [String] Specifies objects to include in this fetch call
652
674
  # @param model [Object] The data from an external system to reconcile against AvaTax
653
- # @return [Object]
654
- def settle_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
655
- post(path, model, options) end
656
-
657
- # Uncommit a transaction for reporting
658
- #
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
+ #
659
681
  # Adjusts a transaction by changing it to an uncommitted status.
660
682
  #
661
683
  # Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are
@@ -675,22 +697,24 @@ module AvaTax
675
697
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
676
698
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
677
699
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
700
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
701
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
678
702
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
679
703
  #
680
704
  # ### Security Policies
681
705
  #
682
706
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
683
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
707
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
684
708
  # @param companyCode [String] The company code of the company that recorded this transaction
685
709
  # @param transactionCode [String] The transaction code to Uncommit
686
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)
687
711
  # @param include [String] Specifies objects to include in this fetch call
688
- # @return [Object]
689
- def uncommit_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
690
- post(path, options) end
691
-
692
- # Unvoids a transaction
693
- #
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
+ #
694
718
  # Unvoids a voided transaction
695
719
  #
696
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:
@@ -707,22 +731,24 @@ module AvaTax
707
731
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
708
732
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
709
733
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
734
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
735
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
710
736
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
711
737
  #
712
738
  # ### Security Policies
713
739
  #
714
740
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
715
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
741
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
716
742
  # @param companyCode [String] The company code of the company that recorded this transaction
717
743
  # @param transactionCode [String] The transaction code to commit
718
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)
719
745
  # @param include [String] Specifies objects to include in this fetch call
720
- # @return [Object]
721
- def unvoid_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
722
- post(path, options) end
723
-
724
- # Verify a transaction
725
- #
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
+ #
726
752
  # Verifies that the transaction uniquely identified by this URL matches certain expected values.
727
753
  #
728
754
  # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
@@ -746,23 +772,25 @@ module AvaTax
746
772
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
747
773
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
748
774
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
775
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
776
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
749
777
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
750
778
  #
751
779
  # ### Security Policies
752
780
  #
753
781
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
754
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
782
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
755
783
  # @param companyCode [String] The company code of the company that recorded this transaction
756
784
  # @param transactionCode [String] The transaction code to settle
757
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)
758
786
  # @param include [String] Specifies objects to include in this fetch call
759
787
  # @param model [Object] The data from an external system to reconcile against AvaTax
760
- # @return [Object]
761
- def verify_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
762
- post(path, model, options) end
763
-
764
- # Void a transaction
765
- #
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
+ #
766
794
  # Voids the current transaction uniquely identified by this URL.
767
795
  #
768
796
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -788,20 +816,22 @@ module AvaTax
788
816
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
789
817
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
790
818
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
819
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
820
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
791
821
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
792
822
  #
793
823
  # ### Security Policies
794
824
  #
795
825
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
796
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
826
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
797
827
  # @param companyCode [String] The company code of the company that recorded this transaction
798
828
  # @param transactionCode [String] The transaction code to void
799
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)
800
830
  # @param include [String] Specifies objects to include in this fetch call
801
831
  # @param model [Object] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
802
- # @return [Object]
803
- def void_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
804
- post(path, model, options) end
805
- end
806
- 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
807
837
  end