The void_invoice_m API voids a given invoice object and all its associated transactions. Voiding an invoice is permanent and cannot be undone.
| API Specification: |
void_invoice_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <invoice_no>
- <reason_code>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <reason_code> |
Allowable Values
| Values |
Description |
| 1 |
Duplicate check posting |
| 2 |
Transfer in wrong direction |
| 3 |
Returned payment |
| 4 |
Account responsibility incorrect |
| 5 |
Invoice created in error |
| 6 |
Error in processor integration |
| 7 |
Test data |
| 8 |
Erroneous entry |
| 9 |
Collection on order failed |
| 10 |
Payment voided before settlement |
| 11 |
Voided by 3rd party |
| 12 |
Collection Failed |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<client_no>, <auth_key> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
|
<acct_no>, <client_acct_id> |
2003: transaction already voided
|
|
2005: Combine invoices can not be voided. Please contact customer support.
|
<invoice_no> |
3004: Invoice does not exist
|
<invoice_no> |
3024: Invalid reason code
|
<reason_code> |
3095: The invoice cannot be voided because one or more credit memos have been applied to it.
|
<invoice_no> |
3096: The invoice cannot be voided because it has been rebilled.
|
<invoice_no> |
