Home > Aria6 User Documentation > Aria6 core api > get_all_acct_contracts

get_all_acct_contracts

Returns an array of all status contracts associated with the given account. Also provide option to filter by status

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.
  filter_status_code long 1 The filter_status_code is the Aria code used to filter account contract for Inactive or Active (0 or 1).
  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.
all_acct_contracts hash  
brd_arrow.gif contract_no long Aria-assigned unique contract identifier.
brd_arrow.gif contract_scope string Specifies the scope of plan subscription coverage enforced by the contract.
brd_arrow.gif type_no long The type of contract end action to be enforced by this contract.
brd_arrow.gif length_months long The number of months, starting from start_date, that the given contract will be in effect.
brd_arrow.gif cancel_fee double Fee to be charged against the account if the plan is canceled by the account holder.
brd_arrow.gif create_comments string CSR or API-provided comments provided at time of contract creation.
brd_arrow.gif update_comments string Comments provided at time of last contract update.
brd_arrow.gif create_date string The date the contract was created.
brd_arrow.gif update_date string The date the contract was last modified.
brd_arrow.gif start_date string Specifies contract start date. The date is in the format yyyy-mm-dd.
brd_arrow.gif end_date string Contract end date.
brd_arrow.gif status_code long Status code of this contract. 

Allowable values for status_code

Values Description
-3 Contract no longer in scope, usually due to mid-contract plan change on account.
-2 Terminated. Contract cancelled by client or system.
-1 Cancelled. Contract cancelled by end user.
0 Contract completed and renewed. New contract record refers to this contract record.
1 In Effect. Contract is currently active.
99 Completed. Contract is completed, no renewal.
brd_arrow.gif plan_no long The list of all plan_no currently in effect for the given account.
brd_arrow.gif client_plan_id string Client-defined Plan ID for which to query available child plans
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.).
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®