Home > Aria Crescendo Documentation > Aria Crescendo core api > get_instance_contract_m

get_instance_contract_m

It returns a multi-plan instance 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.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png contract_no long 22 Aria-assigned unique contract identifier.
  OR      
  client_contract_id string 100 Client assigned unique contract identifier..
  locale_no long 22 Specifies the language in which the information is returned.
  OR      
  locale_name string 50 Name of the locale.
  plan_instance_no long   Unique plan instance number for each assigned plan instance.
  OR      
  client_plan_instance_id string 100 Unique client-defined ID for each assigned plan instance.
  include_contract_billing_installment long 1 This parameter is ignored when 'Enable Contract Billing Installment' client parameter is set to false and the API won't return contract billing values. If the client parameter is set to true and this parameter is set to 1, the API will return contract billing values(invoiced_contract_period, invoiced_billing_cycle, remaining_contract_period, and remaining_billing_cycle)in contract_plan_instance_info. 

Allowable values for include_contract_billing_installment

Values Description
0 do not return contract billing values(default)
1 return contract billing values
  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. DEPRECATED

Allowable values for type_no

Values Description
2 Continue existing service without contract (default)
3 Renew existing contract automatically
6 Terminate service and billing
7 Terminate service and billing and prorate final invoice
8 Rollover to a different plan/rate/custom rates (applicable only for multi-plan contracts).
type_no_2 long The type of contract end action to be enforced by this contract. 

Allowable values for type_no_2

Values Description
2 Continue existing service without contract (default)
3 Renew existing contract automatically
6 Terminate service and billing
7 Terminate service and billing and prorate final invoice
8 Rollover to a different plan/rate/custom rates (applicable only for multi-plan contracts).
length_months long The number of months, starting from start_date, that the given contract will be in effect. DEPRECATED
length_months_2 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 long Status code of this contract. DEPRECATED   

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.
status_code_2 long Status code of this contract.

Allowable values for status_code_2

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.
contract_plan_instance_details hash  
brd_arrow.gif plan_instance_no long The Master Subscription plan instance number.
brd_arrow.gif plan_name string The client-assigned name for this plan instance.
brd_arrow.gif client_plan_instance_id string Unique client-defined identifier for the plan instance.
brd_arrow.gif plan_instance_status_cd long The status code of the plan instance.
brd_arrow.gif plan_instance_status_label string The status of the plan instance
brd_arrow.gif invoiced_contract_period long The number of full months of the contract period that have already been billed. If last month is not a whole month, it is considered as one month.
brd_arrow.gif invoiced_billing_cycle long The number of full billing cycles that have been invoiced and that cover a portion or the whole period of the contract.
brd_arrow.gif remaining_contract_period long The remaining number of full months of the contract yet to be billed. If last month is not a whole month, it is considerd as one month.
brd_arrow.gif remaining_billing_cycle long A projected number of full billing cycles to be billed that would cover the remaining period of the contract.
brd_arrow.gif rollover_plan_no long Note that if the target rollover plan has a surcharge that has already been associated with this account, when the plan rollover occurs at the completion of this contract, the surcharge for this plan may be ignored (depending on the client parameter determining whether duplicate surcharges are permitted). The surcharge at the account level will remain in effect.
brd_arrow.gif rollover_client_plan_id string Note that if the target rollover plan has a surcharge that has already been associated with this account, when the plan rollover occurs at the completion of this contract, the surcharge for this plan may be ignored (depending on the client parameter determining whether duplicate surcharges are permitted). The surcharge at the account level will remain in effect.
brd_arrow.gif rollover_rate_sched_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif rollover_client_rate_sched_id string Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif contract_rollover_custom_rate_info hash  
brd_arrow.gif custom_rate_plan_instance_no long Plan instance for which the custom rates will be used at the completion of the contract.
brd_arrow.gif custom_rate_client_plan_instance_id string Client-defined ID of the plan instance for which the custom rates will be used at the completion of the contract.
brd_arrow.gif custom_rate_service_no long Service number for the new custom rate
brd_arrow.gif custom_client_rate_service_id string Unique client-defined identifier for the custom rate service number.
brd_arrow.gif custom_rate_seq_no string Sequence number for this line of the rate schedule.
brd_arrow.gif custom_rate_from_unit string Tiered pricing, "FROM" unit.
brd_arrow.gif custom_rate_to_unit string Tiered pricing, "TO" unit.
brd_arrow.gif custom_rate_per_unit string Rate to charge per unit on this tier.
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®