Skip to main content
Aria Knowledge Central

update_acct_installment_m Sample Call and Response

This example shows a client updating the terms of an existing installment schedule on an account, based on the update_acct_installment_m method defined in plsql_m_r73.yml.

This example covers updating the installment amount, term type, days until due, and last-installment threshold for an existing installment schedule, effective on a future date. It does not cover every optional installment field, such as lump sum handling, which this example leaves unchanged.

Sample call

{
    "rest_call": "update_acct_installment_m",
    "output_format": "json",
    "client_no": 4471,
    "auth_key": "b92f6e1c8a3d4f0e9b7c2a1d5e6f8091",
    "acct_no": 100381,
    "installment_no": 44092,
    "effective_date": "2026-08-01",
    "installment_amount": 125.00,
    "installment_term_type": "M",
    "installment_days_until_due": 10,
    "installment_comments": "Adjusting installment amount per customer request to spread the remaining balance over fewer months.",
    "last_installment_amount_threshold": 10,
    "do_write": true
}

The rest_call and output_format fields form the envelope added by the REST layer; they are not part of the method's own argument list in the yml. This example identifies the account using acct_no rather than the alternative client_acct_id. The installment_amount field is used here rather than the alternative installment_term_length; when installment_amount is supplied, Aria ignores installment_term_length. The installment_term_type field is set to "M" for months. The last_installment_amount_threshold of ten means Aria may add up to ten percent to the final installment rather than creating a very small trailing installment. The optional do_write field is set to true so Aria actually performs the update rather than only calculating its effects.

Sample response

{
    "error_code": 0,
    "error_msg": "OK",
    "error_details": [],
    "installment_schedule_info": [
        {
            "installment_no": 44092,
            "seq_no": 3,
            "notify_date": "2026-08-01",
            "due_date": "2026-08-11",
            "due_amount": 125.00
        }
    ]
}

An error_code of zero with an error_msg of "OK" indicates the installment update succeeded. Because the update changed the installment amount, Aria created a new installment schedule; the installment_schedule_info array lists each individual installment in that schedule, and this example shows only one representative entry. A full schedule would return one entry per remaining installment, each with its own seq_no, notify_date, due_date, and due_amount. The error_details array is left empty because no errors occurred.

TOP
  • Was this article helpful?