cancel_instance_contract_m
Summary
| API Name | cancel_instance_contract_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.37 |
Description
Cancels an existing instance contract on an account, releasing the specified plan instances from their contractual commitment. Instance contracts bind specific master and/or supplemental plan instances to a minimum term with early termination conditions. Cancelling the contract may trigger early termination fees depending on the contract configuration and how much time remains. To create instance contracts, use create_instance_contract_m. To cancel account-wide universal contracts instead, use cancel_acct_universal_contract_m.
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 |
||||||
| update_comments | string | 300 | No |
Comments provided at time of last contract update. |
||||||
| close_status | long | 2 | No |
Contract Closure Status (per the allowable values legend) Allowed 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. |
|
| contract_final_invoice_cancel_errors | object | No |
Contains error details for the cancellation of final invoice of a contract plan instance when an issue occurs during the credit memo issuance or rollback process upon contract cancellation. |
contract_final_invoice_cancel_errors fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoice_no | long | No |
The invoice number that encountered an issue during the credit memo issuance or rollback process. |
|
| error_code | long | No |
The error code returned when an issue occurs during the credit memo issuance or rollback process for the specific invoice. |
|
| error_msg | string | No |
The error message returned when an issue occurs during the credit memo issuance or rollback process for the specific invoice. |