Portfolio

The Portfolio API is the core fund-management surface: create and manage investors and assets, record the complete transaction lifecycle (subscriptions, capital calls, distributions, fees, adjustments), and generate analytics graphs, data tables, and PDF reports.

Owned by the Portfolio service

The Portfolio API is represented here for convenience, but it ships from its own service with its own release cadence. For the latest spec, request and response shapes, and any in-flight changes ahead of the next refresh here, refer to the upstream docs at deliowales.github.io/portfolio.

Domain model

  • Investors — people or entities that invest in funds. Each has a unique identifier and a source reference that links to external systems such as CRMs or back-office platforms.
  • Assets — investment opportunities, either Direct Investments (with share classes) or Private Equity Funds. Every asset requires at least one valuation before transactions can be created against it.
  • Transactions — the flow of capital throughout the life of an investment: Subscriptions, Capital Calls, Distributions, Fund Investments, Fees, and Adjustments. Transactions depend on both an existing Asset and an existing Investor.
  • Cash Accounts — fund-level cash pots that track credits, withdrawals, and inter-account transfers.
  • Reporting — PDF quarterly reports, capital-call notices, distribution notices, plus table exports and analytics graphs.

Endpoints

Assets

List assets

Return a paginated list of all assets.

Get asset details

Fetch a single asset by internal ID.

Get asset by source ID

Look up an asset by its external source identifier.

Delete an asset

Permanently remove an asset record.

List asset structures

Retrieve the available asset structure types.

Check asset name

Verify whether an asset name is already in use.

Asset investors with commitments

List investors in an asset along with their committed amounts.

Asset investors (simple)

Lightweight investor list for an asset.

Create a direct investment

Create a new direct asset (share-class structure).

Update a direct investment

Edit the details of a direct asset.

Create a private equity fund

Create a new PE fund asset.

Update a private equity fund

Edit the details of a PE fund asset.

Create a partial asset

Create a placeholder asset before full details are available.

Get a partial asset

Fetch a partial asset by source ID.

Update asset configuration

Change configuration flags for an asset.

Investors

List investors

Return a paginated list of all investors.

Get investor by ID

Fetch a single investor record.

Create an investor

Register a new investor in the system.

Update an investor

Edit an existing investor's details.

Delete an investor

Permanently remove an investor record.

Get investor by source ID

Look up an investor via their external source identifier.

Investors across Portfolio and Platform

List investors that appear in both Portfolio and Platform.

Search investors in Horizon

Search for investors via the Horizon integration.

Investor PE funds

List the private equity funds an investor has committed to.

Get current investor

Return the investor record for the authenticated user.

Assets for investors

Return assets associated with a list of investors.

Banker investor list

List investors visible to the authenticated banker.

Transactions

List transactions

Return all transactions with optional filters.

Get a transaction

Fetch a single transaction by ID.

Delete transactions

Delete one or more transactions.

Transaction cash flows

List cash flows attached to a transaction.

Mark transaction paid

Record a transaction as fully settled.

List subscriptions

Return all subscription transactions.

Create a subscription

Record a new investor subscription.

Get a subscription

Fetch a single subscription cash flow.

Create a direct investment

Record a direct asset investment transaction.

Create a fund investment

Record a fund-level investment transaction.

Create an adjustment

Record a capital adjustment (increase or decrease).

Delete an adjustment

Remove an adjustment group.

Record a fee

Attach a fee transaction to an asset.

Capital calls

List capital calls

Return all capital call transactions.

Create a capital call

Issue a new capital call against an asset.

Get a capital call

Fetch a single capital call by ID.

Mark capital call paid

Record a capital call as fully settled.

Record partial payment

Record an instalment payment against a capital call.

Capital call filter data

Retrieve filter metadata for capital call queries.

Distributions

Create redemption distribution

Record a direct redemption distribution.

Create dividend distribution

Record a direct dividend distribution.

Create other-income distribution

Record a direct other-income distribution.

Create fund redemption

Record a fund-level redemption distribution.

Create fund dividend

Record a fund-level dividend distribution.

Create fund other income

Record a fund-level other-income distribution.

Asset valuations

List asset valuations

Return historical valuations for an asset.

Add a valuation

Record a new valuation against an asset.

Get a valuation

Fetch a single asset valuation record.

Update a valuation

Edit an existing asset valuation.

Delete a valuation

Remove an asset valuation record.

Get valuation on date

Return the valuation for an asset at a specific point in time.

