Deals
Deals are an essential part of Delio Core — most entities within Delio Core are associated with a Deal. A "Deal" is a container for distribution. Using the Deal Management API, you will be able to look at how to query, create, update, and delete Deals including their transaction workflows.
The deal model
The conversation model contains all the information about the conversations between you and your contacts. In addition, conversations can also be group-based with more than one contact, they can have a pinned message, and they can be muted.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the deal.
- Name
shortId- Type
- string
- Description
Unique readable identifier for the deal.
- Name
ownerId- Type
- string
- Description
Unique identifier of the deal owner.
- Name
ownerUserData- Type
- User | null
- Description
User object of the deal owner.
- Name
organisationId- Type
- string
- Description
The unique identifier of the associated organisation.
- Name
externalId- Type
- string | null
- Description
A user-defined identifier for the deal. This can be used to link to a reference of the deal on integrated systems.
- Name
currentUser- Type
- CurrentUser
- Description
The current users preferences for the deal.
- Name
name- Type
- string
- Description
The deal name.
- Name
status- Type
- DealStatus
- Description
Status of the deal.
- Name
customStatus- Type
- ObjectLiteral | null
- Description
Custom status of the deal (user provided).
- Name
prevCustomStatus- Type
- ObjectLiteral | null
- Description
Previous custom status of the deal (user provided).
- Name
isEvergreen- Type
- boolean
- Description
Is the deal always open.
- Name
isNew- Type
- boolean
- Description
Was the deal opened within the last 7 days.
- Name
isClosingSoon- Type
- boolean
- Description
Is the deal closing within 7 days.
- Name
isClosed- Type
- boolean
- Description
Is the deal closed.
- Name
daysLeft- Type
- number | null
- Description
Number of days left until the deal closes.
- Name
hoursLeft- Type
- number | null
- Description
Number of hours left until the deal closes.
- Name
sponsor- Type
- string | null
- Description
Name of the deal sponsor.
- Name
sponsorImageId- Type
- string | null
- Description
Unique identifier of the uploaded deal sponsor image.
- Name
currency- Type
- string
- Description
ISO 4217 currency code assigned to the deal.
- Name
structure- Type
- DealStructure
- Description
Structure of the deal.
- Name
subStructure- Type
- AssetClass | FundType
- Description
Sub-structure of the deal.
- Name
summary- Type
- string | null
- Description
Short summary of the deal.
- Name
description- Type
- string | null
- Description
A description of the deal.
- Name
locations- Type
- Location[]
- Description
Locations assigned to the deal.
- Name
locationIds- Type
- string[] | number[] | null
- Description
Location identifiers assigned to the deal.
- Name
locationName- Type
- string | null
- Description
Location name assigned to the deal.
- Name
availableFrom- Type
- string | null
- Description
Timestamp of when the deal is available from.
- Name
availableTo- Type
- string | null
- Description
Timestamp of when the deal is available to.
- Name
minInvestment- Type
- number | null
- Description
Minimum investment amount for the deal.
- Name
bannerImage- Type
- string | null
- Description
Unique identifier for the deals banner image.
- Name
imageId- Type
- string | null
- Description
Unique identifier for the deal thumbnail image.
- Name
dealTypeMeta- Type
- DealTypeMeta | null
- Description
Object of the deal structure meta data.
- Name
requestFurtherDocs- Type
- boolean | null
- Description
Should the "Request further docs" button be shown.
- Name
allowQuestions- Type
- boolean | null
- Description
Should questions be made available on the deal.
- Name
assetsDirectoryId- Type
- string | null
- Description
Unique identifier for the deal's assets directory. Used to store images etc.
- Name
dealInformationDirectoryId- Type
- string | null
- Description
Unique identifier for the deal's information directory.
- Name
createdByEntrepreneur- Type
- boolean
- Description
Was the deal created by an entrepreneur.
- Name
keyContacts- Type
- KeyContact[] | null
- Description
List of Key Contacts associated with the deal.
- Name
parentEntity- Type
- ParentEntity | null
- Description
Parent entity/business associated with the deal.
- Name
globalGoals- Type
- GlobalGoals | null
- Description
Global goals associated with the deal.
- Name
funding- Type
- Funding | null
- Description
Current funding information associated with a deal.
- Name
classifications- Type
- Classification[]
- Description
List of classifications associated with the deal.
- Name
createdAt- Type
- string
- Description
Timestamp of when the deal was created.
- Name
updatedAt- Type
- string | null
- Description
Timestamp of when the deal was last updated.
- Name
deletedAt- Type
- string | null
- Description
Timestamp of when the deal was deleted.
- Name
draftedAt- Type
- string | null
- Description
Timestamp of when the deal was initially drafted.
- Name
approvalStartedAt- Type
- string | null
- Description
Timestamp of when the deal approval was started.
- Name
approvedAt- Type
- string | null
- Description
Timestamp of when the deal was approved.
- Name
publishedAt- Type
- string | null
- Description
Timestamp of when the deal was published.
- Name
retiredAt- Type
- string | null
- Description
Timestamp of when the deal was retired.
- Name
rejectedAt- Type
- string | null
- Description
Timestamp of when the deal was rejected.
Current user preferences
- Name
isBookmarked- Type
- boolean
- Description
Has the current user bookmarked the deal.
- Name
matchScore- Type
- number
- Description
Match score for the deal and current user.
Deal status
The deal status is responsible for managing the lifecycle of a deal.
Available statuses
- draft
- awaiting_approval
- ready_to_publish
- published
- retired
- in_progress
- rejected
Deal location
- Name
id- Type
- string
- Description
Unique identifier for the location.
- Name
locationId- Type
- number | null
- Description
Unique identifier for the geographic location.
- Name
locationName- Type
- string | null
- Description
Location name.
- Name
details- Type
- string | null
- Description
Details about the location.
- Name
createdAt- Type
- string
- Description
Timestamp when the location was created.
- Name
updatedAt- Type
- string | null
- Description
Timestamp when the location was last updated.
- Name
deletedAt- Type
- string | null
- Description
Timestamp when the location was deleted.
Key Contact
The KeyContact object holds information about individuals associated with a deal.
- Name
id- Type
- string
- Description
Unique identifier of the key contact.
- Name
name- Type
- string | null
- Description
Name of the key contact.
- Name
email- Type
- string | null
- Description
Email address of the key contact.
- Name
phoneNumber- Type
- string | null
- Description
Phone no. of the key contact.
- Name
address- Type
- string | null
- Description
Address of the key contact.
- Name
createdAt- Type
- string
- Description
Timestamp when the key contact was created.
- Name
updatedAt- Type
- string | null
- Description
Timestamp when the key contact was last updated.
- Name
deletedAt- Type
- string | null
- Description
Timestamp when the key contact was deleted.
Parent Entity
The ParentEntity object holds information about organisation or entity responsible for the deal.
- Name
id- Type
- string
- Description
Unique identifier of the parent entity.
- Name
name- Type
- string
- Description
Name of the parent entity.
- Name
type- Type
- ParentEntityType
- Description
Type of the parent entity.
- Name
typeLabel- Type
- string
- Description
Name of the parent entity type.
- Name
logoId- Type
- string | null
- Description
Unique identifier of the parent entities logo image.
- Name
legalName- Type
- string | null
- Description
Legal name of the parent entity.
- Name
contactName- Type
- string | null
- Description
Contact name for the parent entity.
- Name
contactEmail- Type
- string | null
- Description
Contact email address for the parent entity.
- Name
contactNumber- Type
- string | null
- Description
Contact phone number for the parent entity.
- Name
headquarters- Type
- string | null
- Description
Parent entities' headquarters.
- Name
website- Type
- string | null
- Description
Website address for the parent entity.
- Name
yearFounded- Type
- string | null
- Description
Year the parent entity was founded.
- Name
teamSize- Type
- number | null
- Description
Size of the team the parent entity has.
- Name
background- Type
- string | null
- Description
Information about the parent entity.
- Name
createdAt- Type
- string | null
- Description
Timestamp the parent entity was created.
- Name
updatedAt- Type
- string | null
- Description
Timestamp the parent entity was last updated.
- Name
deletedAt- Type
- string | null
- Description
Timestamp the parent entity was deleted.
Parent Entity Type
- company
- fund
- partnership
- spv
Global Goals
- Name
id- Type
- string
- Description
Unique identifier of the global goals entity.
- Name
sdgs- Type
- number[] | [] | null
- Description
The numbers referencing the global goals
- Name
createdAt- Type
- string
- Description
Timestamp the parent entity was created.
- Name
updatedAt- Type
- string | null
- Description
Timestamp the parent entity was last updated.
- Name
deletedAt- Type
- string | null
- Description
Timestamp the parent entity was deleted.
Funding Details
- Name
source- Type
- FundingSource
- Description
Source of funding.
- Name
amount- Type
- FundingAmount
- Description
Amount of funding secured.
- Name
progress- Type
- FundingProgress
- Description
Current funding progress.
- Name
sourcedValue- Type
- number
- Description
Raw value of sourced function.
Funding Source
- Name
key- Type
- string
- Description
Funding source key.
- Name
localisedSource- Type
- string
- Description
Localised version of the source.
Funding Amount
- Name
committedAmount- Type
- number
- Description
Amount committed.
- Name
confirmedAmount- Type
- number
- Description
Amount confirmed.
- Name
totalAmount- Type
- number
- Description
Total amount funded.
- Name
remainingAmount- Type
- number
- Description
Remaining amount to fund.
Funding Progress
- Name
committedProgress- Type
- number
- Description
Progress of the committed amount.
- Name
confirmedProgress- Type
- number
- Description
Progress of the confirmed amount.
- Name
overFundedProgress- Type
- number
- Description
Progress of the over-funded amount.
- Name
totalProgress- Type
- number
- Description
Tota progress.
- Name
remainingProgress- Type
- number
- Description
Total left to fund.
Classification Details
- Name
id- Type
- string
- Description
Unique identifier of the global goals entity.
- Name
sdgs- Type
- number[] | [] | null
- Description
The numbers referencing the global goals
- Name
createdAt- Type
- string
- Description
Timestamp the parent entity was created.
- Name
updatedAt- Type
- string | null
- Description
Timestamp the parent entity was last updated.
- Name
deletedAt- Type
- string | null
- Description
Timestamp the parent entity was deleted.