Types

DealCreate

The body that creates a deal.

namerequired
string
The deal name.
summary
string | null
The short summary shown on deal cards.
description
string | null
The deal description, as HTML. It is sanitised on write.
currency
string
The ISO 4217 currency. Defaults to USD.
min_investment
number | null
The minimum investment, in major currency units.
available_from
string | null (date-time)
When the deal opens to investment.
available_to
string | null (date-time)
When the deal closes to investment.
structure
string
The deal structure: direct, fund or tradeable. Defaults to direct.One of: direct, fund, tradeable
sub_structure
string
The deal sub-structure: debt, equity, hybrid, multi_asset, real_assets, real_estate or earthshot_solution. Defaults to equity.One of: debt, equity, hybrid, multi_asset, real_assets, real_estate, earthshot_solution
type_details
object
The structure-specific details that the legacy `meta` field held, keyed by field name, such as sector or growthStage. Enum-backed values are validated and lower-cased. `GET /deals/lookups` lists the allowed values.
sponsor
string | null
The sponsor name.
show_funding_secured
boolean
Whether investors see how much funding is secured. Defaults to true.
allow_questions
boolean
Whether investors can ask questions. Defaults to false.
request_further_docs
boolean
Whether investors can request further documents. Defaults to false.

Used by (1)