Set Aside Cash is used by Eclipse to protect cash. The Eclipse trade tools will remove the specified cash according to the Set Aside setup, and will not trade it unless the account is manually traded.
The dashboard will show “Cash Needs” where if there is a shortage of cash, the account can be rebalanced to raise cash.
This is useful for things like:
- One type distributions
- Systematic distributions
- Dollar cost averaging
Getting a list of Set Aside Cash records for an account.
GET
https://www.orioneclipse.com/v1/account/accounts/<eclipseAccountId>/asidecash
| property | description | required | datatype |
| <eclipseAccountId> | Eclipse Account ID | Yes | Integer |
Sample Response
[
{
"id": 48431,
"description": "depleting set aside",
"cashAmountTypeId": 1,
"cashAmountTypeName": "$",
"cashAmount": 10000,
"expirationTypeId": 2,
"expirationTypeName": "Transaction",
"expirationValue": "Distribution / Merge Out",
"toleranceValue": 10,
"expiredOn": null,
"isExpired": false,
"portfolioSetAsideCashId": null,
"setAsideAccountTypeName": "None",
"isSystematic": false,
"startDate": "2025-06-06T00:00:00.000Z",
"isActive": true,
"isBilling": false,
"amountExpired": null,
"initialAmount": null,
"isDeleted": 0,
"createdOn": "2026-02-13T19:51:14.000Z",
"createdBy": null,
"editedOn": "2026-02-13T19:51:14.000Z",
"editedBy": null,
"minCashAmount": 5000,
"maxCashAmount": 15000,
"percentCalculationTypeId": 0,
"percentCalculationType": "Use Default/Managed Value",
"expiredBy": null,
"expiredByUser": null,
"isDepleteOverTime": true
}
]
To get details for an individual set aside cash.
GET
https://www.orioneclipse.com/v1/account/accounts/<eclipseAccountId>/asidecash/<setAsideCashId>
Sample Response
{
"id": 48431,
"accountId": 104370,
"description": "depleting set aside",
"cashAmountTypeId": 1,
"cashAmount": 10000,
"minCashAmount": 5000,
"maxCashAmount": 15000,
"expirationTypeId": 2,
"expirationValue": 1,
"toleranceValue": 10,
"isExpired": false,
"startDate": "2025-06-06T00:00:00.000Z",
"isDeleted": 0,
"createdOn": "2026-02-13T19:51:14.000Z",
"createdBy": null,
"editedOn": "2026-02-13T19:51:14.000Z",
"editedBy": null,
"percentCalculationTypeId": 0,
"isDepleteOverTime": true
}Create a new Set Aside Cash record
POST
https://www.orioneclipse.com/v1/account/accounts/<eclipseAccountId>/asidecash
| Property | Description | Required | Datatype |
| <eclipseAccountId> | Eclipse Account ID | Yes | Integer |
BODY
| Property | Description | Required | Datatype |
| cashAmountTypeId | 1 = $ 2 = % | Yes | Integer |
| cashAmount | $ or % amount of cash to be protected. | Yes | Decimal |
| expirationTypeId | 1=Date 2=Transaction 3=None | Yes | Integer |
| expirationValue | When expirationTypeId = 1 (Date) End/Expiration Date When expirationTyeId = 2 (Transaction) 1=Distribution/Merge Out 3=Fee | Yes if expirationTyeId is 1 or 2 | Integer |
| percentCalculationTypeId | 0 = Use Default/Managed Value 1 = Use Total Value 2 = Use Excluded Value | No Default is 0 when cashAmountTypeId = 2 | Integer |
| toleranceValue | % of tolerance when using a transaction to expire setaside. | No Can be used when experationTypeId=Transaction(2) | Decimal |
| description | Up to 255 characters user description. | No | String |
| startDate | Date to start protecting cash. | No Default=Today | Date |
| minCashAmount | Minimum Tolerance to allow protected cash to go. When no value is entered, the minimum is the full setaside cashAmount. | No | Decimal |
| maxCashAmount | Maximum Tolerance to allow protected cash to go. When no value is entered, the maximum is the full setaside cashAmount. | No | Decimal |
| isDepleteOverTime | true, false | No Can be used when expirationTypeId = 2 | Boolean |
Below are sample payloads showing what can be sent to create different types of Set Asides.
Set Aside Cash – Dollar Amount with No Expiration:
{
"cashAmountTypeId": 1,
"expirationTypeId": 3,
"isDepleteOverTime": false,
"cashAmount": 3,
"description": "",
"minCashAmount": 3,
"minMultiplier": 100,
"maxCashAmount": 3,
"maxMultiplier": 100,
"startDate": "2026-02-13"
}
Set Aside Cash – Dollar with Date Expiration:
{
"cashAmountTypeId": 1,
"expirationTypeId": 1,
"isDepleteOverTime": false,
"cashAmount": 3,
"description": "",
"minCashAmount": 3,
"minMultiplier": 100,
"maxCashAmount": 3,
"maxMultiplier": 100,
"startDate": "2026-02-13",
"expirationValue": "2026-02-28"
}
Set Aside Cash – Dollar with Transaction Expiration
{
"cashAmountTypeId": 1,
"expirationTypeId": 2,
"isDepleteOverTime": false,
"cashAmount": 3,
"description": "",
"minCashAmount": 3,
"minMultiplier": 100,
"maxCashAmount": 3,
"maxMultiplier": 100,
"startDate": "2026-02-13",
"expirationValue": 1
}
Set Aside Cash – Percent with Transaction Expiration
{
"cashAmountTypeId": 2,
"expirationTypeId": 2,
"isDepleteOverTime": false,
"cashAmount": 3,
"description": "",
"minCashAmount": 3,
"minMultiplier": 100,
"maxCashAmount": 3,
"maxMultiplier": 100,
"expirationValue": 1,
"percentCalculationTypeId": 0
}
Update a Set Aside Cash
PUT
https://www.orioneclipse.com/v1/account/accounts/<eclipseAccountId>/asidecash/<setasideId>
The payload used in the call to update a Set Aside Cash is the same as the payload used to create Set Aside Cash.
Delete* Set Aside Cash Record
DELETE
https://www.orioneclipse.com/v1/account/accounts/<eclipseAccountId>/asidecash/<setasideId>
*Note: Deleting will remove the record from the UI, if you want to keep it visible in the UI you should simply update the Set Aside Cash record with an end date to expire it.
Create a DCA via API
To setup a DCA through the API, you will need to make multiple calls to the Add Set Aside Cash endpoint, https://www.orioneclipse.com/v1/account/accounts/<eclipseAccountId>/asidecash, using a different expiration value. Below is an example.
Request 1:
{
“id”: 0,
“cashAmount”: 500,
“cashAmountTypeId”: 1,
“cashAmountTypeName”: “$”,
“description”: “”,
“expirationTypeId”: 1,
“expirationTypeName”: “Date”,
“expirationValue”: “2024-09-03”,
“maxCashAmount”: 500,
“minCashAmount”: 500,
“setAsideAccountTypeId”: 1,
“startDate”: “2024-09-03”,
}
Request 2 (the expirationValue will be the only thing that is different):
{
“id”: 0,
“cashAmount”: 500,
“cashAmountTypeId”: 1,
“cashAmountTypeName”: “$”,
“description”: “”,
“expirationTypeId”: 1,
“expirationTypeName”: “Date”,
“expirationValue”: “2024-09-10”,
“maxCashAmount”: 500,
“minCashAmount”: 500,
“setAsideAccountTypeId”: 1,
“startDate”: “2024-09-03”,
}