Returns refund information, including invoice reversals, for a specified account.
Error Codes
Error Code/Description |
Associated Inputs |
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
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
|
<acct_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
|
<include_voided> |
Additional Guidance
Input Fields
Field Name |
Notes |
<include_voided> |
Allowable values
Values |
Description |
true |
true |
false |
false |
|
Output Fields
Field Name |
Notes |
<reason_code> |
Allowable values
Values |
Description |
1 |
Account charged in error |
2 |
Goods/services not delivered |
3 |
Customer dissatisfaction |
4 |
Cancellation of pre-paid service |
5 |
Good Will |
6 |
Overpayment / Duplicate payment |
7 |
Wrong/undesired payment source charged |
99999999 |
Other |
|
<pay_method_id> |
Allowable values
Values |
Description |
-1 |
External Payment |
0 |
Other |
1 |
Credit card |
2 |
Electronic Check (ACH) |
3 |
Pre-paid |
4 |
Net terms 30 |
5 |
Net terms 10 |
6 |
Net terms 15 |
7 |
Net terms 60 |
8 |
Click&Buy |
9 |
Net Terms 0 |
10 |
PayByCash |
11 |
PayPal Express Checkout |
12 |
Net Terms 45 |
13 |
Tokenized Credit Card |
14 |
Purchase Power |
15 |
Net Terms 35 |
16 |
Net Terms 75 |
17 |
Net Terms 90 |
18 |
Net Terms 120 |
19 |
Net Terms 25 |
26 |
Direct Debit |
|
<cc_id> |
Allowable values
Values |
Description |
1 |
Visa |
2 |
MasterCard |
3 |
American Express |
4 |
Discover |
5 |
Diners Club/Carte Blanche |
6 |
Maestro |
7 |
JCB |
8 |
Laser |
9 |
Dankoort |
|
<is_voided_ind> |
Allowable values
Values |
Description |
0 |
false |
1 |
true |
|