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.
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. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
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 | |
![]() |
long | The Aria-generated transaction ID for this refund. DEPRECATED |
![]() |
long | The Aria-generated transaction ID for this refund. |
![]() |
double | The monetary amount of the refund. |
![]() |
string | The date the refund was created. |
![]() |
string | The user responsible for creating the refund. |
![]() |
long | The refund reason code. Allowable Values |
![]() |
string | The human-readable refund reason name. |
![]() |
string | The human-readable refund reason description. |
![]() |
long | Transaction ID for the refund payment. |
![]() |
long | The type of the refund payment transaction. |
![]() |
string | Description of the refund payment transaction. |
![]() |
double | The monetary amount of the refund. |
![]() |
string | The monetary amount of the refund. |
![]() |
long | The Aria-assigned bill sequence number. |
![]() |
long | The method of payment originally used. Allowable Values |
![]() |
string | The human-readable name of this payment method |
![]() |
long | A numeric code indicating the type of credit card. Allowable Values |
![]() |
string | The type of credit card used for the original payment. |
![]() |
string | For electronic payment transactions only, the last 4 digits of the account (e.g. the last 4 digits if the credit card used). |
![]() |
string | Client's check number for the refund. |
![]() |
long | Indicates if the refund has been voided (true) or applied (false). Allowable Values |
![]() |
string | Email of the billing contact. |
![]() |
hash | |
![]() |
long | The Aria-assigned unique identifier of a given invoice. |
![]() |
string | The date the invoice was originally billed. |
![]() |
long | The line number containing a reversal for this refund. |
![]() |
double | The total invoice line item value that was originally billed. |
![]() |
double | The amount refunded for this specific line item. |
![]() |
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. |
![]() |
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. |
![]() |
string | Id of the specific invoice transaction that was reversed |
![]() |
string | Date and time of the reversal |
![]() |
string | Service number of the invoice transaction |
![]() |
string | Client-defined service ID for the invoice transaction_amount |
![]() |
string | Comments, if any, on the original invoice transaction |