avatax 19.4.0 → 19.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/avatax/client/addresses.rb +5 -0
- data/lib/avatax/client/avafileforms.rb +10 -11
- data/lib/avatax/client/certexpressinvites.rb +1 -1
- data/lib/avatax/client/certificates.rb +4 -2
- data/lib/avatax/client/companies.rb +46 -7
- data/lib/avatax/client/compliance.rb +0 -106
- data/lib/avatax/client/contacts.rb +0 -2
- data/lib/avatax/client/customers.rb +99 -2
- data/lib/avatax/client/errortransactions.rb +50 -0
- data/lib/avatax/client/filingcalendars.rb +87 -48
- data/lib/avatax/client/filings.rb +57 -56
- data/lib/avatax/client/firmclientlinkages.rb +151 -0
- data/lib/avatax/client/free.rb +3 -3
- data/lib/avatax/client/fundingrequests.rb +4 -4
- data/lib/avatax/client/items.rb +69 -0
- data/lib/avatax/client/notices.rb +46 -46
- data/lib/avatax/client/notifications.rb +3 -1
- data/lib/avatax/client/onboarding.rb +2 -2
- data/lib/avatax/client/registrar.rb +3 -0
- data/lib/avatax/client/reports.rb +6 -25
- data/lib/avatax/client/taxContent/README.txt +1 -0
- data/lib/avatax/client/taxRatesByZip/README.txt +1 -0
- data/lib/avatax/client/taxcontent.rb +4 -4
- data/lib/avatax/client/transactions.rb +120 -5
- data/lib/avatax/version.rb +1 -1
- metadata +8 -3
@@ -18,9 +18,11 @@ module AvaTax
|
|
18
18
|
# dismissed. You can then later review which employees of your company dismissed notifications to
|
19
19
|
# determine if they were resolved appropriately.
|
20
20
|
#
|
21
|
+
# A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
|
22
|
+
#
|
21
23
|
# ### Security Policies
|
22
24
|
#
|
23
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
24
26
|
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
25
27
|
# @return [Object]
|
26
28
|
def dismiss_notification(id)
|
@@ -23,7 +23,7 @@ module AvaTax
|
|
23
23
|
# ### Security Policies
|
24
24
|
#
|
25
25
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
|
-
# * This API is available by invitation only.
|
26
|
+
# * This API is available by invitation only.
|
27
27
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount].
|
28
28
|
# @param model [Object] Information about the account you wish to create and the selected product offerings.
|
29
29
|
# @return [Object]
|
@@ -41,7 +41,7 @@ module AvaTax
|
|
41
41
|
# ### Security Policies
|
42
42
|
#
|
43
43
|
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
44
|
-
# * This API is available by invitation only.
|
44
|
+
# * This API is available by invitation only.
|
45
45
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount].
|
46
46
|
# @param id [Integer] The avatax account id of the customer
|
47
47
|
# @param offer [String] The offer to be added to an already existing customer
|
@@ -32,6 +32,9 @@ module AvaTax
|
|
32
32
|
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
33
33
|
# any relevant concerns raised by this notification.
|
34
34
|
#
|
35
|
+
# A Global notification is a message which is directed to all the accounts and is set to expire within
|
36
|
+
# a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.
|
37
|
+
#
|
35
38
|
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
36
39
|
# affect you, or a potential issue with your company's tax profile.
|
37
40
|
#
|
@@ -31,29 +31,6 @@ module AvaTax
|
|
31
31
|
end
|
32
32
|
|
33
33
|
|
34
|
-
# Intiate and download an ExportDocumentLine report
|
35
|
-
#
|
36
|
-
# This API is deprecated.
|
37
|
-
#
|
38
|
-
# Please use the asynchronous reports APIs:
|
39
|
-
#
|
40
|
-
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
|
41
|
-
# * In the result of the Initiate API, you receive back a report's `id` value.
|
42
|
-
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
|
43
|
-
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
|
44
|
-
#
|
45
|
-
# ### Security Policies
|
46
|
-
#
|
47
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
48
|
-
# @param companyId [Integer] The unique ID number of the company to report on.
|
49
|
-
# @param model [Object] Options that may be configured to customize the report.
|
50
|
-
# @return [Object]
|
51
|
-
def export_document_line(companyId, model)
|
52
|
-
path = "/api/v2/companies/#{companyId}/reports/exportdocumentline"
|
53
|
-
post(path, model)
|
54
|
-
end
|
55
|
-
|
56
|
-
|
57
34
|
# Retrieve a single report
|
58
35
|
#
|
59
36
|
# Retrieve a single report by its unique ID number.
|
@@ -118,10 +95,14 @@ module AvaTax
|
|
118
95
|
# ### Security Policies
|
119
96
|
#
|
120
97
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
98
|
+
# @param companyId [Integer] The id of the company for which to get reports.
|
99
|
+
# @param pageKey [String] Provide a page key to retrieve the next page of results.
|
100
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
101
|
+
# @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.
|
121
102
|
# @return [FetchResult]
|
122
|
-
def list_reports()
|
103
|
+
def list_reports(options={})
|
123
104
|
path = "/api/v2/reports"
|
124
|
-
get(path)
|
105
|
+
get(path, options)
|
125
106
|
end
|
126
107
|
|
127
108
|
end
|
@@ -0,0 +1 @@
|
|
1
|
+
This folder is for storing offline tax content.
|
@@ -0,0 +1 @@
|
|
1
|
+
This folder stores tax rates by ZIP code.
|
@@ -31,7 +31,7 @@ module AvaTax
|
|
31
31
|
#
|
32
32
|
# ### Security Policies
|
33
33
|
#
|
34
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
34
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
35
35
|
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
36
36
|
# @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
|
37
37
|
# @return [Object]
|
@@ -69,7 +69,7 @@ module AvaTax
|
|
69
69
|
#
|
70
70
|
# ### Security Policies
|
71
71
|
#
|
72
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
72
|
+
# * 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.
|
73
73
|
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
74
74
|
# @param companyId [Integer] The ID number of the company that owns this location.
|
75
75
|
# @param id [Integer] The ID number of the location to retrieve point-of-sale data.
|
@@ -129,9 +129,9 @@ module AvaTax
|
|
129
129
|
#
|
130
130
|
# ### Security Policies
|
131
131
|
#
|
132
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
132
|
+
# * 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.
|
133
133
|
# @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
|
134
|
-
# @param region [String]
|
134
|
+
# @param region [String] A two character region code which limits results to a specific region.
|
135
135
|
# @return [Object]
|
136
136
|
def download_tax_rates_by_zip_code(date, options={})
|
137
137
|
path = "/api/v2/taxratesbyzipcode/download/#{date}"
|
@@ -63,6 +63,11 @@ module AvaTax
|
|
63
63
|
# * LinesOnly (omit details - reduces API response size)
|
64
64
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
65
65
|
#
|
66
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
67
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
68
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
69
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
70
|
+
#
|
66
71
|
# ### Security Policies
|
67
72
|
#
|
68
73
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -97,6 +102,11 @@ module AvaTax
|
|
97
102
|
# A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
|
98
103
|
# sales, purchases, inventory transfer, and returns (also called refunds).
|
99
104
|
#
|
105
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
106
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
107
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
108
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
109
|
+
#
|
100
110
|
# ### Security Policies
|
101
111
|
#
|
102
112
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -128,6 +138,11 @@ module AvaTax
|
|
128
138
|
# A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
|
129
139
|
# sales, purchases, inventory transfer, and returns (also called refunds).
|
130
140
|
#
|
141
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
142
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
143
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
144
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
145
|
+
#
|
131
146
|
# ### Security Policies
|
132
147
|
#
|
133
148
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -154,8 +169,9 @@ module AvaTax
|
|
154
169
|
#
|
155
170
|
# ### Security Policies
|
156
171
|
#
|
157
|
-
# * This API
|
158
|
-
# * This API
|
172
|
+
# * This API requires the user role Compliance Root User.
|
173
|
+
# * 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.
|
174
|
+
# * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
|
159
175
|
# @param model [Object] bulk lock request
|
160
176
|
# @return [Object]
|
161
177
|
def bulk_lock_transaction(model)
|
@@ -188,6 +204,11 @@ module AvaTax
|
|
188
204
|
# * LinesOnly (omit details - reduces API response size)
|
189
205
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
190
206
|
#
|
207
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
208
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
209
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
210
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
211
|
+
#
|
191
212
|
# ### Security Policies
|
192
213
|
#
|
193
214
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
@@ -227,6 +248,11 @@ module AvaTax
|
|
227
248
|
# * LinesOnly (omit details - reduces API response size)
|
228
249
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
229
250
|
#
|
251
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
252
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
253
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
254
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
255
|
+
#
|
230
256
|
# ### Security Policies
|
231
257
|
#
|
232
258
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
@@ -273,6 +299,11 @@ module AvaTax
|
|
273
299
|
#
|
274
300
|
# If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
|
275
301
|
#
|
302
|
+
# NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:
|
303
|
+
# * \_-ava2f-\_
|
304
|
+
# * \_-ava2b-\_
|
305
|
+
# * \_-ava3f-\_
|
306
|
+
#
|
276
307
|
# ### Security Policies
|
277
308
|
#
|
278
309
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -324,6 +355,11 @@ module AvaTax
|
|
324
355
|
#
|
325
356
|
# If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
|
326
357
|
#
|
358
|
+
# NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:
|
359
|
+
# * \_-ava2f-\_
|
360
|
+
# * \_-ava2b-\_
|
361
|
+
# * \_-ava3f-\_
|
362
|
+
#
|
327
363
|
# ### Security Policies
|
328
364
|
#
|
329
365
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -391,6 +427,11 @@ module AvaTax
|
|
391
427
|
# * SummaryOnly (omit lines and details - reduces API response size)
|
392
428
|
# * LinesOnly (omit details - reduces API response size)
|
393
429
|
#
|
430
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
431
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
432
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
433
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
434
|
+
#
|
394
435
|
# ### Security Policies
|
395
436
|
#
|
396
437
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -410,6 +451,11 @@ module AvaTax
|
|
410
451
|
#
|
411
452
|
# DEPRECATED: Please use the `GetTransactionByCode` API instead.
|
412
453
|
#
|
454
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
455
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
456
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
457
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
458
|
+
#
|
413
459
|
# ### Security Policies
|
414
460
|
#
|
415
461
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -482,6 +528,11 @@ module AvaTax
|
|
482
528
|
# * SummaryOnly (omit lines and details - reduces API response size)
|
483
529
|
# * LinesOnly (omit details - reduces API response size)
|
484
530
|
#
|
531
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
532
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
533
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
534
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
535
|
+
#
|
485
536
|
# ### Security Policies
|
486
537
|
#
|
487
538
|
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -524,10 +575,15 @@ module AvaTax
|
|
524
575
|
# * LinesOnly (omit details - reduces API response size)
|
525
576
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
526
577
|
#
|
578
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
579
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
580
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
581
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
582
|
+
#
|
527
583
|
# ### Security Policies
|
528
584
|
#
|
529
585
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
530
|
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
586
|
+
# * 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.
|
531
587
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
532
588
|
# @param transactionCode [String] The transaction code to lock
|
533
589
|
# @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,6 +630,11 @@ module AvaTax
|
|
574
630
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
575
631
|
# If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
|
576
632
|
#
|
633
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
634
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
635
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
636
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
637
|
+
#
|
577
638
|
# ### Security Policies
|
578
639
|
#
|
579
640
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
@@ -614,6 +675,11 @@ module AvaTax
|
|
614
675
|
# * LinesOnly (omit details - reduces API response size)
|
615
676
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
616
677
|
#
|
678
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
679
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
680
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
681
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
682
|
+
#
|
617
683
|
# ### Security Policies
|
618
684
|
#
|
619
685
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
@@ -646,13 +712,18 @@ module AvaTax
|
|
646
712
|
# * LinesOnly (omit details - reduces API response size)
|
647
713
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
648
714
|
#
|
715
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
716
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
717
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
718
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
719
|
+
#
|
649
720
|
# ### Security Policies
|
650
721
|
#
|
651
722
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
652
723
|
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
653
724
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
654
|
-
# @param transactionCode [String] The transaction code to
|
655
|
-
# @param documentType [String] (Optional): The document type of the transaction to
|
725
|
+
# @param transactionCode [String] The transaction code to Uncommit
|
726
|
+
# @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)
|
656
727
|
# @param include [String] Specifies objects to include in this fetch call
|
657
728
|
# @return [Object]
|
658
729
|
def uncommit_transaction(companyCode, transactionCode, options={})
|
@@ -661,6 +732,40 @@ module AvaTax
|
|
661
732
|
end
|
662
733
|
|
663
734
|
|
735
|
+
# Unvoids a transaction
|
736
|
+
#
|
737
|
+
# Unvoids a voided transaction
|
738
|
+
#
|
739
|
+
# 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:
|
740
|
+
#
|
741
|
+
# * Lines
|
742
|
+
# * Details (implies lines)
|
743
|
+
# * Summary (implies details)
|
744
|
+
# * Addresses
|
745
|
+
# * SummaryOnly (omit lines and details - reduces API response size)
|
746
|
+
# * LinesOnly (omit details - reduces API response size)
|
747
|
+
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
748
|
+
#
|
749
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
750
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
751
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
752
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
753
|
+
#
|
754
|
+
# ### Security Policies
|
755
|
+
#
|
756
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
757
|
+
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
758
|
+
# @param companyCode [String] The company code of the company that recorded this transaction
|
759
|
+
# @param transactionCode [String] The transaction code to commit
|
760
|
+
# @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)
|
761
|
+
# @param include [String] Specifies objects to include in this fetch call
|
762
|
+
# @return [Object]
|
763
|
+
def unvoid_transaction(companyCode, transactionCode, options={})
|
764
|
+
path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
|
765
|
+
post(path, options)
|
766
|
+
end
|
767
|
+
|
768
|
+
|
664
769
|
# Verify a transaction
|
665
770
|
#
|
666
771
|
# Verifies that the transaction uniquely identified by this URL matches certain expected values.
|
@@ -682,6 +787,11 @@ module AvaTax
|
|
682
787
|
# * LinesOnly (omit details - reduces API response size)
|
683
788
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
684
789
|
#
|
790
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
791
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
792
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
793
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
794
|
+
#
|
685
795
|
# ### Security Policies
|
686
796
|
#
|
687
797
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
@@ -721,6 +831,11 @@ module AvaTax
|
|
721
831
|
# * LinesOnly (omit details - reduces API response size)
|
722
832
|
# * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
|
723
833
|
#
|
834
|
+
# NOTE: If your companyCode or transactionCode contains any of these characters /, + or ? please use the following encoding before making a request:
|
835
|
+
# * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
|
836
|
+
# * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
|
837
|
+
# * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
|
838
|
+
#
|
724
839
|
# ### Security Policies
|
725
840
|
#
|
726
841
|
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
data/lib/avatax/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: avatax
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 19.
|
4
|
+
version: 19.9.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Marcus Vorwaller
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-10-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rake
|
@@ -147,8 +147,10 @@ files:
|
|
147
147
|
- lib/avatax/client/definitions.rb
|
148
148
|
- lib/avatax/client/distancethresholds.rb
|
149
149
|
- lib/avatax/client/ecms.rb
|
150
|
+
- lib/avatax/client/errortransactions.rb
|
150
151
|
- lib/avatax/client/filingcalendars.rb
|
151
152
|
- lib/avatax/client/filings.rb
|
153
|
+
- lib/avatax/client/firmclientlinkages.rb
|
152
154
|
- lib/avatax/client/free.rb
|
153
155
|
- lib/avatax/client/fundingrequests.rb
|
154
156
|
- lib/avatax/client/items.rb
|
@@ -164,6 +166,8 @@ files:
|
|
164
166
|
- lib/avatax/client/reports.rb
|
165
167
|
- lib/avatax/client/settings.rb
|
166
168
|
- lib/avatax/client/subscriptions.rb
|
169
|
+
- lib/avatax/client/taxContent/README.txt
|
170
|
+
- lib/avatax/client/taxRatesByZip/README.txt
|
167
171
|
- lib/avatax/client/taxcodes.rb
|
168
172
|
- lib/avatax/client/taxcontent.rb
|
169
173
|
- lib/avatax/client/taxprofiles.rb
|
@@ -213,7 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
213
217
|
- !ruby/object:Gem::Version
|
214
218
|
version: 2.0.0
|
215
219
|
requirements: []
|
216
|
-
|
220
|
+
rubyforge_project:
|
221
|
+
rubygems_version: 2.5.2.3
|
217
222
|
signing_key:
|
218
223
|
specification_version: 4
|
219
224
|
summary: Ruby wrapper for the AvaTax API
|