Portfolio Reporting
Portfolio API is used to administer investments for your clients. The core functionality involves 3 core business objects.
- Investors: the people/persons able to invest in a fund
- Assets: funds and investment opportunities
- Transactions: the flow of money throughout the life of an investment
Transactions, being dependant on both Assets and Investments, cannot be created without those records to reference.
The asset model
Assets represent the investment opportunities available to investors. Direct Investment opportunities are further broken down into share classes that represent the various investment levels available.
For all Asset types there must be an appropriate Asset Valuation prior to any transactions taking place.
Properties
- Name
id
- Type
- integer
- Description
Unique identifier for the asset.
- Name
guid
- Type
- string
- Description
Unique uuid v4 for the asset.
- Name
name
- Type
- string
- Description
Name of the asset.
- Name
class
- Type
- string
- Description
Class associated with the asset.
- Name
structure
- Type
- string
- Description
Structure associated with the asset.
- Name
uid
- Type
- string
- Description
Short readable unique identifier for the asset.
- Name
source
- Type
- string
- Description
Where was the asset created from (Delio Core or external/user systems).
- Name
source_id
- Type
- string
- Description
Unique identifier for the source provider.
- Name
description
- Type
- string
- Description
Description of the asset.
- Name
currency
- Type
- string
- Description
ISO 4217 currency code assigned to the asset.
- Name
asset_share_classes
- Type
- AssetShareClass[]
- Description
Timestamp of when the asset was last updated.
- Name
created_at
- Type
- datetime
- Description
Timestamp of when the asset was created.
- Name
updated_at
- Type
- datetime
- Description
Timestamp of when the asset was last updated.
Asset Share Class
- Name
id
- Type
- integer
- Description
Unique identifier for the asset.
- Name
asset_id
- Type
- integer
- Description
Associated asset identifier.
- Name
client_reference
- Type
- string
- Description
Client's reference identifier for the asset.
- Name
name
- Type
- string
- Description
Name of the asset share class.
- Name
issuance_valuation
- Type
- IssuanceValuation
- Description
Name of the asset share class.
Issuance Valuation
- Name
id
- Type
- integer
- Description
Unique identifier for the asset.
- Name
asset_id
- Type
- integer
- Description
Associated asset identifier.
- Name
asset_reference
- Type
- string
- Description
Reference for the asset.
- Name
value
- Type
- float
- Description
Value of the valuation.
- Name
date
- Type
- string
- Description
Timestamp of the valuation.
- Name
currency
- Type
- string
- Description
ISO 4217 currency code assigned to the valuation.
- Name
description
- Type
- string
- Description
Description/detail of the valuation.
The investor model
Investor records represent the people/persons able to invest in a fund.
Properties
- Name
id
- Type
- integer
- Description
Unique identifier for the investor.
- Name
guid
- Type
- string
- Description
Unique UUID V4 of the investor.
- Name
email
- Type
- string
- Description
Email address of the investor.
- Name
source
- Type
- string
- Description
Original source of the investor.
- Name
name
- Type
- string
- Description
Investor name.
- Name
source_id
- Type
- string
- Description
Client-defined unique identifier to link back to source platforms.
- Name
created_at
- Type
- datetime
- Description
Timestamp of when the asset was created.
- Name
updated_at
- Type
- datetime
- Description
Timestamp of when the asset was last updated.
The transaction model
Transactions record the flow of money throughout the life of an investment.
There are 4 main types of transactions:
- Subscriptions (Private Equity Funds only)
- Capital Calls (Private Equity Fund only)
- Investments (Direct Investment only)
- Distributions
Properties
- Name
id
- Type
- integer
- Description
Unique identifier for the transaction.
- Name
guid
- Type
- string
- Description
Unique UUID V4 of the transaction.
- Name
type
- Type
- string
- Description
Type of transaction (as noted above).
- Name
created_at
- Type
- datetime
- Description
Timestamp of the date of transaction.