update_acct_plan_unit_instance_m Sample Call and Response
This example shows a call that updates fulfillment information or supplemental fields on a plan unit instance, based on the update_acct_plan_unit_instance_m method defined in plsql_m_r73.yml.
The example marks a fulfillment-based service on the unit instance as completed immediately and records a custom field value (an asset tag) on that unit instance. It does not cover removing a fulfillment date, scheduling fulfillment for a future date, or the proration invoice timing override.
Sample call
{
"rest_call": "update_acct_plan_unit_instance_m",
"output_format": "json",
"client_no": 1073,
"auth_key": "b19b2b3a4c5d6e7f8091a2b3c4d5e6f7",
"acct_no": 3300521,
"plan_unit_inst_no": 771234,
"plan_unit_instance_services": [
{
"service_no": 20456,
"service_fulfillment_date": "2026-07-24",
"fulfillment_directive": 1
}
],
"plan_unit_inst_fields": [
{
"field_name": "asset_tag",
"field_value": "AT-99231",
"plan_unit_inst_directive": 1
}
]
}
rest_call and output_format are envelope fields added by the REST layer. acct_no is one side of an alternative pair with client_acct_id, and plan_unit_inst_no is one side of an alternative pair with client_plan_unit_inst_id; this example uses the Aria-assigned identifiers for both. plan_unit_instance_services is an array of services on this unit instance whose fulfillment is being managed; fulfillment_directive value one completes fulfillment with immediate effect (the default), while value two requires a future service_fulfillment_date and value three removes a previously assigned fulfillment date. plan_unit_inst_fields is an array of client-defined field name and value pairs; plan_unit_inst_directive value one adds a new field value, value two replaces an existing value, and value three removes a value. Left out of this example: new_client_plan_unit_inst_id, do_write (left at its documented default of true), proration_invoice_timing, and recurring_processing_model_ind.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"out_acct_no": 3300521,
"out_plan_unit_inst_no": 771234,
"proration_result_amount": 0
}
An error_code of zero together with an error_msg of “OK” indicates that Aria applied the fulfillment and field updates successfully. proration_result_amount is zero because completing fulfillment immediately on an already-billed unit instance did not trigger a proration charge; when proration does occur, this field returns a positive currency value representing the resulting charge. Because no proration occurred, no invoice was generated, so invoice_no is left out of this response. Also left out: invoice_line_items, collection_error_code/collection_error_msg, statement_error_code/statement_error_msg, the processor response fields (proc_cvv_response, proc_avs_response, proc_cavv_response, proc_status_code, proc_status_text, proc_payment_id, proc_auth_code, proc_merch_comments), the invoice total fields (total_charges_before_tax, total_tax_charges, total_charges_after_tax, total_credit, total_tax_credit, total_credit_before_tax, total), expectd_monthly_rec_cost, expectd_annual_rec_cost, third_party_errors, and proc_payment_response_field_list.