Dated cap table (version)

Query parameters

• version_iduuidoptional
  Version UUID (optional when company_id is given).
• company_iduuidoptional
  Company UUID (optional when version_id is given).
• as_ofstringoptional
  Date (YYYY-MM-DD, optional; default = today): non-superseded version in force at that date.

Response

Status 200, application/json. Resources outside your rights are absent, never an error.

• versionobject
  Show child attributes

  • idstring
  • company_idstring
  • effective_datestring
  • sourcestring · nullable
  • notestring · nullable
  • supersedes_idstring · nullable
  • supersededboolean
  • created_atstring · nullable
• instrumentsobject[]
  Show child attributes

  • instrument_idstring · nullable
  • kindstring · nullable
  • labelstring · nullable
  • seriesstring · nullable
  • presentboolean
    Instrument present in the register at the effective date.
  • sharesnumber · nullable
    Number of shares (share-type instruments).
  • quantitynumber · nullable
    Quantity (bonds, warrants, ORA…).
  • notional_eurnumber · nullable
• positionsobject[]
  Show child attributes

  • holderobject
    Show child attributes

    • typeenum
      One of: fund, co_investor
    • idstring · nullable
      fund_id or holder_co_investor_id (co-investor line, no foreign key).
    • labelstring · nullable
      Holder name frozen in the version.
    • rolestring · nullable
      Frozen role (hold_co, co_investor, manager…).
    • holding_company_idstring · nullable
      Frozen holding company, when the line names one.
  • instrument_idstring · nullable
  • kindstring · nullable
  • labelstring · nullable
  • quantitynumber
• holdersobject[]
  Show child attributes

  • holderobject
    Show child attributes

    • typeenum
      One of: fund, co_investor
    • idstring · nullable
      fund_id or holder_co_investor_id (co-investor line, no foreign key).
    • labelstring · nullable
      Holder name frozen in the version.
    • rolestring · nullable
      Frozen role (hold_co, co_investor, manager…).
    • holding_company_idstring · nullable
      Frozen holding company, when the line names one.
  • quantity_by_kindobject
    Quantity held by instrument kind.
  • total_quantitynumber

Errors

400 invalid parameter · 401 missing or expired token · 429 too many requests · 500 read failed. See Errors.