FundSubscription GraphQL API
Explore the API at playground. We enforced a query complexity policy to prevent calls to Anduin's server, please follow the query complexity requirement as described here.
API Endpoints
# Production:
https://api.anduin.app/graphql
# Demo:
https://api-demo.anduin.app/graphql
Queries
getFundSubscription
Response
Returns a
FundSubscription
Arguments
Name | Description |
---|---|
id -
String!
|
Example
Query
query getFundSubscription($id: String!) {
getFundSubscription(id: $id) {
id
customFundId
name
admins {
...UserFragment
}
currency
closes {
...CloseFragment
}
tags {
...TagFragment
}
templates {
...TemplateFragment
}
referenceDocs {
...FileFragment
}
subFunds {
...SubFundFragment
}
orders {
...OrderFragment
}
supportingDocReviewEnabled
createdAt
inactiveNotificationEnabled
inactiveNotificationDuration
lastUpdatedAt
investorGroups {
...InvestorGroupFragment
}
advisorEntities {
...AdvisorEntityFragment
}
advisorTags {
...AdvisorTagFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getFundSubscription": {
"id": "abc123",
"customFundId": "xyz789",
"name": "xyz789",
"admins": [User],
"currency": "xyz789",
"closes": [Close],
"tags": [Tag],
"templates": [Template],
"referenceDocs": [File],
"subFunds": [SubFund],
"orders": [Order],
"supportingDocReviewEnabled": true,
"createdAt": "xyz789",
"inactiveNotificationEnabled": true,
"inactiveNotificationDuration": 123,
"lastUpdatedAt": "xyz789",
"investorGroups": [InvestorGroup],
"advisorEntities": [AdvisorEntity],
"advisorTags": [AdvisorTag]
}
}
}
getOrder
Example
Query
query getOrder($id: String!) {
getOrder(id: $id) {
id
customId
fund {
...FundSubscriptionFragment
}
orderType
mainContact {
...UserFragment
}
contacts {
...UserFragment
}
pendingContacts {
...UserFragment
}
investmentEntity
createdAt
lastUpdatedAt
lastActivityAt
lastReminderSentAt
lastReinvitationSentAt
submissionDate
seenByUsers {
...UserFragment
}
tags {
...TagFragment
}
close {
...CloseFragment
}
status
estimatedCommitmentAmount
submittedCommitmentAmount
acceptedCommitmentAmount
commitmentAmounts {
...SubFundCommitmentAmountFragment
}
referenceDocs {
...FileFragment
}
formFillingProgress
missingRequiredFields
missingRecommendedFields
supportingDocs {
...SupportingDocumentFragment
}
submittedDocs {
...OrderDocumentFragment
}
uploadedCountersignedDocs {
...OrderDocumentFragment
}
countersignedDocs {
...OrderDocumentFragment
}
emailBouncedContacts {
...UserFragment
}
amlKycReviews {
...AmlKycReviewFragment
}
unsignedSubscriptionReview {
...SubscriptionDocReviewInfoFragment
}
signedSubscriptionReview {
...SubscriptionDocReviewInfoFragment
}
amlKycDocsProvidedOffline
metadata {
...MetadataFieldFragment
}
clients {
...ClientFragment
}
subDocDataExtractionRequest {
...DataExtractionRequestFragment
}
amlCheck {
...AmlCheckFragment
}
investorSignedOnPaper
clientFormCompareData {
...ClientFormCompareDataFragment
}
investorGroup {
...InvestorGroupFragment
}
advisorEntity {
...AdvisorEntityFragment
}
advisorTags {
...AdvisorTagFragment
}
sideLetterStatus
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getOrder": {
"id": "xyz789",
"customId": "xyz789",
"fund": FundSubscription,
"orderType": "NORMAL",
"mainContact": User,
"contacts": [User],
"pendingContacts": [User],
"investmentEntity": "xyz789",
"createdAt": "abc123",
"lastUpdatedAt": "abc123",
"lastActivityAt": "xyz789",
"lastReminderSentAt": "xyz789",
"lastReinvitationSentAt": "abc123",
"submissionDate": "abc123",
"seenByUsers": [User],
"tags": [Tag],
"close": Close,
"status": "CHANGE_IN_PROGRESS",
"estimatedCommitmentAmount": 123.45,
"submittedCommitmentAmount": 987.65,
"acceptedCommitmentAmount": 123.45,
"commitmentAmounts": [SubFundCommitmentAmount],
"referenceDocs": [File],
"formFillingProgress": 123.45,
"missingRequiredFields": 123,
"missingRecommendedFields": 987,
"supportingDocs": [SupportingDocument],
"submittedDocs": [OrderDocument],
"uploadedCountersignedDocs": [OrderDocument],
"countersignedDocs": [OrderDocument],
"emailBouncedContacts": [User],
"amlKycReviews": [AmlKycReview],
"unsignedSubscriptionReview": SubscriptionDocReviewInfo,
"signedSubscriptionReview": SubscriptionDocReviewInfo,
"amlKycDocsProvidedOffline": [
"xyz789"
],
"metadata": [MetadataField],
"clients": [Client],
"subDocDataExtractionRequest": DataExtractionRequest,
"amlCheck": [AmlCheck],
"investorSignedOnPaper": true,
"clientFormCompareData": [ClientFormCompareData],
"investorGroup": InvestorGroup,
"advisorEntity": AdvisorEntity,
"advisorTags": [AdvisorTag],
"sideLetterStatus": "AGREED"
}
}
}
getSubFund
Example
Query
query getSubFund($id: String!) {
getSubFund(id: $id) {
id
customId
masterFund {
...FundSubscriptionFragment
}
currency
name
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getSubFund": {
"id": "abc123",
"customId": "abc123",
"masterFund": FundSubscription,
"currency": "abc123",
"name": "abc123"
}
}
}
queryFundSubscription
Response
Returns
[FundSubscription]
Example
Query
query queryFundSubscription(
$first: Int,
$offset: Int
) {
queryFundSubscription(
first: $first,
offset: $offset
) {
id
customFundId
name
admins {
...UserFragment
}
currency
closes {
...CloseFragment
}
tags {
...TagFragment
}
templates {
...TemplateFragment
}
referenceDocs {
...FileFragment
}
subFunds {
...SubFundFragment
}
orders {
...OrderFragment
}
supportingDocReviewEnabled
createdAt
inactiveNotificationEnabled
inactiveNotificationDuration
lastUpdatedAt
investorGroups {
...InvestorGroupFragment
}
advisorEntities {
...AdvisorEntityFragment
}
advisorTags {
...AdvisorTagFragment
}
}
}
Variables
{"first": 987, "offset": 987}
Response
{
"data": {
"queryFundSubscription": [
{
"id": "xyz789",
"customFundId": "abc123",
"name": "xyz789",
"admins": [User],
"currency": "xyz789",
"closes": [Close],
"tags": [Tag],
"templates": [Template],
"referenceDocs": [File],
"subFunds": [SubFund],
"orders": [Order],
"supportingDocReviewEnabled": true,
"createdAt": "abc123",
"inactiveNotificationEnabled": true,
"inactiveNotificationDuration": 987,
"lastUpdatedAt": "abc123",
"investorGroups": [InvestorGroup],
"advisorEntities": [AdvisorEntity],
"advisorTags": [AdvisorTag]
}
]
}
}
queryOrder
Example
Query
query queryOrder(
$first: Int,
$offset: Int
) {
queryOrder(
first: $first,
offset: $offset
) {
id
customId
fund {
...FundSubscriptionFragment
}
orderType
mainContact {
...UserFragment
}
contacts {
...UserFragment
}
pendingContacts {
...UserFragment
}
investmentEntity
createdAt
lastUpdatedAt
lastActivityAt
lastReminderSentAt
lastReinvitationSentAt
submissionDate
seenByUsers {
...UserFragment
}
tags {
...TagFragment
}
close {
...CloseFragment
}
status
estimatedCommitmentAmount
submittedCommitmentAmount
acceptedCommitmentAmount
commitmentAmounts {
...SubFundCommitmentAmountFragment
}
referenceDocs {
...FileFragment
}
formFillingProgress
missingRequiredFields
missingRecommendedFields
supportingDocs {
...SupportingDocumentFragment
}
submittedDocs {
...OrderDocumentFragment
}
uploadedCountersignedDocs {
...OrderDocumentFragment
}
countersignedDocs {
...OrderDocumentFragment
}
emailBouncedContacts {
...UserFragment
}
amlKycReviews {
...AmlKycReviewFragment
}
unsignedSubscriptionReview {
...SubscriptionDocReviewInfoFragment
}
signedSubscriptionReview {
...SubscriptionDocReviewInfoFragment
}
amlKycDocsProvidedOffline
metadata {
...MetadataFieldFragment
}
clients {
...ClientFragment
}
subDocDataExtractionRequest {
...DataExtractionRequestFragment
}
amlCheck {
...AmlCheckFragment
}
investorSignedOnPaper
clientFormCompareData {
...ClientFormCompareDataFragment
}
investorGroup {
...InvestorGroupFragment
}
advisorEntity {
...AdvisorEntityFragment
}
advisorTags {
...AdvisorTagFragment
}
sideLetterStatus
}
}
Variables
{"first": 123, "offset": 123}
Response
{
"data": {
"queryOrder": [
{
"id": "abc123",
"customId": "abc123",
"fund": FundSubscription,
"orderType": "NORMAL",
"mainContact": User,
"contacts": [User],
"pendingContacts": [User],
"investmentEntity": "abc123",
"createdAt": "abc123",
"lastUpdatedAt": "abc123",
"lastActivityAt": "xyz789",
"lastReminderSentAt": "abc123",
"lastReinvitationSentAt": "xyz789",
"submissionDate": "xyz789",
"seenByUsers": [User],
"tags": [Tag],
"close": Close,
"status": "CHANGE_IN_PROGRESS",
"estimatedCommitmentAmount": 987.65,
"submittedCommitmentAmount": 987.65,
"acceptedCommitmentAmount": 123.45,
"commitmentAmounts": [SubFundCommitmentAmount],
"referenceDocs": [File],
"formFillingProgress": 123.45,
"missingRequiredFields": 123,
"missingRecommendedFields": 987,
"supportingDocs": [SupportingDocument],
"submittedDocs": [OrderDocument],
"uploadedCountersignedDocs": [OrderDocument],
"countersignedDocs": [OrderDocument],
"emailBouncedContacts": [User],
"amlKycReviews": [AmlKycReview],
"unsignedSubscriptionReview": SubscriptionDocReviewInfo,
"signedSubscriptionReview": SubscriptionDocReviewInfo,
"amlKycDocsProvidedOffline": [
"abc123"
],
"metadata": [MetadataField],
"clients": [Client],
"subDocDataExtractionRequest": DataExtractionRequest,
"amlCheck": [AmlCheck],
"investorSignedOnPaper": true,
"clientFormCompareData": [ClientFormCompareData],
"investorGroup": InvestorGroup,
"advisorEntity": AdvisorEntity,
"advisorTags": [AdvisorTag],
"sideLetterStatus": "AGREED"
}
]
}
}
querySubFund
Example
Query
query querySubFund(
$first: Int,
$offset: Int
) {
querySubFund(
first: $first,
offset: $offset
) {
id
customId
masterFund {
...FundSubscriptionFragment
}
currency
name
}
}
Variables
{"first": 987, "offset": 987}
Response
{
"data": {
"querySubFund": [
{
"id": "xyz789",
"customId": "xyz789",
"masterFund": FundSubscription,
"currency": "abc123",
"name": "abc123"
}
]
}
}
Types
AdvisorEntity
Fields
Field Name | Description |
---|---|
id -
String!
|
|
name -
String!
|
|
fund -
FundSubscription
|
Example
{
"id": "abc123",
"name": "xyz789",
"fund": FundSubscription
}
AdvisorTag
Description
A textual descriptive element used to categorize orders by advisor characteristics.
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the AdvisorTag is created. |
name -
String!
|
The label of the AdvisorTag applied upon creation. This is the value actually illustrated on the platform. |
fund -
FundSubscription
|
The FundSubscription to which the AdvisorTag is associated. |
Example
{
"id": "xyz789",
"name": "abc123",
"fund": FundSubscription
}
AmlCheck
Fields
Field Name | Description |
---|---|
id -
String!
|
|
status -
AmlCheckStatus!
|
Example
{"id": "abc123", "status": "NOT_STARTED"}
AmlCheckStatus
Values
Enum Value | Description |
---|---|
|
|
|
Example
"NOT_STARTED"
AmlKycReview
Boolean
Client
ClientFormCompareData
Close
Description
Houses the information pertaining to the planned close(s) of the fund subscription.
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the Close is created. |
fund -
FundSubscription
|
The FundSubscription associated with a given close. |
name -
String!
|
The descriptive name of the close provide upon creating the Close. |
customCloseId -
String
|
A custom id assigned to the Close upon creating the Close. |
targetDate -
String
|
The planned completion of the Close assigned upon creation of the Close. |
Example
{
"id": "xyz789",
"fund": FundSubscription,
"name": "xyz789",
"customCloseId": "xyz789",
"targetDate": "abc123"
}
DataExtractionRequest
Fields
Field Name | Description |
---|---|
id -
String!
|
|
status -
DataExtractionRequestStatus!
|
|
missingRequiredFields -
Int!
|
|
missingRecommendedFields -
Int!
|
Example
{
"id": "abc123",
"status": "APPROVED",
"missingRequiredFields": 987,
"missingRecommendedFields": 123
}
DataExtractionRequestStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"APPROVED"
DocType
Values
Enum Value | Description |
---|---|
|
Form has been countersigned by member of the fund side. |
|
Main subscription document has been completed by investors but not yet signed. |
|
Main subscription document has been completed and signed by investors. |
|
Other type of documents. |
|
Anduin signature certificate for e-signed documents. |
|
Supporting documents submitted by investors. |
Example
"CountersignedDoc"
File
Example
{
"id": "abc123",
"name": "xyz789",
"uploader": User,
"uploadedAt": "abc123"
}
Float
Example
123.45
FundSubDocType
Values
Enum Value | Description |
---|---|
|
Form has been countersigned by member of the fund side. |
|
Main subscription document has been completed by investors but not yet signed. |
|
Main subscription document has been completed and signed by investors. |
|
Other type of documents. |
|
Anduin signature certificate for e-signed documents. |
|
Supporting documents submitted by investors. |
|
Deprecated doc type. |
Example
"CountersignedDoc"
FundSubscription
Description
The umbrella under which the additional elements and objects for fund will be housed. You may have one or more FundSubscriptions on the platform
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the FundSubscription is created. |
customFundId -
String
|
A custom String that references a fund. |
name -
String
|
The name of the Fund. |
admins -
[User!]
|
Users in the FundSubscription who have the role of admin. |
currency -
String!
|
The currency in which the fund and corresponding order will be transacted in. |
closes -
[Close!]
|
The planned completion of the fund raise by which investors must have all documentation completed. |
tags -
[Tag!]
|
Supplemental textual elements. This can be used as a filtering category in advanced dashboard. |
templates -
[Template!]
|
The available templates for this fund. |
referenceDocs -
[File!]
|
the uploaded documents associated with the fundSubscription. |
subFunds -
[SubFund!]
|
The sub-funds of the fund |
orders -
[Order]
|
The orders contained within the fund |
supportingDocReviewEnabled -
Boolean
|
|
createdAt -
String
|
A system generated timestamp upon the creation of the fund. |
inactiveNotificationEnabled -
Boolean!
|
WIP |
inactiveNotificationDuration -
Int!
|
WIP |
lastUpdatedAt -
String
|
A timestamp of the last update to the fund. |
investorGroups -
[InvestorGroup!]
|
The investor groups of the fund. |
advisorEntities -
[AdvisorEntity!]
|
The advisor entities linked to the fund. |
advisorTags -
[AdvisorTag!]
|
Advisor tags for categorizing orders by advisor characteristics. |
Example
{
"id": "abc123",
"customFundId": "abc123",
"name": "abc123",
"admins": [User],
"currency": "xyz789",
"closes": [Close],
"tags": [Tag],
"templates": [Template],
"referenceDocs": [File],
"subFunds": [SubFund],
"orders": [Order],
"supportingDocReviewEnabled": false,
"createdAt": "xyz789",
"inactiveNotificationEnabled": true,
"inactiveNotificationDuration": 123,
"lastUpdatedAt": "abc123",
"investorGroups": [InvestorGroup],
"advisorEntities": [AdvisorEntity],
"advisorTags": [AdvisorTag]
}
Int
Example
987
InvestorGroup
Fields
Field Name | Description |
---|---|
id -
String!
|
|
name -
String!
|
|
fund -
FundSubscription
|
Example
{
"id": "abc123",
"name": "abc123",
"fund": FundSubscription
}
MetadataField
Order
Description
A single subscription for a single investment entity investment entity. An investment entity or user may be involved with multiple orders.
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the Order is created. |
customId -
String
|
A customString that may be injected at the time of creation of the order. Typically a value associated the investment entity sourced from the customer CRM or other customer internal repositories. |
fund -
FundSubscription
|
The associated FundSubscription. |
orderType -
OrderType!
|
Indicates the type of subscription, either a normal or offline subscription, where offline would indicate documents have been completed external to the platform. |
mainContact -
User!
|
An user associated as the "primary" or "owner" of a given investment entity. |
contacts -
[User!]!
|
an array of the User(s) associated with the given order. |
pendingContacts -
[User!]!
|
The users who have not yet accepted their invitation to the platform. |
investmentEntity -
String!
|
The name of the individual or entity who will own the given security. |
createdAt -
String
|
A system generated timestamp upon the creation of the order. |
lastUpdatedAt -
String
|
A timestamp of the last update to the order. |
lastActivityAt -
String
|
WIP |
lastReminderSentAt -
String
|
A timestamp of the last reminder sent to user(s). |
lastReinvitationSentAt -
String
|
A timestamp of the last re-invitation sent to user(s). |
submissionDate -
String
|
A timestamp of when the order was submitted. |
seenByUsers -
[User!]
|
WIP |
tags -
[Tag!]
|
An array of tags associated with the order. |
close -
Close
|
The close to which the order is associated. |
status -
OrderStatus!
|
The status of the order. |
estimatedCommitmentAmount -
Float
|
An optional pre-emptive value provided by the fund based upon previous conversations or expressed interest amount from the data room or other means. |
submittedCommitmentAmount -
Float
|
The commitment amount identified in the submitted subscription document. |
acceptedCommitmentAmount -
Float
|
The commitment amount accepted by the Fund post review. |
commitmentAmounts -
[SubFundCommitmentAmount!]
|
The array of commitment amounts of this order. A order can have multiple commitment amount if the fund contain sub funds. |
referenceDocs -
[File!]
|
The array of reference documents provided by either the MainLp or collaborators. |
formFillingProgress -
Float
|
The completion progress of the investor based upon which fields in the subscription form are required. |
missingRequiredFields -
Int
|
Required fields from the subscription form that have not yet been completed. |
missingRecommendedFields -
Int
|
Recommended fields from the subscription form that have not yet been completed. |
supportingDocs -
[SupportingDocument!]
|
The array of supporting documents for the Subscription. |
submittedDocs -
[OrderDocument!]!
|
The versions of completed subscription form that have been signed and submitted. |
uploadedCountersignedDocs -
[OrderDocument!]!
|
Documents that have been countersigned and uploaded to the platform but have NOT YET distributed to the investors. |
countersignedDocs -
[OrderDocument!]!
|
Countersigned documents that have been distributed to the investors side. |
emailBouncedContacts -
[User!]
|
Users whose email addresses returned undeliverable from invitations. |
amlKycReviews -
[AmlKycReview!]
|
|
unsignedSubscriptionReview -
SubscriptionDocReviewInfo
|
|
signedSubscriptionReview -
SubscriptionDocReviewInfo
|
|
amlKycDocsProvidedOffline -
[String!]
|
AML/KYC documents that this investor provided offline |
metadata -
[MetadataField!]
|
Metadata attached to this order |
clients -
[Client!]
|
The clients to which the order is associated (only with fund integrated with Investor Data Management) |
subDocDataExtractionRequest -
DataExtractionRequest
|
The data extraction request of the submitted documents (feature is in development) |
amlCheck -
[AmlCheck!]
|
Aml checks for investor and related personas |
investorSignedOnPaper -
Boolean
|
Investor wet signed the subscription doc and uploaded the documents. |
clientFormCompareData -
[ClientFormCompareData!]
|
The master profile comparison result when an order is associated with a client (not for public API usage) |
investorGroup -
InvestorGroup
|
The investor group associated with each order |
advisorEntity -
AdvisorEntity
|
The advisor entity associated with each order |
advisorTags -
[AdvisorTag!]
|
The advisor tags associated with each order |
sideLetterStatus -
SideLetterStatus
|
The status of the side letter (feature is in development) |
Example
{
"id": "abc123",
"customId": "xyz789",
"fund": FundSubscription,
"orderType": "NORMAL",
"mainContact": User,
"contacts": [User],
"pendingContacts": [User],
"investmentEntity": "xyz789",
"createdAt": "xyz789",
"lastUpdatedAt": "abc123",
"lastActivityAt": "abc123",
"lastReminderSentAt": "xyz789",
"lastReinvitationSentAt": "xyz789",
"submissionDate": "abc123",
"seenByUsers": [User],
"tags": [Tag],
"close": Close,
"status": "CHANGE_IN_PROGRESS",
"estimatedCommitmentAmount": 123.45,
"submittedCommitmentAmount": 123.45,
"acceptedCommitmentAmount": 123.45,
"commitmentAmounts": [SubFundCommitmentAmount],
"referenceDocs": [File],
"formFillingProgress": 987.65,
"missingRequiredFields": 987,
"missingRecommendedFields": 123,
"supportingDocs": [SupportingDocument],
"submittedDocs": [OrderDocument],
"uploadedCountersignedDocs": [OrderDocument],
"countersignedDocs": [OrderDocument],
"emailBouncedContacts": [User],
"amlKycReviews": [AmlKycReview],
"unsignedSubscriptionReview": SubscriptionDocReviewInfo,
"signedSubscriptionReview": SubscriptionDocReviewInfo,
"amlKycDocsProvidedOffline": ["xyz789"],
"metadata": [MetadataField],
"clients": [Client],
"subDocDataExtractionRequest": DataExtractionRequest,
"amlCheck": [AmlCheck],
"investorSignedOnPaper": false,
"clientFormCompareData": [ClientFormCompareData],
"investorGroup": InvestorGroup,
"advisorEntity": AdvisorEntity,
"advisorTags": [AdvisorTag],
"sideLetterStatus": "AGREED"
}
OrderDocument
Description
Contains a file with its doc type (in a context of a Subscription).
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the OrderDocument is created. |
file -
File
|
The file for which the LpDocument is associated. |
docType -
FundSubDocType
|
The type of document. |
documentType -
DocType
|
The type of document. |
order -
Order
|
The order this document belongs to. |
Example
{
"id": "abc123",
"file": File,
"docType": "CountersignedDoc",
"documentType": "CountersignedDoc",
"order": Order
}
OrderStatus
Description
Used to represent possible statuses of an order.
Values
Enum Value | Description |
---|---|
|
The form is being edited after the GP request to update it. |
|
The countersigned form has been shared with order. |
|
The form has been countersigned but not yet shared with the order. |
|
Deprecated status. |
|
The signed form is approved by the fund |
|
The form is being edited. |
|
The contacts for the order have been invited though they have not started editing the form. |
|
The signed form is waiting to be approved by the fund. |
|
The form is waiting to be submitted. |
|
The unsigned form is waiting to be reviewed by the fund. |
|
The order has been removed from the fund subscription. |
|
The form is waiting to be signed. |
|
Deprecated status. |
|
The signed form has been submitted to the fund by the investor. |
Example
"CHANGE_IN_PROGRESS"
OrderType
Description
Determine whether the order contacts have been invited.
Values
Enum Value | Description |
---|---|
|
|
|
Example
"NORMAL"
ReviewStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"APPROVED"
SideLetterStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AGREED"
String
Example
"xyz789"
SubFund
Fields
Field Name | Description |
---|---|
id -
String!
|
|
customId -
String
|
|
masterFund -
FundSubscription
|
|
currency -
String
|
|
name -
String
|
Example
{
"id": "xyz789",
"customId": "abc123",
"masterFund": FundSubscription,
"currency": "abc123",
"name": "xyz789"
}
SubFundCommitmentAmount
Fields
Field Name | Description |
---|---|
id -
String!
|
|
subFund -
SubFund
|
|
estimatedCommitmentAmount -
Float
|
An optional pre-emptive value provided by the fund based upon previous conversations or expressed interest amount from the data room or other means. |
submittedCommitmentAmount -
Float
|
The commitment amount identified in the submitted subscription document. |
acceptedCommitmentAmount -
Float
|
The commitment amount accepted by the Fund post review. |
Example
{
"id": "xyz789",
"subFund": SubFund,
"estimatedCommitmentAmount": 987.65,
"submittedCommitmentAmount": 123.45,
"acceptedCommitmentAmount": 987.65
}
SubscriptionDocReviewInfo
Fields
Field Name | Description |
---|---|
id -
String!
|
|
versionIndex -
Int!
|
|
status -
ReviewStatus
|
|
currentPendingStepId -
String
|
For internal use only! |
Example
{
"id": "xyz789",
"versionIndex": 987,
"status": "APPROVED",
"currentPendingStepId": "abc123"
}
SupportingDocument
Description
Containing the supporting documents for a Subscription.
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the Document is indicated as required. |
order -
Order
|
The order to which the document has been associated. |
name -
String!
|
The name of the document requested per the corresponding FormQuestionData. |
markedAsNa -
Boolean!
|
An indicator field, indicating the relevant of a given document requirement. Marking the document as NA, removes it from the requirement list for a given order. |
submitted -
Boolean!
|
A flag to quickly check it this document is submitted i.e. submittedDocs is non-empty. |
submittedDocs -
[OrderDocument!]!
|
The array of submitted documents. |
Example
{
"id": "abc123",
"order": Order,
"name": "xyz789",
"markedAsNa": true,
"submitted": true,
"submittedDocs": [OrderDocument]
}
Tag
Description
A textual descriptive element often used to enrich the dashboards or workflow by providing supplemental information.
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the Tag is created. |
fund -
FundSubscription
|
The FundSubscription to which the Tag is associated. |
orders -
[Order]
|
The array of orders where this Tag has been applied. |
name -
String!
|
The label of the Tag applied upon creation. This is the value actually illustrated on the platform. |
creator -
User
|
The user who created the Tag. |
createdAt -
String
|
The time at which the Tag was created. |
Example
{
"id": "abc123",
"fund": FundSubscription,
"orders": [Order],
"name": "xyz789",
"creator": User,
"createdAt": "abc123"
}
Template
Description
Template for import/export form data.
Fields
Field Name | Description |
---|---|
id -
String!
|
|
name -
String!
|
Name of the template. |
templateType -
TemplateType
|
Description about the last update. |
lastChangeDescription -
String!
|
Description about the last update. |
spreadsheetFile -
File
|
The sample spreadsheet file. |
columns -
[TemplateColumn!]!
|
List of columns of the spreadsheet. |
createdBy -
User
|
The user who created the template. |
createdAt -
String
|
A system generated timestamp upon the creation of the template. |
lastUpdatedAt -
String
|
A timestamp of the last update to the template. |
Example
{
"id": "abc123",
"name": "xyz789",
"templateType": "EXPORT",
"lastChangeDescription": "abc123",
"spreadsheetFile": File,
"columns": [TemplateColumn],
"createdBy": User,
"createdAt": "xyz789",
"lastUpdatedAt": "xyz789"
}
TemplateColumn
TemplateType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"EXPORT"
User
Description
Stores the data about a particular user of the platform.
Fields
Field Name | Description |
---|---|
id -
String!
|
A system generated value provided at the time the user is created. |
email -
String!
|
The email address associated with a given user profile |
firstName -
String!
|
The first name of the user on the profile |
lastName -
String!
|
The first name of the user on the profile |
Example
{
"id": "xyz789",
"email": "abc123",
"firstName": "abc123",
"lastName": "abc123"
}