Home > Aria Crescendo Documentation > Aria Crescendo core api > get_refund_details_m
get_refund_details_m
get_refund_details_m
Returns refund information, including invoice reversals, for a specified account.
For a list of error messages generated by this API, see get_refund_details_m Error Messages.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
|
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| include_voided | string | 5 | Include voided invoices in the search results. Allowable Values | |
| aria_event_no | long | 22 | Aria Event number of the writeoff event | |
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
| refund_details | hash | |
| refund_transaction_id |
long | The Aria-generated transaction ID for this refund. DEPRECATED |
| refund_transaction_id_2 |
long | The Aria-generated transaction ID for this refund. |
| refund_amount |
double | The monetary amount of the refund. |
| create_date |
string | The date the refund was created. |
| create_user |
string | The user responsible for creating the refund. |
| reason_code |
long | The refund reason code. Allowable Values |
| reason_label |
string | The human-readable refund reason name. |
| reason_description |
string | The human-readable refund reason description. |
| ref_payment_transaction_id |
long | Transaction ID for the refund payment. |
| ref_payment_transaction_type |
long | The type of the refund payment transaction. |
| ref_payment_transaction_desc |
string | Description of the refund payment transaction. |
| ref_payment_amount |
double | The monetary amount of the refund. |
| ref_payment_ref_code |
string | The monetary amount of the refund. |
| bill_seq_no |
long | The Aria-assigned bill sequence number. |
| pay_method_id |
long | The method of payment originally used. Allowable Values |
| pay_method_name |
string | The human-readable name of this payment method |
| cc_id |
long | A numeric code indicating the type of credit card. Allowable Values |
| cc_type |
string | The type of credit card used for the original payment. |
| payment_src_suffix |
string | For electronic payment transactions only, the last 4 digits of the account (e.g. the last 4 digits if the credit card used). |
| refund_check_num |
string | Client's check number for the refund. |
| is_voided_ind |
long | Indicates if the refund has been voided (true) or applied (false). Allowable Values |
| bill_email |
string | Email of the billing contact. |
| invoice_reversals |
hash | |
| invoice_no |
long | The Aria-assigned unique identifier of a given invoice. |
| invoice_bill_date |
string | The date the invoice was originally billed. |
| invoice_line_no |
long | The line number containing a reversal for this refund. |
| total_line_debit |
double | The total invoice line item value that was originally billed. |
| reversed_line_amount |
double | The amount refunded for this specific line item. |
| reversed_line_start_date |
string | The effective start date of the original line item that is written off if it was a recurring fee service. The date is in the format yyyy-mm-dd. |
| reversed_line_end_date |
string | The effective end date of the original line item that is written off if it was a recurring fee service. The date is in the format yyyy-mm-dd. |
| transaction_id |
string | Id of the specific invoice transaction that was reversed |
| reversal_date |
string | Date and time of the reversal |
| service_no |
string | Service number of the invoice transaction |
| client_service_id |
string | Client-defined service ID for the invoice transaction_amount |
| transaction_comments |
string | Comments, if any, on the original invoice transaction |
- © Copyright 2022 Aria Developer Central