Eclipse Liquidation Tool

Welcome to the API guide for our new Liquidation Tool. This tool is designed to streamline the process of liquidating accounts, portfolios, and sleeves while offering flexibility in cash management.

Key Features:

Selection Methods:

Account
Portfolio
Trade Group
Excel import (supporting Account ID, Account Number, or Portfolio ID)

Flexible Liquidation Options:

Full Portfolio Liquidation
Individual Account Liquidation
Full Sleeve Portfolio Liquidation
Individual Sleeve Liquidation

Cash Management Options:

Journal cash to distribution sleeve (default method)
Retain cash in individual sleeves

Trade Restriction Override

Bypasses all preferences and restrictions
Creates trades for all assets, including those with restrictions
Adds warning messages to trades that bypass restrictions

Import File Handling

Supports either accounts or portfolios (not both) in a single import file
When importing accounts, the account ID or account number can be used

This tool only requires one endpoint with some of the parameters of the body being optional.

Name	Type	Required	Description
portfolioIds	array	no*	id(s) of the portfolio(s) being liquidated
accountIds	array	no*	id(s) of the account(s) being liquidated
tradeGroupIds	array	no*	id(s) of the trade group(s) being liquidated
tradeToolSelection	number	no**	Portfolio = 1, Account = 2, AccountTradeGroup = 4, ExcelImport = 6,
tradeInstanceType	number	no**	Liquidate = 11
tradeInstanceSubType	number	no**	Liquidate = 22
reason	string	no	Reason for liquidation
isExcelImport	boolean	yes	True if importing through an excel file
isViewOnly	boolean	yes	Pass true/false (For Enabling or disabling trades)
sleeveAccountMethod	string	no	‘DistributionSleeve’, ‘IndividualSleeves’, ” – Pass this if the account is not sleeved

*One of these must be provided if isExcelImport is false.

**tradeToolSelection, tradeInstanceType and tradeInstanceSubType shows how an account was chosen to trade, and which tool did the trading. They are optional, but without them, the Trade Instance metadata will be missing that information.

POST /v1/tradetool/liquidate/generateTrade

{
    "portfolioIds": null,
    "accountIds":  [
        123,
        456
    ],
    "tradeGroupIds": null,
    "tradeToolSelection": 2,
    "tradeInstanceSubType": 11,
    "tradeInstanceType": 22,
    "reason": "example",
    "isExcelImport": false,
    "isViewOnly": false,
    "sleeveAccountMethod": "IndividualSleeves"
}

Development Guides

Eclipse Liquidation Tool