Voids a particular transaction associated with a specified account.
| API Specification: |
void_transaction_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <transaction_id>
- <comments>
- <reason_code>
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<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)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<account_no>, <client_acct_id> |
1033: a parameter that represents a true or false value contains invalid input
Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write
|
<discard_invoice_usage> |
2001: transaction does not exist
Associated Inputs: invoice_no
|
|
2002: transaction is a voiding transaction
|
|
2003: transaction already voided
|
|
3053: Individual invoice transactions cannot be voided independent of the invoice. Use void_invoice_m API to void the entire invoice.
|
|
3054: Refund related reversals cannot be voided independent of the refund transaction. Voiding the corresponding refund transaction will automatically void the reversal transaction.
|
|
3106: Individual credit memo transactions cannot be voided independent of the credit memo. Use void_credit_memo_m API to void the entire credit memo.
|
|
3116: Write-off of an unsettled dispute hold cannot be voided
|
|
25020: Illegal characters entered
Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.
|
<auth_key>, <comments>, <client_receipt_id>, <discard_invoice_usage>, <client_acct_id>, <application_id>, <application_date>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value> |
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 |
|
| <discard_invoice_usage> |
Allowable Values
| Values |
Description |
| true |
The loaded usages will be discarded for the invoice. |
| false (Default) |
The loaded usages will not be discarded for the invoice. |
| null |
If NULL, it takes defaults which setting does not discard the usages. |
|
