Home > Aria Crescendo Documentation > Aria Crescendo core api > modify_instance_contract_m
modify_instance_contract_m
modify_instance_contract_m
It modifies an existing multi plan instance contract for a specified account holder and one or more plan instances.
For information on error messages generated by this API, see modify_instance_contract_m Error Messages.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||||||
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||||||||
|
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. | |||||||||||||
|
contract_no | long | 22 | Aria-assigned unique contract identifier. | ||||||||||||
| OR | ||||||||||||||||
| client_contract_id | string | 100 | Client assigned unique contract identifier.. | |||||||||||||
| new_client_contract_id | string | 100 | Client assigned unique contract identifier.. | |||||||||||||
| type_no | long | 8 |
The type of contract end action to be enforced by this contract. Allowable values for type_no:
|
|||||||||||||
| length_months | long | 8 | Number of months, starting from start_date, that the given contract will be in effect. | |||||||||||||
| OR | ||||||||||||||||
| end_date | string | 10 | End date of the date range covered by this line item in yyyy-mm-dd format. | |||||||||||||
| update_comments | string | 300 | CSR or API-provided comments provided at time of modify contract. | |||||||||||||
| cancel_fee | double | 12 | Fee to be charged if the plan instance is canceled by the account holder. For a multi-plan contract, this will be applicable only when the last remaining plan instance is canceled prior to the contract's end date. | |||||||||||||
| modify_directive | long | 1 |
Whether to add or remove the contract Allowable values for modify_directive:
|
|||||||||||||
| start_date | string | 14 | Contract start date in yyyy-mm-dd format. Defaults to the current date if not specified. This field is required for a plan or contract with a future start date. | |||||||||||||
| cascade_action | string | 5 |
An indicator on the plan_instance associated to the contract should indicate if the cascade option was selected when the plan_instance was assigned to the contract. Allowable values for cascade_action:
|
|||||||||||||
| Start of contract_plan_instances_update array | ||||||||||||||||
| contract_plan_instances_update | array | |||||||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||||||
 plan_instance_no |
long | 22 | The Aria-assigned unique identifier of the master plan instance or supplemental plan instance to be added to or removed from the contract (per the modify_directive input parameter). | |||||||||||||
| OR | ||||||||||||||||
| client_plan_instance_id |
string | 100 | The client-defined identifier of the master plan instance or supplemental plan instance to be added to or removed from the contract (per the modify_directive input parameter). | |||||||||||||
| rollover_plan_no |
long | 22 | 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. | |||||||||||||
| OR | ||||||||||||||||
| rollover_client_plan_id |
string | 100 | 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 |
Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract. Note that when the rollover_plan_no is provided then the rate schedule should be from the new rollover plan and if no rollover plan is provided the rate schedule should be from the current plan of the plan instance. |
|||||||||||||
| OR | ||||||||||||||||
| rollover_client_rate_sched_id |
string | 100 |
Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract. Note that when the rollover_plan_no is provided then the rate schedule should be from the new rollover plan and if no rollover plan is provided the rate schedule should be from the current plan of the plan instance. |
|||||||||||||
| End of contract_plan_instances_update array | ||||||||||||||||
| Start of contract_rollover_custom_rates array | ||||||||||||||||
| contract_rollover_custom_rates | array | |||||||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||||||
| custom_rate_plan_instance_no |
long | 22 | Plan instance for the new custom rate schedule to be used as rollover custom rate at the completion of the contract. | |||||||||||||
| OR | ||||||||||||||||
| custom_rate_client_plan_instance_id |
string | 100 | Unique client-defined identifier for the master plan instance. | |||||||||||||
| custom_rate_service_no |
long | 22 | Service number for the new custom rate | |||||||||||||
| OR | ||||||||||||||||
| custom_rate_client_service_id |
string | 100 | The client-defined service ID for the new custom rate. | |||||||||||||
| custom_rate_seq_no |
long | 22 | Sequence number for this line of the rate schedule | |||||||||||||
| custom_rate_from_unit |
long | 22 | Tiered pricing, "FROM" unit | |||||||||||||
| custom_rate_to_unit |
long | 22 | Tiered pricing, "TO" unit | |||||||||||||
| custom_rate_per_unit |
double | 22 | Rate to charge per unit on this tier | |||||||||||||
| End of contract_rollover_custom_rates array | ||||||||||||||||
| 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. | |||||||||||||
| Start of optional_transaction_qualifiers array | ||||||||||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||||||
| qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |||||||||||||
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. | |||||||||||||
| End of optional_transaction_qualifiers array | ||||||||||||||||
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. |
- © Copyright 2023 Aria Developer Central