Summary

API Name	get_acct_plan_balance_m
Class	account_services_m
Update Version	57

Description

This API is used to retrieve both the balance due for a specified master plan instance, and the total balance due on an 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

plan_instance_no

long

22

Yes

The unique identifier of the master plan instance.

Alternative required field: client_plan_instance_id

client_plan_instance_id

string

100

Yes

The client-defined identifier of the master plan instance.

Alternative required field: plan_instance_no

client_acct_id

string

50

Yes

Client-defined account identifier.

Alternative required field: acct_no

current_balance_and_transfer_calc

long

1

No

Allows client to specify current balance due, current balance transfer unpaid based on the payment type belonging to a statement.

Allowed values:

Value	Description
0	Default. (NULL is treated as 0) - for backward compatibility. The current balance due amount and current balance transfer unpaid are considered due from the start of the due date independent of statement level payment type.
1	'The current balance due amount and current balance transfer unpaid are considered due depending on the statement level payment type. If statement payment type is "Payment Terms", these are due at the end of the due date (i.e. next day of due date). If the statement payment type is not "Payment Terms", these are due at the start of the due date.'

Outputs

Name	Type	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.
currency_cd	string	No	The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
current_balance_due	string	No	The current balance due on the master plan instance.
total_balance_due	string	No	The total balance due on the master plan instance.
current_balance_transfer_unpaid	double	No	The current balance of master plan that has been transferred to a responsible payment Master Plan Instance but has yet to be successfully paid.
total_balance_transfer_unpaid	double	No	The total balance of master plan that has been transferred to a responsible payment Master Plan Instance but has yet to be successfully paid.