get_acct_installment_m Sample Call and Response
This example retrieves the installment term details for all active installment plans on an account, based on the get_acct_installment_m method as defined in plsql_m_r73.yml.
This example includes every required field and a representative subset of the optional response fields for two installment plans, not every field this method can return.
Sample call
{
"rest_call": "get_acct_installment_m",
"output_format": "json",
"client_no": 68219,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 5004123,
"include_all_installment_statuses": "false"
}
The rest_call and output_format fields are envelope fields that the REST layer adds; they do not appear in the method's own arguments list. Unlike most methods in this batch, auth_key is explicitly required for this method, so it is included even though the shared param_defaults definition marks it optional. The account is identified with acct_no, the Aria-assigned numeric identifier, instead of its alternative, client_acct_id. The include_all_installment_statuses value of “false” requests only active installment plans; setting it to “true” would also return completed, cancelled, and discontinued plans. This example omits installment_no, an optional argument that would narrow the results to a single installment schedule instead of returning all of the account's active plans.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"error_details": [],
"installment_balance": 4200.00,
"installment_past_due": 350.00,
"installment_term_details": [
{
"installment_no": 88213,
"installment_term_no": 42,
"client_installment_term_id": "TERM-12MO-STD",
"installment_term_name": "Standard 12-Month Plan",
"installment_description": "Twelve-month installment plan for annual subscription purchases.",
"aligned_installment": "Y",
"term_type": "M",
"term_length": 12,
"installment_term_interval": 1,
"installment_schedule_status": "Active",
"invoice_no": 771029,
"invoice_date": "2026-01-15",
"create_date": "2026-01-15",
"paid_to_date": 2100.00,
"remaining_balance": 3500.00,
"past_due": 350.00,
"charge_amount": 350.00,
"tax_amount": 28.00,
"total_amount": 378.00,
"order_no": 990512,
"billing_group_no": 601,
"client_billing_group_id": "BG-001",
"master_plan_instance_no": 990015,
"client_master_plan_instance_id": "MPI-990015",
"installment_schedule_details": [
{
"notify_date": "2026-06-10",
"notify_id": 550021,
"due_date": "2026-06-15",
"due_amount": 350.00,
"paid_amount_to_date": 0.00,
"remaining_installment_balance": 350.00,
"installment_status": "Not Paid"
},
{
"notify_date": "2026-07-10",
"notify_id": 550022,
"due_date": "2026-07-15",
"due_amount": 350.00,
"paid_amount_to_date": 0.00,
"remaining_installment_balance": 350.00,
"installment_status": "Not Paid"
}
]
},
{
"installment_no": 88250,
"installment_term_no": 45,
"client_installment_term_id": "TERM-6MO-PROMO",
"installment_term_name": "Promotional 6-Month Plan",
"installment_description": "Six-month installment plan offered on promotional hardware bundles.",
"aligned_installment": "N",
"term_type": "M",
"term_length": 6,
"days_to_start": 0,
"days_til_due": 10,
"installment_schedule_status": "Active",
"invoice_no": 771050,
"invoice_date": "2026-05-01",
"create_date": "2026-05-01",
"paid_to_date": 200.00,
"remaining_balance": 700.00,
"past_due": 0.00,
"charge_amount": 150.00,
"tax_amount": 12.00,
"total_amount": 162.00,
"order_no": 990600,
"billing_group_no": 601,
"client_billing_group_id": "BG-001"
}
]
}
An error_code of zero and an error_msg of “OK” indicate that Aria found the account and returned its installment plans successfully. The installment_term_details array shows two entries here, but an account with more installment plans would return additional entries in the same array. The first entry has aligned_installment set to “Y”, meaning its due dates follow the associated master plan instance's anniversary invoice dates, which is why it also reports a master_plan_instance_no and includes a nested installment_schedule_details array showing two individual scheduled installments. The second entry has aligned_installment set to “N”, meaning it follows its own independent schedule based on days_to_start and days_til_due instead, and this example omits its installment_schedule_details for brevity. A term_type of “M” means the term length and interval are expressed in months; the method also accepts “W” for weeks and “D” for days. This example leaves out the lump-sum fields (lump_sum_type, lump_sum_amount, aligned_lump_sum, lump_sum_days, lump_sum_days_until_due), the surcharge fields (surcharge_amount, surcharge_tax_amount, invoice_line_total_amount), status_change_date, comments, previous_installment_no_list, and the detailed principal and surcharge breakdown fields on installment_schedule_details (statement_no, installment_principal_due, installment_principal_tax_due, installment_surcharge_due, installment_surcharge_tax_due), since none of them are needed to tell this example's story.