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 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 |
|
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 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 |
|
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 for cc_id:
Values |
Description |
1 |
Visa |
2 |
MasterCard |
3 |
American Express |
4 |
Discover |
5 |
Diners Club/Carte Blanche |
6 |
Maestro |
7 |
JCB |
8 |
Laser |
9 |
Dankoort |
|
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 for is_voided_ind:
Values |
Description |
0 |
false |
1 |
true |
|
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 |
open_paid_line_item_list |
hash |
|
open_invoice_no |
long |
Invoice number that's open with a refund. Required if invoice_line_no is used. For balance transfer, this will display child invoice number. |
open_invoice_bill_date |
long |
Date the invoice originally billed. For balance transfer, this will display date of child invoice or balance transfer. |
open_invoice_line_no |
long |
The line number open with this refund. For balance transfer, no line number will be displayed. |
open_total_line_debit |
long |
The total invoice line item value that was originally billed. For balance transfer, this is the total amount of balance transfer. |
open_amount |
double |
The amount refunded and open for this specific line item or transaction. |
open_date |
string |
Date and time when paid transaction becomes open. |
open_transaction_id |
long |
ID of the specific transaction to open. |
service_no |
long |
Service number of the invoice transaction. For balance transfer, service_no won't be populated. |
client_service_id |
string |
Client defined service ID for the invoice transaction_amount. For balance transfer, client_service_id will not be populated. |