This API is used to return the balance for a specified master plan on a given account.
For a list of error messages for this API, see get_acct_plan_balance_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. |
OR | ||||
![]() |
client_acct_id | string | 50 | Client-defined account identifier. |
![]() |
plan_instance_no | long | 22 | The unique identifier of the master plan instance. |
OR | ||||
client_plan_instance_id | string | 100 | The client-defined identifier of the master plan instance. | |
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. |
currency_cd | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
current_balance_due | string | The current balance due on the master plan instance. |
total_balance_due | string | The total balance due on the master plan instance. |