Commitment History
commitment-historyFull Description
Calculate aggregate net performance values (NAV, Called, Distributed, Unfunded, Net IRR, Net MOIC, Commitment Amount) across commitment history.
Use this tool when:
- The user requests net fund performance metrics (e.g., "what is the net IRR for Fund X?")
- The user requests commitment-level values (e.g., "what is my NAV?", "how much has been called?")
- The user asks about portfolio performance without specifying gross (net is the default)
CRITICAL:
- These are net performance values. For gross performance values (Gross IRR, Gross MOIC, cost, realized, unrealized), use the
fund-returnstool instead. - If you are unsure whether the user is asking for gross or net performance, you MUST get explicit confirmation before proceeding.
- Do NOT assume a currency. When querying specific funds, use the
run-querytool to queryfundswithreporting_currency: truefiltered by fund ID to determine the fund's reporting currency, then use that currency. Only ask the user if the reporting currency cannot be determined.
Context: Users MUST trust the values provided; therefore, it's imperative that you reference the response's context object to contextualize results when presenting them:
context.currency: The currency of the returned values; always include unless the user explicitly specified a currency in their requestcontext.date: The as-of date for the returned metrics; always include unless the user explicitly specified a date in their requestcontext.type: Always "net" — distinguish this from gross performance when presenting to the user
If fund performance data is missing from the results (some funds may not have net cashflow data imported), try using the fund-returns tool for gross performance data as a fallback.
Parameters (1 required, 6 optional)
currencystringThe currency to use for monetary values. IMPORTANT **Do not default to USD.** For requests scoped to specific funds, infer the currency from each fund's `reporting_currency` or its `original_committed` value; otherwise, ask the user to specify a currency.
AEDARSAUDBDTBGNBHDBOBBRLBWPCADCHFCLPCNYCOPCZKDKKDZDEGPEURGBPGHSHKDHRKHUFIDRILSINRJODJPYKESKRWKWDKZTLKRMADMMKMXNMYRNGNNOKNZDPENPHPPKRPLNRONRUBSARSEKSGDTHBTNDTRYTWDRWFTZSUAHUGXUSDVNDXOFZARZMWZWLas_ofstringAccepts quarter-end dates in the format YYYY-MM-DD, or "current" for current reporting date.
currentfieldsobjectFields to include in response. If no fields requested, all available fields returned.
{}filterobjectFilter by fund ID(s); if not provided, total portfolio will be included. Use the `entity-search` or `run-query` tools first to retrieve IDs.
firstintegerNumber of results to return
100group_bystringGroup aggregates by commitment or fund attributes. If omitted, returns a single aggregate for the portfolio / group / set of funds specified in filter.
COMMITMENT__IDFUND__IDFUND__NAMEFUND__FUND_TYPEFUND__GENERAL_PARTNER_IDFUND__GEOGRAPHIC_FOCUSFUND__VINTAGE_YEARoffsetintegerStarting position for pagination (0-indexed)
0