Development Guides

Sleeved Portfolio Set Aside Cash

Set Aside Cash can be created for sleeved portfolios in Eclipse.

Create

To create a set aside cash, you can make a POST call to https://www.orioneclipse.com/v1/portfolio/portfolios/45992/asideCash, where 45992 is the Portfolio ID.

A sample payload for creating a set aside with no expiration is below.

{

  “expirationTypeId”: 3,

  “setAsideAccountTypeId”: 2,

  “cashAmountTypeId”: 1,

  “isDepleteOverTime”: false,

  “percentCalculationTypeId”: 0,

  “id”: 0,

  “cashAmount”: 10000,

  “expirationValue”: “”,

  “description”: “No expiration”,

  “minCashAmount”: 7500,

  “minMultiplier”: 75,

  “maxCashAmount”: 12500,

  “maxMultiplier”: 125,

  “tempId”: -3,

  “startDate”: “2025-10-20”,

  “expirationTypeName”: “None”,

  “setAsideAccountTypeName”: “Distribution”,

  “percentCalculationType”: “Use Default/Managed Value”,

  “modified”: false

}

A sample payload creating a set aside cash using an expiration type of transaction is below.

{

  “expirationTypeId”: 2,

  “setAsideAccountTypeId”: 2,

  “cashAmountTypeId”: 1,

  “isDepleteOverTime”: false,

  “percentCalculationTypeId”: 0,

  “id”: 0,

  “cashAmount”: 10000,

  “expirationValue”: “1”,

  “toleranceValue”: 2,

  “description”: “Transaction expiration”,

  “minCashAmount”: 7500,

  “minMultiplier”: 75,

  “maxCashAmount”: 12500,

  “maxMultiplier”: 125,

  “tempId”: -4,

  “startDate”: “2025-10-20”,

  “expirationTypeName”: “Transaction”,

  “setAsideAccountTypeName”: “Distribution”,

  “percentCalculationType”: “Use Default/Managed Value”,

  “modified”: false

}

A sample payload creating a set aside cash using an expiration type of date is below.

{
“expirationTypeId”: 1,
“setAsideAccountTypeId”: 2,
“cashAmountTypeId”: 1,
“isDepleteOverTime”: false,
“percentCalculationTypeId”: 0,
“id”: 0,
“cashAmount”: 15000,
“expirationValue”: “2025-12-31”,
“toleranceValue”: null,
“description”: “”,
“minCashAmount”: 10000,
“minMultiplier”: 66.67,
“maxCashAmount”: 20000,
“maxMultiplier”: 133.33,
“tempId”: -2,
“startDate”: “2025-10-20”,
“expirationTypeName”: “Date”,
“setAsideAccountTypeName”: “Distribution”,
“percentCalculationType”: “Use Default/Managed Value”
}

Set Aside Cash Types – this field determines what account(s) within the portfolio get the set aside cash created.

Set Aside Account Type IDSet Aside Account TypeDescription
1ContributionCreates the set aside in the contribution sleeve
2DistributionCreates the set aside in the distribution sleeve
3Prorated Based on Contribution %Use the Sleeve Contribution % to create set asides in normal sleeved accounts
4Prorated Based on Distribution %Use the Sleeve Distribution % to create set asides in normal sleeved accounts

Expiration Types – this field determines how a set aside will be expired.

Expiration Type IDExpiration TypeDescription
1TransactionUses transactions to expire the set aside
2DateUses a date to expire the set aside
3NoneDoes not expire

Expiration Values – this field determines what type of transaction will be used to expire a set aside.

Expiration Value IDExpiration ValueDescription
1Distribution/Merge OutUses distribution transactions to expire set aside
3FeeUses fee transaction to expire set aside

Percent Calculation Type – this field determines what value will be used when calculation the set aside.

Percent Calculation Type IDPercent Calculation Type ValueDescription
0Managed ValueUses Managed Value to calculate set aside
1Total ValueUses Total Value to calculate set aside
2Excluded ValueUses Excluded Value to calculate set aside

Update

Updating a portfolio set aside cash can be done by making the same POST call to
https://www.orioneclipse.com/v1/portfolio/portfolios/45992/asideCash.

A sample payload for updating an existing set aside is below. Whereas the call to create a new set aside does not contain an ID, the call to update an existing set aside should contain the ID of the set aside being updated.

{

  “expirationTypeId”: 3,

  “setAsideAccountTypeId”: 2,

  “cashAmountTypeId”: 1,

  “isDepleteOverTime”: false,

  “percentCalculationTypeId”: 0,

  “id”: 286,

  “cashAmount”: 7500,

  “expirationValue”: null,

  “toleranceValue”: null,

  “description”: “No expiration”,

  “minCashAmount”: 5000,

  “minMultiplier”: 66.67,

  “maxCashAmount”: 10000,

  “maxMultiplier”: 133.33,

  “startDate”: “2025-10-20”,

  “expirationTypeName”: “None”,

  “setAsideAccountTypeName”: “Distribution”,

  “percentCalculationType”: “Use Default/Managed Value”,

  “modified”: false

}

Delete

To delete a portfolio set aside cash, you can make a DELETE call to https://www.orioneclipse.com/v1/portfolio/portfolios/45992/asideCash/286, where 45992 is the Portfolio ID and 286 is the Set Aside Cash ID to be deleted.

Deplete Over Time

For sleeved portfolios, when creating a portfolio set aside cash that uses an Expiration Type of Transaction, you can elect to have the set aside depleted over time by setting isDepleteOverTime to true, in the POST call to https://review.orioneclipse.com/v1/portfolio/portfolios/PorfolioID/asideCash. An example payload is below:

{

  “expirationTypeId”: 2,

  “setAsideAccountTypeId”: 2,

  “cashAmountTypeId”: 1,

  “isDepleteOverTime”: true,

  “percentCalculationTypeId”: 0,

  “id”: 0,

  “cashAmount”: 20000,

  “expirationValue”: “1”,

  “toleranceValue”: 2,

  “description”: “Deplete over time”,

  “minCashAmount”: 15000,

  “minMultiplier”: 75,

  “maxCashAmount”: 25000,

  “maxMultiplier”: 125,

  “tempId”: -5,

  “startDate”: “2025-10-20”,

  “expirationTypeName”: “Transaction”,

  “setAsideAccountTypeName”: “Distribution”,

  “percentCalculationType”: “Use Default/Managed Value”,

  “modified”: false

}