get_refundable_payments_m
Summary
| API Name | get_refundable_payments_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 19 |
Description
Returns an array of payment transactions for a a given acct_no or master plan instance that are considered refundable.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||
| master_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. Alternative field: client_master_plan_instance_id |
||||||
| client_master_plan_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. Alternative field: master_plan_instance_no |
||||||
| include_unapplied_payments | long | 1 | No |
Determines whether or not unapplied payment summary is included in the return. Default is 0. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| refundable_payments | object | No | ||
| unapplied_payment_summary | double | No |
Total sum of unapplied payments for a given account. |
refundable_payments fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| payment_transaction_id | long | No |
The transaction this payment applies to |
|
| payment_date | string | No |
The date of the payment |
|
| payment_description | string | No |
The description of the payment |
|
| payment_amount | double | No |
The amount of the payment |
|
| payment_refunded_amount | double | No |
If any refunds have been booked against this payment, the sum of all refunds |
|
| payment_refundable_amount | double | No |
The amount of this payment remaining to be refunded |