get_unapplied_credits_payments_m
Summary
| API Name | get_unapplied_credits_payments_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.33 |
Description
Retrieves the payments and cash credits that are unapplied for a given account.
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 |
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. |
|
| Start of unapplied_payments object | ||||
| unapplied_payments | object | No | ||
| Name | Type | Length | Required | Description |
| ▶payment_transaction_id | long | No |
Aria generated ID for the payment transaction |
|
| ▶payment_amount | double | No |
Total amount of the payment |
|
| ▶unapplied_amount | double | No |
Unapplied portion of the payment amount |
|
| ▶cash_credit_transaction_id | long | No |
Aria generated ID for the cash credit transaction |
|
| ▶cash_credit_amount | double | No |
Total amount of the cash credit |
|
| ▶unapplied_cash_credit | double | No |
Unapplied portion of the cash credit |
|
| End of unapplied_payments object | ||||