Skip to main content
Aria Knowledge Central

cancel_instance_contract_m Guide

It 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>

Error Codes:

Error Code/Description Associated Inputs

1001: unexpected error

 

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>

25020: Illegal characters entered

Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.

All character field inputs like <update_comments>

16001: contract does not exist

Associated Inputs: contract_no, client_contract_id

<contract_no>, <client_contract_id>

16028: This contract cannot be cancelled or terminated because it already was cancelled, terminated or expired.

Associated Inputs: contract_no, client_contract_id

<contract_no>, <client_contract_id>

16003: Invalid Contract Closure Status

Associated Input: close_status

<close_status>

Additional Guidance:

Input Field

Field Name: Notes:
<close_status>

Contract Closure Status (per the allowable values legend)

Allowable values:

Values Description
-1 CANCELLED
-2 TERMINATED
  • Was this article helpful?