Home > Aria6 User Documentation > Aria6 core api > get_refund_details


Returns refund information, including invoice reversals, for a specified account.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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 for include_voided

Values Description
true true
false false
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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  
brd_arrow.gif refund_transaction_id long The Aria-generated transaction ID for this refund
brd_arrow.gif refund_amount double The monetary amount of the refund.
brd_arrow.gif create_date string The date the refund was created.
brd_arrow.gif create_user string The user responsible for creating the refund.
brd_arrow.gif reason_code long The refund reason code. 

Allowable values for reason_code

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
brd_arrow.gif reason_label string The human-readable refund reason name.
brd_arrow.gif reason_description string The human-readable refund reason description.
brd_arrow.gif ref_payment_transaction_id long Transaction ID for the refund payment.
brd_arrow.gif ref_payment_transaction_type long The type of the refund payment transaction.
brd_arrow.gif ref_payment_transaction_desc string Description of the refund payment transaction.
brd_arrow.gif ref_payment_amount double The monetary amount of the refund.
brd_arrow.gif ref_payment_ref_code string The monetary amount of the refund.
brd_arrow.gif bill_seq_no long The Aria-assigned bill sequence number.
brd_arrow.gif pay_method_id long The method of payment originally used. 

Allowable values for pay_method_id

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
brd_arrow.gif pay_method_name string The human-readable name of this payment method
brd_arrow.gif cc_id long A numeric code indicating the type of credit card. 

Allowable values for cc_id

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
8 Laser
9 Dankoort
brd_arrow.gif cc_type string The type of credit card used for the original payment.
brd_arrow.gif 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).
brd_arrow.gif refund_check_num string Client's check number for the refund.
brd_arrow.gif is_voided_ind long Indicates if the refund has been voided (true) or applied (false). 

Allowable values for is_voided_ind

Values Description
0 false
1 true
brd_arrow.gif bill_email string Email of the billing contact.
brd_arrow.gif invoice_reversals hash  
brd_arrow.gif invoice_no long The unique identifier of a given invoice.
brd_arrow.gif invoice_bill_date string The date the invoice was originally billed.
brd_arrow.gif invoice_line_no long The line number containing a reversal for this refund.
brd_arrow.gif total_line_debit double The total invoice line item value that was originally billed.
brd_arrow.gif reversed_line_amount double The amount refunded for this specific line item.
brd_arrow.gif 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.
brd_arrow.gif 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.
brd_arrow.gif transaction_id string Deprecated Id of the specific invoice transaction that was reversed
brd_arrow.gif reversal_date string Deprecated Date and time of the reversal
brd_arrow.gif service_no string Deprecated Service number of the invoice transaction
brd_arrow.gif client_service_id string Deprecated Client defined service ID for the invoice transaction_amount
brd_arrow.gif transaction_comments string Deprecated Comments, if any, on the original invoice transaction
Last modified


This page has no custom tags.


This page has no classifications.