Skip to main content
Aria Knowledge Central

get_instance_contract_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_instance_contract_m
Class account_services_m
Update Version 6.40

Description

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

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
contract_no long 22 Yes

Aria-assigned unique contract identifier.

Alternative required field: client_contract_id
client_contract_id string 100 Yes

Client assigned unique contract identifier..

Alternative required field: contract_no
locale_no long 30 No

Specifies the language in which the information is returned.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no
plan_instance_no long   No

Unique plan instance number for each assigned plan instance.
client_plan_instance_id string 100 No

Unique client-defined ID for each assigned plan instance.
include_contract_billing_installment long 1 No

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.

Allowed values:

Value Description
0 do not return contract billing values(default)
1 return contract billing values

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
type_no long   No

Note: This field is deprecated. Aria no longer supports type_no.
length_months long   No

Note: This field is deprecated. Aria no longer supports length_months.
create_comments string   No

CSR or API-provided comments provided at time of contract creation.
update_comments string   No

Comments provided at time of last contract update.
create_date string   No

The date the contract was created.
update_date string   No

The date the contract was last modified.
start_date string   No

Specifies contract start date. The date is in the format yyyy-mm-dd
end_date string   No

Contract end date
status_code long   No

Note: This field is deprecated. Aria no longer supports status_code.
contract_plan_instance_details object   No

See fields below
acct_locale_no long 30 No

Note: This field is deprecated. Aria no longer supports acct_locale_no.
acct_locale_name string 100 No

Name of the account level locale.
length_months_2 long   No

Note: This field is deprecated. Aria no longer supports length_months_2.
type_no_2 long   No

The type of contract end action to be enforced by this contract.

Allowed values:

Value 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).
acct_locale_no_2 long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
status_code_2 long   No

Status code of this contract.

Allowed values:

Value 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.
duration_type long 1 No

Indicator which determines whether the contract duration in length is based on months, weeks or days.

Allowed values:

Value Description
1 Days
2 Weeks
3 Months (default)
duration_length long   No

The contract duration in length that the given contract will be in effect from the start date.
renewal_duration_type long 1 No

Indicator which determines whether the contract renewal duration in length is based on months, weeks or days.

Allowed values:

Value Description
1 Days
2 Weeks
3 Months (default)
renewal_duration_length long   No

The contract renewal duration in length that the given contract will be in effect from the renewal start date.
renewal_end_date string   No

Date on which the renewal contract ends. Date format is YYYY-MM-DD. For the new contract type '9-Renew contract with different duration', it is mandatory to pass the either the renewal_end_date or the renewal_duration_type and renewal_duration_length. If both are passed, renewal_duration_length will take the precedence over the renewal_end_date.

contract_plan_instance_details.contract_rollover_custom_rate_info fields

Name Type Length Required Description
custom_rate_plan_instance_no long 22 No

Plan instance for which the custom rates will be used at the completion of the contract.
custom_rate_client_plan_instance_id string 22 No

Client-defined ID of the plan instance for which the custom rates will be used at the completion of the contract.
custom_rate_service_no long 22 No

Service number for the new custom rate
custom_client_rate_service_id string 22 No

Unique client-defined identifier for the custom rate service number.
custom_rate_seq_no string 22 No

Sequence number for this line of the rate schedule.
custom_rate_from_unit string 22 No

Tiered pricing, "FROM" unit.
custom_rate_to_unit string 22 No

Tiered pricing, "TO" unit.
custom_rate_per_unit string 22 No

Rate to charge per unit on this tier.

contract_plan_instance_details fields

Name Type Length Required Description
plan_instance_no long 22 No

The Master Subscription plan instance number.
plan_name string   No

The client-assigned name for this plan instance.
client_plan_instance_id string 100 No

Unique client-defined identifier for the plan instance.
plan_instance_status_cd long 22 No

The status code of the plan instance.
plan_instance_status_label string 22 No

The status of the plan instance
invoiced_contract_period long 8 No

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.
invoiced_billing_cycle long 8 No

The number of full billing cycles that have been invoiced and that cover a portion or the whole period of the contract.
remaining_contract_period long 8 No

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.
remaining_billing_cycle long 8 No

A projected number of full billing cycles to be billed that would cover the remaining period of the contract.
rollover_plan_no long 22 No

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.
rollover_client_plan_id string 22 No

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.
rollover_rate_sched_no long 22 No

Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
rollover_client_rate_sched_id string 22 No

Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
contract_rollover_custom_rate_info object   No

See fields below
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.