Types

Deal

A deal. min_investment is in major currency units.

idrequired
string (uuid)
The deal id.
namerequired
string
The deal name.
statusrequired
string
Where the deal is in its lifecycle. Read-only: change it with the publish, unpublish, archive and restore actions.One of: draft, awaiting_approval, ready_to_publish, published, retired, in_progress, rejected
externalrequired
boolean
True when an entrepreneur outside the organisation created the deal.
external_idrequired
string | null
Your own reference for the deal.
summaryrequired
string | null
The short summary shown on deal cards.
descriptionrequired
string | null
The deal description, as sanitised HTML.
currencyrequired
string | null
The ISO 4217 currency of the deal.
min_investmentrequired
number | null
The minimum investment, in major currency units.
structurerequired
string | null
The deal structure.One of: direct, fund, tradeable
sub_structurerequired
string | null
The deal sub-structure.One of: debt, equity, hybrid, multi_asset, real_assets, real_estate, earthshot_solution
type_detailsrequired
object | null
Structure-specific details, keyed by field name. Earlier versions called this field meta.
sponsorrequired
string | null
The sponsor name.
show_funding_securedrequired
boolean
Whether investors see how much funding is secured.
allow_questionsrequired
boolean
Whether investors can ask questions.
request_further_docsrequired
boolean
Whether investors can request further documents.
available_fromrequired
string | null (date-time)
When the deal opens to investment.
available_torequired
string | null (date-time)
When the deal closes to investment.
transaction_workflow_idrequired
string | null (uuid)
The transaction workflow investors follow. Null until one is assigned.
investor_engagement_enabledrequired
boolean
Whether investors can start investing through the transaction workflow.
active_tranche_idrequired
string | null (uuid)
The tranche new investments join.
drafted_atrequired
string | null (date-time)
When the deal last became a draft.
approval_started_atrequired
string | null (date-time)
When the deal last went for approval.
approved_atrequired
string | null (date-time)
When the deal was last approved, ready to publish.
published_atrequired
string | null (date-time)
When the deal was last published.
rejected_atrequired
string | null (date-time)
When the deal was last rejected.
retired_atrequired
string | null (date-time)
When the deal was last archived.
tabsrequired
string[]
The tabs investors see, in display order: deal and documents, the built-in tabs that are on (team, global_goals, location, parent_entity, graph_table, fund_strategy, video) and the ids of the deal's custom tabs. Send the whole list on PATCH to reorder tabs or turn built-in tabs on and off.
image_idrequired
string | null (uuid)
The deal image: a file in the deal's assets folder. It cannot change while the deal is published.
sponsor_image_idrequired
string | null (uuid)
The sponsor logo: a file in the deal's assets folder.
video_idrequired
string | null
The Vimeo video id, digits only. Setting it turns the video tab on and clearing it turns the tab off, unless the same PATCH sends tabs, which then decides.
custom_status_idrequired
string | null (uuid)
The id of the custom status now. Read-only: change it with the set-custom-status action. Null when none is set.
custom_status
object
The organisation's own status labels. Sent only with include=custom_status.
engagement_counts
object
How much investors have engaged with the deal. Sent only with include=engagement_counts.
bookmarked
boolean
Whether the acting user has bookmarked the deal. Sent only with include=bookmarked.
team_members
object[]
The first 100 team members, by position. Sent only with include=team_members; list them all with GET /deals/{deal_id}/team-members.
key_contacts
object[]
The first 100 key contacts, oldest first. Sent only with include=key_contacts; list them all with GET /deals/{deal_id}/key-contacts.
created_atrequired
string (date-time)
When the deal was created.
updated_atrequired
string | null (date-time)
When the deal last changed.

Used by (14)