Skip to main content
Aria Knowledge Central

create_instance_contract_m Guide

Creates a multi-plan contract for a specified account holder and specified list of plans. The plans can be master plans or supplemental plans.

API Specification:

create_instance_contract_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <type_no>
  • <length_months> or <end_date>
  • <contract_plan_instances> (array)
    • <plan_instance_no>

Additional Guidance

Input Fields
Field Name: Notes:
<rollover_rate_sched_no>

If you have added a custom rate to a standard price for a rate schedule rollover with a multi-Plan contract during a batch execution, the system will remove existing custom rates at the time the batch is executed.

If you wish to go back to standard rates from custom rates for the existing rate schedule via contract, then when creating a contract with create_instance_contract_m, pass "rollover_rate_sched_no" input argument without the "rollover_plan_no" input.

<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)
<do_auto_discard>
Allowable values
Values Description
true true
false false
<cascade_action>
Allowable values 
Values Description
true true
false false

Error Codes

Error Code/Description Associated Inputs
 
<auth_key>, <client_no>
<acct_no>, <client_acct_id>
<custom_rate_per_unit>, <custom_rate_seq_no>, <acct_no>, <client_acct_id>
<custom_rate_service_no/custom_rate_client_service_id>, <plan_instance_no>, <client_plan_instance_id>, <length_months>, <start_date>, <end_date>, <acct_no>
<cascade_action>, <do_auto_discard>
<rollover_plan_no>
<custom_rate_to_unit>, <custom_rate_seq_no>
<custom_rate_from_unit>, <custom_rate_to_unit>
<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>
<client_plan_instance_id>
<custom_rate_plan_instance_no>, <custom_rate_client_plan_instance_id>
<acct_no>, <client_acct_id>
<start_date>, <end_date>, <length_months>
<type_no>
<plan_instance_no>, <client_plan_instance_id>
<rollover_plan_no>
<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>
 
All character field inputs like <create_comments>, etc.
  • Was this article helpful?