get_acct_plan_balance_m Guide

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

The get_acct_plan_balance_m API is used to retrieve both the balance due for a specified master plan instance, and the total balance due on an account.

API Specification:	get_acct_plan_balance_m
Required Field:	<client_no> <auth_key> <acct_no> or <client_acct_id> <plan_instance_no or <client_plan_instance_id>
Sample Call and Response:	get_acct_plan_balance_m Sample Call and Response

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error	<auth_key>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)	<acct_no>, <client_acct_id>
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id". Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.	<plan_instance_no>, <client_plan_instance_id>
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".	<client_plan_instance_id>