cancel_instance_contract_m Guide
- Last updated
-
-
Save as PDF
The cancel_instance_contract_m API cancels an existing multi plan instance contract for a specified account holder and one or more plan instances.
| API Specification: |
cancel_instance_contract_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <contract_no> or <client_contract_id>
|
Additional Guidance
Input Field
| Field Name |
Notes |
| <close_status> |
Contract Closure Status (per the allowable values legend)
| Values |
Description |
| -1 |
CANCELLED |
| -2 |
TERMINATED |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<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)
|
<acct_no>, <client_acct_id> |
25020: Illegal characters entered
|
All character field inputs like <update_comments> |
16001: contract does not exist
|
<contract_no>, <client_contract_id> |
16028: This contract cannot be cancelled or terminated because it already was cancelled, terminated or expired.
|
<contract_no>, <client_contract_id> |
16003: Invalid Contract Closure Status
|
<close_status> |