Investors from valuations

List investors derived from asset-investor valuation records.

Direct sub-positions

List sub-positions (share classes) within a direct asset.

Cash accounts

List cash accounts

Return all cash accounts.

Create a cash account

Open a new cash account.

Update a cash account

Edit a cash account's details.

Delete a cash account

Remove a cash account.

Record a credit

Deposit funds into a cash account.

Record a withdrawal

Withdraw funds from a cash account.

Transfer between accounts

Move funds between two cash accounts.

Delete a transaction

Remove a cash account transaction.

List cashflow types

Return the available cash account cashflow types.

List transaction names

Return the human-readable transaction name options.

Get fund cash balance

Return the current cash balance for a fund asset.

List fund cash pots

Return cash pots associated with a fund asset.

Create a fund cash pot

Create a named cash pot within a fund.

Update a fund cash pot

Edit a fund cash pot's details.

Record fund cash credit

Add a credit to a fund cash movement account.

Record fund cash debit

Record a debit against a fund cash movement account.

Record fund cash movement

Record an inter-account fund cash movement.

Graphs

Investor valuation bridge

Waterfall chart of value changes for an investor.

Asset valuation bridge

Waterfall chart of value changes for an asset.

Investor portfolio by strategy

Breakdown of an investor's portfolio by investment strategy.

Investor portfolio by vintage

Breakdown of an investor's portfolio by vintage year.

Investor portfolio by sector

Breakdown of an investor's portfolio by sector.

Investor portfolio by geography

Breakdown of an investor's portfolio by geographic region.

Asset breakdown by sector

Sector distribution across an asset's sub-positions.

Asset breakdown by geography

Geographic distribution across an asset's sub-positions.

Cumulative distributions

Cumulative distribution chart for an asset over time.

Direct overview by asset class

Direct portfolio breakdown by asset class.

Direct overview by sector

Direct portfolio breakdown by sector.

Direct overview by geography

Direct portfolio breakdown by geography.

Tables

Investors table

Paginated, filterable investor data table.

Export investors

Download the investor table as CSV.

Investments table

Paginated, filterable investments table.

Export investments

Download the investments table as CSV.

Ledger table

Paginated transaction ledger.

Export ledger

Download the ledger as CSV.

Asset valuations table

Historical valuations table for an asset.

Export asset valuations

Download the asset valuations table as CSV.

Direct investors table

Investor table for direct asset holdings.

Direct asset valuation table

Valuation table for a direct asset.

Cash account transactions

Transaction history for a specific cash account.

Investor transactions table

Transaction table filtered by investor.

Fees table

Fee transaction table.

Taxes table

Tax transaction table.

Export transactions or fees

Download transactions or fees as CSV.

Bulk import

Upload import file

Submit an XLSX file to trigger an asynchronous portfolio import job.

Import history

List past bulk import jobs.

Poll import status

Check the status of a running import job.

Reverse an import

Roll back a completed bulk import.

Download import template

Fetch an XLSX template for a supported import type.

Reports

Generate quarterly report

Queue PDF quarterly report generation for selected investors.

Generate capital call notice

Queue PDF capital call notices for a transaction's investors.

Generate distribution notice

Queue PDF distribution notices for a transaction's investors.

Get report settings

Retrieve the current PDF report template configuration.

Update report settings

Update a PDF report template setting (logo, disclaimer, contacts, etc.).

Other

List requested transactions

Return pending or draft transactions awaiting approval.

Create a requested transaction

Submit a new transaction for approval.

Transition request state

Approve, reject, or advance a requested transaction.

List sectors

Return all available investment sectors.

List real-estate sectors

Return real-estate-specific sectors.

List strategies

Return all investment strategies.

Active strategies

Return only currently active investment strategies.

List geographic locations

Return available geographic locations for asset tagging.

Create a geographic location

Add a new geographic location.

Update a geographic location

Edit an existing geographic location.

Delete a geographic location

Remove a geographic location.

Get display currency

Return the authenticated user's preferred display currency.

Set display currency

Save the authenticated user's preferred display currency.

Calculate total value

Compute total value from share price and number of shares.

Calculate number of shares

Compute share count from total value and price per share.

Fund overview widget

Dashboard widget with fund-level overview metrics.

Direct investment overview widget

Dashboard widget with direct investment overview metrics.

Get configuration settings

Retrieve all Portfolio configuration settings.

Update configuration settings

Update one or more Portfolio configuration keys.