Summary

API Name	get_acct_statement_history_m
Class	account_services_m
Update Version	41

Description

Returns the list of all statements in a given billing period on an account for all the master plan instances or on a specific master plan instance on the 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: user_id or client_acct_id

user_id

string

32

Yes

Account's user ID. Alternative to using acct_no.

Alternative required field: acct_no or client_acct_id

client_acct_id

string

50

Yes

Client-defined account identifier.

Alternative required field: acct_no or user_id

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

start_date

string

10

No

Specifies start date. The date is in the format yyyy-mm-dd

end_date

string

10

No

Specifies end date. The date is in the format yyyy-mm-dd

include_invoice_activity_eligibility

string

5

No

Specifies whether the statement is eligible to send or not

Allowed values:

Value	Description
True	Checks the eligibility to send email.
False	Does not check the eligibility to send email.
null	If NULL, defaults to false.

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.
statements_history	object	No	See fields below

statements_history.statement_master_plan_instances fields

Name	Type	Length	Required	Description
master_plan_instance_no	long	22	No	The Master Subscription plan instance number.
client_master_plan_instance_id	string	100	No	Client-defined Master plan Subscription plan instance ID.

statements_history fields

Name

Type

Length

Required

Description

statement_no

long

No

The unique statement number that is sequenced across all statements (not limited to xml only).

create_date

string

No

The date the account record was created.

currency_cd

string

No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.

due_date

string

No

The date monies are due.

due_date_plus_grace_period

string

No

The date monies are due calculated to include any grace period.

new_charges_amount

double

No

The monetary amount of new charges detailed in the statement.

new_payments_amount

double

No

The monetary amount of any new payments applied in this statement

balance_forward_amount

double

No

The monetary amount to apply as balance forward.

total_amount

double

No

Total amount of the statement.

is_paid_ind

long

No

A boolean value indicating if the statement has been paid.

Allowed values:

Value	Description
0
1

invoice_activity_ind

long

No

Indicates whether statement can be sent or not.

Allowed values:

Value	Description
0	Statement not eligible to send.
1	Statement eligible to be sent.

seq_statement_id

string

No

The unique sequential statement number

statement_master_plan_instances

object

No

See fields below

invoice_no

long

22

No

The Aria-assigned unique identifier of a given invoice.

unapplied_payment_summary

double

No

Total of unapplied payments for a given account.

account_balance

double

No

Displays the ending account balance at time.

sent_status

string

No

The sent status of the statement.

Allowed values:

Value	Description
Not Sent	Indicates the statement is not sent.
Sent	Indicates the statement is sent.

date_sent

string

No

Indicates the date on which it is sent.

xml_statement_no

long

22

No

The unique xml statement number that is only used for xml statements (that is generated in addition to the regular statement when the "Notification Settings > XML Statement Distillation Option" is enabled for the client).