Home > Aria6 User Documentation > Aria6 core api > get_acct_plan_contract

get_acct_plan_contract

Returns any single-plan contract currently associated with a specified account and 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.
  plan_no long 22 The unique plan identifier.
  OR      
  client_plan_id string 100 Client-defined Plan ID for which to query available child plans
  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.
acct_plan_contract hash  
brd_arrow.gif contract_no long Aria-assigned unique contract identifier
brd_arrow.gif 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
brd_arrow.gif length_months long Contract length in months
brd_arrow.gif cancel_fee double Contract early cancellation fee.
brd_arrow.gif create_comments string Comments added when the contract was created.
brd_arrow.gif update_comments string Comments added when the contract was last updated.
brd_arrow.gif create_date string Date the contract was created
brd_arrow.gif update_date string Date the contract was last updated
brd_arrow.gif start_date string Start date of the contract
brd_arrow.gif end_date string Contract end date
brd_arrow.gif status_code long Current contract status by status code. 

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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®