Skip to main content
Aria Knowledge Central

modify_instance_contract_m Guide

It modifies an existing multi plan instance contract for a specified account holder and one or more plan instances.

API Specification: modify_instance_contract_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <contract_no> or <client_contract_id>

Additional Guidance

Input Fields
Field Name Notes
<type_no>
Allowable Values
Values Description
2 Continue existing service without contract (default)
3 Renew existing contract automatically
6 Terminate service and billing
7 Terminate service and billing and prorate final invoice
8 Rollover to a different plan/rate/custom rates (applicable only for multi-plan contracts).
<modify_directive>
Allowable Values
Values Description
1 Add plan instance
2 Remove plan instance
3 Add rollover plan for the plan instance
4 Remove the rollover plan for the plan instance
5 Modify the rollover plan for the plan instance
<cascade_action>
Allowable Values
Values Description
true true
false false

Error Codes

Error Code/Description Associated Inputs
 
<client_no>, <auth_key>
<acct_no>, <client_acct_id>

<client_no>, <auth_key>, <acct_no> or <client_acct_id>, <contract_no> or <client_contract_id>

<client_no>, <acct_no>, <contract_no>, <type_no>, <length_months>, <cancel_fee>, <modify_directive>, <plan_instance_no>, <rollover_plan_no>, <rollover_rate_sched_no>, <custom_rate_plan_instance_no>, <custom_rate_service_no>, <custom_rate_seq_no>, <custom_rate_from_unit>, <custom_rate_to_unit>, <custom_rate_per_unit> 
<cascade_action>
<custom_rate_service_no>, <custom_rate_client_service_id>
<custom_rate_to_unit>, <custom_rate_seq_no>
<custom_rate_from_unit>, <custom_rate_to_unit>
<custom_rate_to_unit>
<client_plan_instance_id>, <custom_rate_client_plan_instance_id>
<custom_rate_client_service_id>
<rollover_client_rate_sched_id>
<custom_rate_from_unit>, <custom_rate_to_unit>
<plan_instance_no>, <client_plan_instance_id>, <custom_rate_plan_instance_no>, <custom_rate_client_plan_instance_id>
<client_plan_instance_id>, <custom_rate_client_plan_instance_id>
<custom_rate_plan_instance_no>, <custom_rate_client_plan_instance_id>
<cascade_action>, <modify_directive>, <contract_plan_instances_update>
<cascade_action>, <modify_directive>, <contract_plan_instances_update>
<cascade_action>, <modify_directive>, <contract_plan_instances_update>
<custom_rate_service_no>
<contract_no>, <client_contract_id>
<modify_directive>
<end_date>
<contract_no>, <client_contract_id>
<end_date>
<type_no>
<plan_instance_no>, <client_plan_instance_id>
<plan_instance_no>, <client_plan_instance_id>
<modify_directive>
<plan_instance_no>, <client_plan_instance_id>
<rollover_plan_no>, <rollover_client_plan_id>
<rollover_rate_sched_no>, <rollover_client_rate_sched_id>
<rollover_rate_sched_no>, <rollover_client_rate_sched_id>
<rollover_rate_sched_no>, <rollover_client_rate_sched_id>
<rollover_plan_no>, <rollover_client_plan_id>
<rollover_plan_no>, <rollover_client_plan_id>
<start_date>
<client_contract_id>, <new_client_contract_id>
 
<auth_key>, <client_acct_id>, <client_contract_id>, <new_client_contract_id>, <update_comments>, <start_date>, <end_date>, <cascade_action>, <client_plan_instance_id>, <rollover_client_plan_id>, <rollover_client_rate_sched_id
custom_rate_client_plan_instance_id>, <custom_rate_client_service_id>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value>
  • Was this article helpful?