get_acct_statement_all_m Sample Call and Response
This example retrieves every statement recorded against a specific master plan instance (subscription) on an account, without restricting the results to any single statement, invoice, or billing period. It is based on the get_acct_statement_all_m method definition in plsql_m_r73.yml.
This example includes every required field, plus master_plan_instance_id to scope the results to one subscription. It leaves out statement_no, invoice_no, acct_statement_seq_str, and second_acct_statement_seq_str, since this example retrieves every statement for the subscription rather than one specific statement.
Sample call
{
"rest_call": "get_acct_statement_all_m",
"output_format": "json",
"client_no": 6423,
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"acct_no": 6621789,
"master_plan_instance_id": 500213
}
The acct_no field identifies the account, using the Aria-assigned numeric identifier rather than its alternative, client_acct_id. Note that the field used to scope the request to one subscription is named master_plan_instance_id in this method, unlike most other Core API methods, which name the equivalent field master_plan_instance_no; its alternative here is client_master_plan_instance_id. This example omits statement_no, invoice_no, acct_statement_seq_str, and second_acct_statement_seq_str, which form an alternative group used to retrieve one specific statement; leaving all four null, as this example does, returns every statement associated with the account or, as here, the specified master plan instance.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"statement_all": [
{
"billing_group_no": 71042,
"client_billing_group_id": "BG-CORE-01",
"payment_method_type": 1,
"primary_payment_method_name": "Visa ending in 4242",
"primary_payment_method_no": 55210,
"client_primary_payment_method_id": "PM-VISA-4242",
"statement_no": 981204,
"acct_statement_seq_str": "INV-2026-0601",
"second_acct_statement_seq_str": "ALT-2026-0601",
"currency_cd": "usd",
"invoice_no": 774401,
"due_date": "2026-06-16",
"due_date_plus_grace_period": "2026-06-21",
"bill_date": "2026-06-01",
"recurring_bill_from_date": "2026-06-01",
"recurring_bill_thru_date": "2026-06-30",
"paid_date": "2026-06-14",
"invoice_due_amount": 224.10,
"invoice_amount": 224.10,
"invoice_due_balance": 0.00,
"balance_forward": 0.00,
"statement_balance_forward": 0.00,
"statement_installment_due": 0.00,
"statement_total_due": 0.00,
"custom_filename": "acme-statement-2026-06.pdf"
},
{
"billing_group_no": 71042,
"client_billing_group_id": "BG-CORE-01",
"payment_method_type": 1,
"primary_payment_method_name": "Visa ending in 4242",
"primary_payment_method_no": 55210,
"client_primary_payment_method_id": "PM-VISA-4242",
"statement_no": 981350,
"acct_statement_seq_str": "INV-2026-0701",
"currency_cd": "usd",
"invoice_no": 775102,
"due_date": "2026-07-16",
"due_date_plus_grace_period": "2026-07-21",
"bill_date": "2026-07-01",
"recurring_bill_from_date": "2026-07-01",
"recurring_bill_thru_date": "2026-07-31",
"invoice_due_amount": 224.10,
"invoice_amount": 224.10,
"invoice_due_balance": 224.10,
"balance_forward": 0.00,
"statement_balance_forward": 0.00,
"statement_installment_due": 0.00,
"statement_total_due": 224.10
}
]
}
An error_code value of zero and an error_msg value of "OK" together indicate that Aria retrieved the statements successfully. The statement_all array shows two statements for illustration, a paid June statement and an unpaid July statement still within its grace period; an account with a longer billing history would return additional entries, one for each statement recorded, not necessarily just two. The second statement omits paid_date, since it has not yet been paid, and omits custom_filename, since no custom filename was set for it; both fields are optional and only appear when applicable. This example leaves out the secondary_payment_method fields, client_payment_term_id, payment_terms_name, payment_terms_no, and payment_terms_type, since this billing group pays by credit card rather than payment terms; it also leaves out usage_bill_from_date and usage_bill_thru_date, since this subscription has no usage-based charges, and installment_on_statement_details, statement_payment_plan_due, and payment_plan_on_statement_details, since neither statement includes an active installment or payment plan.