It returns a multi-plan instance contract currently associated with a specified account.
| API Specification: |
get_instance_contract_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <contract_no> or <client_contract_id>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <include_contract_billing_installment> |
Aria ignores this parameter when you set the 'Enable Contract Billing Installment' client parameter to "false," and the API won't return contract billing values.
If you set the above mentioned client parameter to "true" and you specify a value of "1" in your API call, 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
| Values |
Description |
| 0 |
do not return contract billing values(default) |
| 1 |
return contract billing values |
|
Output Fields
| Field Name |
Notes |
| <type_no> |
DEPRECATED
|
| <type_no_2> |
Allowable values
| 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). |
|
| <status_code> |
Allowable values
| 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> |
Allowable values
| 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. |
|
| <renewal_duration_type> |
Indicates whether the contract renewal duration in length is based on months, weeks or days.
Allowable Values
| Values |
Description |
| 1 |
Days |
| 2 |
Weeks |
| 3 |
Months |
|
| <duration_type> |
Indicates whether the contract renewal duration in length is based on months, weeks or days.
Allowable Values
| Values |
Description |
| 1 |
Days |
| 2 |
Weeks |
| 3 |
Months |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
1066: Locale name does not exist in the system.
Associated Inputs: locale_name
|
<locale_name> |
1067: Locale no does not exist in the system.
Associated Inputs: locale_no, master_plan_instance_no
|
<locale_name> |
16001: contract does not exist
Associated Inputs: contract_no, client_contract_id
|
<contract_no>, <client_contract_id> |
26003: The API execution is not supported because your client parameter Account_EOM_Enabled is set to False. Please contact Aria customer support with questions about the Account_EOM_Enabled client parameter.
|
|
