Manage a Portfolio
In this guide, you’ll learn how to view your portfolios, change your portfolio preferences, and retrieve portfolio documents.
In the sandbox environment, creating a business automatically creates a portfolio with a default allocation of 100% Managed Treasuries. In production, no allocation is automatically assigned at business creation. Customers must be able to change their portfolio allocation at any time, and updates are to be made through the update portfolio call.
View and Set Portfolio Allocation Preferences
- View a business' portfolio via the
GET /v1/businesses/{business_id}/portfolioendpoint. - Update a business' portfolio via the
POST /businesses/{business_id}/portfolioendpoint.
There are currently three products able to be allocated to:
- Managed Money Market (
managed_money_market) - Managed Treasuries (
managed_treasuries) - Managed Income (
managed_income)
When setting a portfolio, the total allocation must add up to 100%. E.g.,
{
"products": [
{
"product": "managed_income",
"percentage": 33.34
},
{
"product": "managed_treasuries",
"percentage": 33.33
},
{
"product": "managed_money_market",
"percentage": 33.33
}
]
}
The API handles validation of the percentages with precision to two decimal places.
Our active management team is available to help you ensure your clients can make informed decisions about their portfolio allocations. Contact the Treasure team for more information.
Fetch a Business' Portfolio Balance History
Portfolio balance history can be retrieved with the GET /businesses/{business_id}/portfolio_history endpoint.
Portfolio history only available in production. For the sandbox environment, use the
GET /v1/businesses/{business_id}/portfolio
endpoint to view point-in-time portfolio data.
A business' current_allocations may change depending on:
- Deposits being allocated to the portfolio
- Changes in market value
- Rebalances done by Treasure to bring your customer’s portfolio in alignment with their target, or to adjust for management fees being deducted
Fetch Documents
All documents for a business (e.g., monthly statements) can be retrieved with the GET /businesses/{business_id}/documents endpoint, or a specific document can be fetched by ID via the GET /businesses/{business_id}/documents/{document_id} endpoint.
When a document is ready, a document.created webhook is sent.
Document links (URLs) expire after 24 hours and should not be cached.
