Home > Aria6 User Documentation > Aria6 core api > get_acct_multiplan_contract

get_acct_multiplan_contract

Returns any multi-plan contract currently associated with a specified account.

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 contract_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  exclude_terminated_plans string 300 This indicator determines if terminated plans should be excluded from the return. If True is passed, the API shall exclude (not return) any plans that have a status of Terminated.  

Allowable values for exclude_terminated_plans:

Values Description
false false
true true
  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.
 

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.
type_no long The 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
3 Renew existing contract automatically
4 Continue service without contract w/standard rates
5 Suspend service and billing - prorate final invoice
length_months long The number of months, starting from start_date, that the given contract will be in effect.
create_comments string CSR or API-provided comments provided at time of contract creation.
update_comments string Comments provided at time of last contract update.
create_date string The date the contract was created.
update_date string The date the contract was last modified.
start_date string Specifies contract start date. The date is in the format yyyy-mm-dd
end_date string Contract end date
status_code string Status code of this contract. 

Allowable values for status_code:

Values Description
1 Contract is currently in effect.
-1 Contract cancelled by end-user.
-2 Contract terminated by client or system.
0 Contract completed and renewed. New contract record refers to this contract record.
99 Contract completed, no renewal.
-3 Contract no longer in scope, usually due to mid-contract plan change on account.
plan_no hash Aria-assigned plan identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif plan_no long The unique plan identifier.
brd_arrow.gif plan_status_cd long The status code of the supplemental plan associated with this account. 

Allowable values for plan_status_cd:

Values Description
1 Active
2 Active Pending
3 Terminate Pending
-1 Terminated
brd_arrow.gif plan_status_label string This is the status for each plan associated with the contract. (ex: Active, Terminated etc.).
plan_name hash Plan Name
brd_arrow.gif plan_name string The client-assigned name for this plan.
client_plan_id hash Client-defined Plan ID for which to query available child plans
brd_arrow.gif client_plan_id string Client-defined Plan ID for which to query available child plans
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®