issue_refund_to_acct_m Guide
The issue_refund_to_acct_m API issues refunds of payment amounts, and any invoice line items to be reversed for a specified account. The refund of a payment will increase the account/master plan instance balance to its pre-payment state (or near, if a partial refund). A refund related reversal would almost retain the balance "as is", as you are reversing the invoice line item charges, along with the refund.
Reversing an invoice charge line item proportionately reverses the corresponding tax (tax to reverse = original tax - tax for revised charge). In the case of tax-inclusive charges, the specified line item reversal amount will be considered as a tax-inclusive reversal amount. In the case of external tax engines, there will be a tax-posting that will occur to update the new taxes to the external tax engine against the customer's account.
Notes:
- If you use the NETS payment processor, "Enable Refund for NETS Payment" must be set to "True" in the UI before you use this API, or you receive the error message "The payment processor does not support refunds".
- Tax-posting to external tax engines occurs for all generated invoices, voided invoices, write-offs, refund-related reversals, proration reversal/credit (and credit-memo/rebills).
Refund Types
There are three types of refunds that exist currently in Aria that can be manually implemented to resolve a case where a refund is warranted. This section describes what implementing each type means, what happens when processing them, and why you might choose one over another. For more information, see Issue a Refund.
Refund types are as follows:
- Reversing (void) an invoice line item - (Default) Creates another line item that reverses the original invoice charge, that is, it adds a line item transaction to the account that nullifies the charge being refunded. This decreases your revenue by the amount of the reversed line item(s) but has no impact on customer’s balance.
- Creating a new open charge - Opens a new charge transaction while the account holder is refunded their money. This increases your customer’s balance which needs to be paid in the future but has no impact on revenue.
- Opening a paid invoice line item - This refund type will unapply a payment and open the balance of a previously paid invoice line, allowing you to adjust it by the refund amount. This increases your customer’s balance but has no impact on revenue.
Note: When performing refunds in Aria Billing Cloud, the actions are irreversible after they are performed. In the UI, confirmation screens will appear before actions can be completed and warn you that the action is permanent.
The following APIs can be used in support of this API:
- get_refundable_payments_m: This retrieves a list of refundable payments.
- get_reversible_invs_by_payments_m: This retrieves details of a specific refundable payment.
| API Specification: | issue_refund_to_acct_m |
| Required Fields: |
|
Additional Guidance
- If you use the NETS payment processor, "Enable Refund for NETS Payment" must be set to "True" in the UI before you use this API, or you receive the error message "The payment processor does not support refunds".
- You cannot perform a refund-reversal on an invoice with usage that is taxed per-record.
- Aria now provides the ability to reverse $0 charge lines on an invoice and reverse the respective tax if it exists through this API.
Note: This is a change in behavior for refund reversals. Previously, if $0 invoice charge lines were not provided in the API/UI request, a $0.5 tax credit for the charge would still be issued. Now, users must provide the $0 charge line in the API/UI request to get the tax credit for these line items.
Input Fields
| Field Name | Notes | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| <invoice_trans_to_reverse> | If sending multiple line items, you must send the line items in ascending order using the invoice_line_no field in the invoice_trans_to_reverse array for the tax line items to be calculated correctly. | ||||||||||||||||||
| <reason_code> |
Allowable Values
|
||||||||||||||||||
| <do_write> |
Allowable Values
|
||||||||||||||||||
| <auto_calc_refund> |
Allowable Values
|
||||||||||||||||||
| <is_unlinked_refund> |
Allowable Values
|
||||||||||||||||||
| <refund_payment_ind> |
Allowable Values
|
||||||||||||||||||
| <open_line_item_action> |
Allowable Values
|
||||||||||||||||||
| <apply_refunded_payment_on_refund_trans> |
This parameter is added to control the existing behaviour of payment application to the refund transaction such that the refund amount should be applied to the specific payment against which the refund is created instead of FIFO application. This parameter is not honoured when refund with opening of paid lines is performed. Allowable Values
|
||||||||||||||||||
| <open_paid_line_items> |
For the <invoice_line_open_amount> field of this array, the value entered is considered as tax inclusive. For example, if $110 is entered for a tax of 10%, Aria will split this into a $100 charge and $10 tax. |
||||||||||||||||||
| <refund_payment_ind> |
The refund payment method Allowable Values
|
Output Fields
| Field Name | Notes | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| <open_paid_line_item_list> |
Output Values
|
Error Codes
| Error Code/Description | Associated Inputs |
|---|---|
| <auth_key>, <client_no> | |
| <acct_no, <client_acct_id | |
| <application_date>, <invoice_line_reversing_date> | |
| <do_write>, <auto_calc_refund>, <is_unlinked_refund> | |
| <payment_transaction_id> | |
| <payment_transaction_id> | |
| <invoice_no>, <invoice_line_no>, <invoice_line_reversing_amount> | |
| <total_refund_amount> | |
| <invoice_no>, <invoice_line_no> | |
| <invoice_no>, <invoice_line_no> | |
| <refund_check_number> | |
| <refund_check_number> | |
|
|
<total_refund_amount> |
| <total_refund_amount>, <invoice_line_reversing_amount>, <open_amount> | |
| <invoice_line_reversing_date> | |
| <total_refund_amount>, <do_write>, <auto_calc_refund> | |
| <reason_cd> | |
| <cc_number>, <alt_pay_method> | |
| <alt_pay_method>, <cc_number>, <cc_expire_mm>, <cc_expire_yyyy> | |
| <alt_pay_method> | |
| <auth_key>, <client_acct_id>, <refund_check_number>, <comments>, <do_write>, <auto_calc_refund>, <invoice_line_reversing_date>, <client_receipt_id>, <is_unlinked_refund>, <cc_number>, <cvv>, <bill_first_name, <bill_last_name, <bill_company_name, <bill_address1, <bill_address2>, <bill_address3>, <bill_city>, <bill_locality>, <bill_country>, <bill_state_prov>, <bill_zip>, <bill_phone>, <bill_cell_phone>, <bill_work_phone>, <bill_email>, <soft_descriptor>, <soft_descriptor_customer_service>, <application_id>, <application_date>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value> |