Home > Aria6 User Documentation > Aria6 core api > create_acct_plan_contract

create_acct_plan_contract

Creates a single-plan contract for a specified account holder and plan. The plan can be a master plan or a supplemental plan.

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 plan_no long 22 The unique plan identifier.
  OR      
  client_plan_id string 100 Client-defined Plan Identifier
required-icon.png length_months long 8 Number of months (for example in reference to a contract).
  OR      
  end_date string   End date of the date range covered by this line item in yyyy-mm-dd format.
  type_no long 8 Type of contract end action to be enforced by this contract.  

Allowable values for type_no:

Values Description
1 Suspend service and billing
2 Continue existing service without contract (Default)
3 Renew existing contract automatically
4 Continue service without contract with pre-contract rates
5 Suspend service and billing - prorate final invoice
  alt_recur_fee double 12 This amount will be billed each month instead of the current recurring service rate. If there are multiple recurring services related to this plan, the rate associated with the current recurring service that has the lowest service_no will be replaced. This alternate recurring fee will go into effect starting on the new contract's effective date.
  cancel_fee double 12 Fee to be charged against the account if the plan is canceled by the account holder.
  create_comments string 300 Comments about the billing contact during the creation of the billing contact record.
  start_date string 14 Specifies start date. The date is in the format yyyy-mm-dd. 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, on 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:

Values Description
true true
false false
  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 This is the contract number for the account.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®