Home > Aria6 User Documentation > Aria6 core api > create_acct_multiplan_contract


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

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png length_months long 8 Number of months, starting from start_date, that the given contract will be in effect.
  end_date string   End date of the date range covered by this line item in yyyy-mm-dd format.
required-icon.png brd_arrow.gifplan_no long array 22 Unique plan identifier.
  brd_arrow.gifclient_plan_id string array 100 The array of unique client-defined Plan Identifier
  type_no long 8 The type of contract end action to be enforced by this contract.  

Allowable values for type_no:

  create_comments string 300 CSR or API-provided comments provided at time of contract creation.
  start_date string 14 Contract start date in yyyy-mm-dd format. Defaults to the current date if not specified. This field is required for a plan or contract with a future start date.
  do_auto_discard string 5 Whether, upon creation of this contract, the system automatically discards any existing contracts in effect that cover the same plan or set of plans.  

Allowable values for do_auto_discard:

  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
contract_no long Aria-assigned unique contract identifier
Last modified


This page has no custom tags.


This page has no classifications.