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
https://api-demo.anduin.app/graphqlQueries
getAdvisorEntity
Response
Returns an
AdvisorEntity
Arguments
| Name | Description |
|---|---|
id -
String!
|
Example
Query
query getAdvisorEntity($id: String!) {
getAdvisorEntity(id: $id) {
id
name
fund {
...FundSubscriptionFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getAdvisorEntity": {
"id": "xyz789",
"name": "abc123",
"fund": FundSubscription
}
}
}
getAmlCheck
getAmlKycReview
Response
Returns an
AmlKycReview
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query getAmlKycReview($id: ID!) {
getAmlKycReview(id: $id) {
id
docName
order {
...OrderFragment
}
status
updatedBy {
...UserFragment
}
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"getAmlKycReview": {
"id": "4",
"docName": "abc123",
"order": Order,
"status": "NOT_STARTED",
"updatedBy": User,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
getClient
getClientFormCompareData
Response
Returns a
ClientFormCompareData
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query getClientFormCompareData($id: ID!) {
getClientFormCompareData(id: $id) {
id
clientId
numOfDifferences
comparedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getClientFormCompareData": {
"id": "4",
"clientId": "abc123",
"numOfDifferences": 987,
"comparedAt": "2007-12-03T10:15:30Z"
}
}
}
getClose
Example
Query
query getClose($id: String!) {
getClose(id: $id) {
id
fund {
...FundSubscriptionFragment
}
name
customCloseId
targetDate
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getClose": {
"id": "abc123",
"fund": FundSubscription,
"name": "xyz789",
"customCloseId": "xyz789",
"targetDate": "2007-12-03T10:15:30Z"
}
}
}
getDataExtractionRequest
Response
Returns a
DataExtractionRequest
Arguments
| Name | Description |
|---|---|
id -
String!
|
Example
Query
query getDataExtractionRequest($id: String!) {
getDataExtractionRequest(id: $id) {
id
status
missingRequiredFields
missingRecommendedFields
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getDataExtractionRequest": {
"id": "xyz789",
"status": "IN_PROGRESS",
"missingRequiredFields": 987,
"missingRecommendedFields": 987
}
}
}
getFile
Example
Query
query getFile($id: String!) {
getFile(id: $id) {
id
name
uploader {
...UserFragment
}
uploadedAt
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getFile": {
"id": "abc123",
"name": "xyz789",
"uploader": User,
"uploadedAt": "2007-12-03T10:15:30Z"
}
}
}
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
advisorEntities {
...AdvisorEntityFragment
}
subFundsAggregate {
...SubFundAggregateResultFragment
}
advisorEntitiesAggregate {
...AdvisorEntityAggregateResultFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getFundSubscription": {
"id": "abc123",
"customFundId": "abc123",
"name": "abc123",
"admins": [User],
"currency": "abc123",
"closes": [Close],
"tags": [Tag],
"templates": [Template],
"referenceDocs": [File],
"subFunds": [SubFund],
"orders": [Order],
"supportingDocReviewEnabled": true,
"createdAt": "2007-12-03T10:15:30Z",
"inactiveNotificationEnabled": true,
"inactiveNotificationDuration": 123,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"advisorEntities": [AdvisorEntity],
"subFundsAggregate": SubFundAggregateResult,
"advisorEntitiesAggregate": AdvisorEntityAggregateResult
}
}
}
getMetadataField
Response
Returns a
MetadataField
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query getMetadataField($id: ID!) {
getMetadataField(id: $id) {
id
fieldName
value
}
}
Variables
{"id": 4}
Response
{
"data": {
"getMetadataField": {
"id": 4,
"fieldName": "xyz789",
"value": "abc123"
}
}
}
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
}
advisorEntity {
...AdvisorEntityFragment
}
commitmentAmountsAggregate {
...SubFundCommitmentAmountAggregateResultFragment
}
amlKycReviewsAggregate {
...AmlKycReviewAggregateResultFragment
}
metadataAggregate {
...MetadataFieldAggregateResultFragment
}
clientsAggregate {
...ClientAggregateResultFragment
}
amlCheckAggregate {
...AmlCheckAggregateResultFragment
}
clientFormCompareDataAggregate {
...ClientFormCompareDataAggregateResultFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getOrder": {
"id": "xyz789",
"customId": "abc123",
"fund": FundSubscription,
"orderType": "NORMAL",
"mainContact": User,
"contacts": [User],
"pendingContacts": [User],
"investmentEntity": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"lastActivityAt": "2007-12-03T10:15:30Z",
"lastReminderSentAt": "2007-12-03T10:15:30Z",
"lastReinvitationSentAt": "2007-12-03T10:15:30Z",
"submissionDate": "2007-12-03T10:15:30Z",
"seenByUsers": [User],
"tags": [Tag],
"close": Close,
"status": "NOT_STARTED",
"estimatedCommitmentAmount": 987.65,
"submittedCommitmentAmount": 987.65,
"acceptedCommitmentAmount": 123.45,
"commitmentAmounts": [SubFundCommitmentAmount],
"referenceDocs": [File],
"formFillingProgress": 987.65,
"missingRequiredFields": 987,
"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": false,
"clientFormCompareData": [ClientFormCompareData],
"advisorEntity": AdvisorEntity,
"commitmentAmountsAggregate": SubFundCommitmentAmountAggregateResult,
"amlKycReviewsAggregate": AmlKycReviewAggregateResult,
"metadataAggregate": MetadataFieldAggregateResult,
"clientsAggregate": ClientAggregateResult,
"amlCheckAggregate": AmlCheckAggregateResult,
"clientFormCompareDataAggregate": ClientFormCompareDataAggregateResult
}
}
}
getOrderDocument
Response
Returns an
OrderDocument
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query getOrderDocument($id: ID!) {
getOrderDocument(id: $id) {
id
file {
...FileFragment
}
docType
documentType
order {
...OrderFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getOrderDocument": {
"id": 4,
"file": File,
"docType": "FilledForm",
"documentType": "FilledForm",
"order": Order
}
}
}
getSubFund
Example
Query
query getSubFund($id: String!) {
getSubFund(id: $id) {
id
customId
masterFund {
...FundSubscriptionFragment
}
currency
name
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getSubFund": {
"id": "abc123",
"customId": "xyz789",
"masterFund": FundSubscription,
"currency": "abc123",
"name": "xyz789"
}
}
}
getSubFundCommitmentAmount
Response
Returns a
SubFundCommitmentAmount
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query getSubFundCommitmentAmount($id: ID!) {
getSubFundCommitmentAmount(id: $id) {
id
subFund {
...SubFundFragment
}
estimatedCommitmentAmount
submittedCommitmentAmount
acceptedCommitmentAmount
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getSubFundCommitmentAmount": {
"id": 4,
"subFund": SubFund,
"estimatedCommitmentAmount": 123.45,
"submittedCommitmentAmount": 987.65,
"acceptedCommitmentAmount": 123.45
}
}
}
getSubscriptionDocReviewInfo
Response
Returns a
SubscriptionDocReviewInfo
Arguments
| Name | Description |
|---|---|
id -
String!
|
Example
Query
query getSubscriptionDocReviewInfo($id: String!) {
getSubscriptionDocReviewInfo(id: $id) {
id
versionIndex
status
currentPendingStepId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"getSubscriptionDocReviewInfo": {
"id": "xyz789",
"versionIndex": 987,
"status": "NOT_STARTED",
"currentPendingStepId": "abc123"
}
}
}
getSupportingDocument
Response
Returns a
SupportingDocument
Arguments
| Name | Description |
|---|---|
id -
ID!
|
Example
Query
query getSupportingDocument($id: ID!) {
getSupportingDocument(id: $id) {
id
order {
...OrderFragment
}
name
markedAsNa
submitted
submittedDocs {
...OrderDocumentFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSupportingDocument": {
"id": 4,
"order": Order,
"name": "abc123",
"markedAsNa": false,
"submitted": false,
"submittedDocs": [OrderDocument]
}
}
}
getTag
Example
Query
query getTag($id: String!) {
getTag(id: $id) {
id
fund {
...FundSubscriptionFragment
}
orders {
...OrderFragment
}
name
creator {
...UserFragment
}
createdAt
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getTag": {
"id": "xyz789",
"fund": FundSubscription,
"orders": [Order],
"name": "abc123",
"creator": User,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
getTemplate
Example
Query
query getTemplate($id: String!) {
getTemplate(id: $id) {
id
name
templateType
lastChangeDescription
spreadsheetFile {
...FileFragment
}
columns {
...TemplateColumnFragment
}
createdBy {
...UserFragment
}
createdAt
lastUpdatedAt
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"getTemplate": {
"id": "abc123",
"name": "xyz789",
"templateType": "IMPORT",
"lastChangeDescription": "xyz789",
"spreadsheetFile": File,
"columns": [TemplateColumn],
"createdBy": User,
"createdAt": "2007-12-03T10:15:30Z",
"lastUpdatedAt": "2007-12-03T10:15:30Z"
}
}
}
getUser
Example
Query
query getUser(
$id: String,
$email: String
) {
getUser(
id: $id,
email: $email
) {
id
email
firstName
lastName
}
}
Variables
{
"id": "abc123",
"email": "abc123"
}
Response
{
"data": {
"getUser": {
"id": "abc123",
"email": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789"
}
}
}
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
advisorEntities {
...AdvisorEntityFragment
}
subFundsAggregate {
...SubFundAggregateResultFragment
}
advisorEntitiesAggregate {
...AdvisorEntityAggregateResultFragment
}
}
}
Variables
{"first": 987, "offset": 987}
Response
{
"data": {
"queryFundSubscription": [
{
"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": "2007-12-03T10:15:30Z",
"inactiveNotificationEnabled": false,
"inactiveNotificationDuration": 123,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"advisorEntities": [AdvisorEntity],
"subFundsAggregate": SubFundAggregateResult,
"advisorEntitiesAggregate": AdvisorEntityAggregateResult
}
]
}
}
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
}
advisorEntity {
...AdvisorEntityFragment
}
commitmentAmountsAggregate {
...SubFundCommitmentAmountAggregateResultFragment
}
amlKycReviewsAggregate {
...AmlKycReviewAggregateResultFragment
}
metadataAggregate {
...MetadataFieldAggregateResultFragment
}
clientsAggregate {
...ClientAggregateResultFragment
}
amlCheckAggregate {
...AmlCheckAggregateResultFragment
}
clientFormCompareDataAggregate {
...ClientFormCompareDataAggregateResultFragment
}
}
}
Variables
{"first": 987, "offset": 987}
Response
{
"data": {
"queryOrder": [
{
"id": "xyz789",
"customId": "abc123",
"fund": FundSubscription,
"orderType": "NORMAL",
"mainContact": User,
"contacts": [User],
"pendingContacts": [User],
"investmentEntity": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"lastActivityAt": "2007-12-03T10:15:30Z",
"lastReminderSentAt": "2007-12-03T10:15:30Z",
"lastReinvitationSentAt": "2007-12-03T10:15:30Z",
"submissionDate": "2007-12-03T10:15:30Z",
"seenByUsers": [User],
"tags": [Tag],
"close": Close,
"status": "NOT_STARTED",
"estimatedCommitmentAmount": 987.65,
"submittedCommitmentAmount": 123.45,
"acceptedCommitmentAmount": 123.45,
"commitmentAmounts": [SubFundCommitmentAmount],
"referenceDocs": [File],
"formFillingProgress": 987.65,
"missingRequiredFields": 123,
"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": true,
"clientFormCompareData": [ClientFormCompareData],
"advisorEntity": AdvisorEntity,
"commitmentAmountsAggregate": SubFundCommitmentAmountAggregateResult,
"amlKycReviewsAggregate": AmlKycReviewAggregateResult,
"metadataAggregate": MetadataFieldAggregateResult,
"clientsAggregate": ClientAggregateResult,
"amlCheckAggregate": AmlCheckAggregateResult,
"clientFormCompareDataAggregate": ClientFormCompareDataAggregateResult
}
]
}
}
querySubFund
Example
Query
query querySubFund(
$first: Int,
$offset: Int
) {
querySubFund(
first: $first,
offset: $offset
) {
id
customId
masterFund {
...FundSubscriptionFragment
}
currency
name
}
}
Variables
{"first": 123, "offset": 123}
Response
{
"data": {
"querySubFund": [
{
"id": "xyz789",
"customId": "abc123",
"masterFund": FundSubscription,
"currency": "abc123",
"name": "xyz789"
}
]
}
}
Types
AdvisorEntity
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
name -
String!
|
|
fund -
FundSubscription
|
Example
{
"id": "abc123",
"name": "xyz789",
"fund": FundSubscription
}
AdvisorEntityAggregateResult
AmlCheck
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
status -
AmlCheckStatus!
|
Example
{"id": "xyz789", "status": "NOT_STARTED"}
AmlCheckAggregateResult
AmlCheckStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
AmlKycReview
AmlKycReviewAggregateResult
Boolean
Description
The Boolean scalar type represents true or false.
Example
{}
Client
ClientAggregateResult
Example
{
"count": 123,
"idMin": "xyz789",
"idMax": "xyz789",
"nameMin": "abc123",
"nameMax": "abc123",
"customIdMin": "abc123",
"customIdMax": "abc123"
}
ClientFormCompareData
ClientFormCompareDataAggregateResult
Example
{
"count": 987,
"clientIdMin": "xyz789",
"clientIdMax": "abc123",
"numOfDifferencesMin": 987,
"numOfDifferencesMax": 987,
"numOfDifferencesSum": 987,
"numOfDifferencesAvg": 123.45,
"comparedAtMin": "2007-12-03T10:15:30Z",
"comparedAtMax": "2007-12-03T10:15:30Z"
}
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 -
DateTime
|
The planned completion of the Close assigned upon creation of the Close. |
Example
{
"id": "abc123",
"fund": FundSubscription,
"name": "xyz789",
"customCloseId": "xyz789",
"targetDate": "2007-12-03T10:15:30Z"
}
DataExtractionRequest
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
status -
DataExtractionRequestStatus!
|
|
missingRequiredFields -
Int!
|
|
missingRecommendedFields -
Int!
|
Example
{
"id": "abc123",
"status": "IN_PROGRESS",
"missingRequiredFields": 987,
"missingRecommendedFields": 987
}
DataExtractionRequestStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
DateTime
Description
The DateTime scalar type represents date and time as a string in RFC3339 format. For example: "1985-04-12T23:20:50.52Z" represents 20 mins 50.52 secs after the 23rd hour of Apr 12th 1985 in UTC.
Example
{}
DocType
Values
| Enum Value | Description |
|---|---|
|
|
Main subscription document has been completed by investors but not yet signed. |
|
|
Main subscription document has been completed and signed by investors. |
|
|
Anduin signature certificate for e-signed documents. |
|
|
Form has been countersigned by member of the fund side. |
|
|
Supporting documents submitted by investors. |
|
|
Other type of documents. |
Example
{}
File
Example
{
"id": "abc123",
"name": "xyz789",
"uploader": User,
"uploadedAt": "2007-12-03T10:15:30Z"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
{}
FundSubDocType
Values
| Enum Value | Description |
|---|---|
|
|
Main subscription document has been completed by investors but not yet signed. |
|
|
Main subscription document has been completed and signed by investors. |
|
|
Anduin signature certificate for e-signed documents. |
|
|
Deprecated doc type. |
|
|
Form has been countersigned by member of the fund side. |
|
|
Supporting documents submitted by investors. |
|
|
Other type of documents. |
Example
{}
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 ID 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 -
DateTime
|
A system generated timestamp upon the creation of the fund. |
inactiveNotificationEnabled -
Boolean!
|
WIP |
inactiveNotificationDuration -
Int!
|
WIP |
lastUpdatedAt -
DateTime
|
A timestamp of the last update to the fund. |
advisorEntities -
[AdvisorEntity!]!
|
The advisor entities linked to the fund. |
subFundsAggregate -
SubFundAggregateResult
|
|
advisorEntitiesAggregate -
AdvisorEntityAggregateResult
|
Example
{
"id": "abc123",
"customFundId": "abc123",
"name": "abc123",
"admins": [User],
"currency": "abc123",
"closes": [Close],
"tags": [Tag],
"templates": [Template],
"referenceDocs": [File],
"subFunds": [SubFund],
"orders": [Order],
"supportingDocReviewEnabled": false,
"createdAt": "2007-12-03T10:15:30Z",
"inactiveNotificationEnabled": false,
"inactiveNotificationDuration": 987,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"advisorEntities": [AdvisorEntity],
"subFundsAggregate": SubFundAggregateResult,
"advisorEntitiesAggregate": AdvisorEntityAggregateResult
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
{}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
{}
MetadataField
MetadataFieldAggregateResult
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 customID 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 -
DateTime
|
A system generated timestamp upon the creation of the order. |
lastUpdatedAt -
DateTime
|
A timestamp of the last update to the order. |
lastActivityAt -
DateTime
|
WIP |
lastReminderSentAt -
DateTime
|
A timestamp of the last reminder sent to user(s). |
lastReinvitationSentAt -
DateTime
|
A timestamp of the last re-invitation sent to user(s). |
submissionDate -
DateTime
|
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) |
advisorEntity -
AdvisorEntity
|
The advisor entity associated with each order |
commitmentAmountsAggregate -
SubFundCommitmentAmountAggregateResult
|
|
amlKycReviewsAggregate -
AmlKycReviewAggregateResult
|
|
metadataAggregate -
MetadataFieldAggregateResult
|
|
clientsAggregate -
ClientAggregateResult
|
|
amlCheckAggregate -
AmlCheckAggregateResult
|
|
clientFormCompareDataAggregate -
ClientFormCompareDataAggregateResult
|
Example
{
"id": "xyz789",
"customId": "abc123",
"fund": FundSubscription,
"orderType": "NORMAL",
"mainContact": User,
"contacts": [User],
"pendingContacts": [User],
"investmentEntity": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"lastActivityAt": "2007-12-03T10:15:30Z",
"lastReminderSentAt": "2007-12-03T10:15:30Z",
"lastReinvitationSentAt": "2007-12-03T10:15:30Z",
"submissionDate": "2007-12-03T10:15:30Z",
"seenByUsers": [User],
"tags": [Tag],
"close": Close,
"status": "NOT_STARTED",
"estimatedCommitmentAmount": 123.45,
"submittedCommitmentAmount": 987.65,
"acceptedCommitmentAmount": 123.45,
"commitmentAmounts": [SubFundCommitmentAmount],
"referenceDocs": [File],
"formFillingProgress": 123.45,
"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": true,
"clientFormCompareData": [ClientFormCompareData],
"advisorEntity": AdvisorEntity,
"commitmentAmountsAggregate": SubFundCommitmentAmountAggregateResult,
"amlKycReviewsAggregate": AmlKycReviewAggregateResult,
"metadataAggregate": MetadataFieldAggregateResult,
"clientsAggregate": ClientAggregateResult,
"amlCheckAggregate": AmlCheckAggregateResult,
"clientFormCompareDataAggregate": ClientFormCompareDataAggregateResult
}
OrderDocument
Description
Contains a file with its doc type (in a context of a Subscription).
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
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": "4",
"file": File,
"docType": "FilledForm",
"documentType": "FilledForm",
"order": Order
}
OrderStatus
Description
Used to represent possible statuses of an order.
Values
| Enum Value | Description |
|---|---|
|
|
The contacts for the order have been invited though they have not started editing the form. |
|
|
The form is being edited. |
|
|
The form is being edited after the GP request to update it. |
|
|
The unsigned form is waiting to be reviewed by the fund. |
|
|
Deprecated status. |
|
|
The form is waiting to be signed. |
|
|
Deprecated status. |
|
|
The form is waiting to be submitted. |
|
|
The signed form is waiting to be approved by the fund. |
|
|
The signed form is approved by the fund |
|
|
The signed form has been submitted to the fund by the investor. |
|
|
The form has been countersigned but not yet shared with the order. |
|
|
The countersigned form has been shared with order. |
|
|
The order has been removed from the fund subscription. |
Example
{}
OrderType
Description
Determine whether the order contacts have been invited.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
ReviewStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
String
Description
The Stringscalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
{}
SubFund
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
customId -
String
|
|
masterFund -
FundSubscription
|
|
currency -
String
|
|
name -
String
|
Example
{
"id": "abc123",
"customId": "abc123",
"masterFund": FundSubscription,
"currency": "abc123",
"name": "abc123"
}
SubFundAggregateResult
Example
{
"count": 987,
"idMin": "abc123",
"idMax": "abc123",
"customIdMin": "abc123",
"customIdMax": "abc123",
"currencyMin": "abc123",
"currencyMax": "xyz789",
"nameMin": "abc123",
"nameMax": "xyz789"
}
SubFundCommitmentAmount
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
|
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": "4",
"subFund": SubFund,
"estimatedCommitmentAmount": 123.45,
"submittedCommitmentAmount": 987.65,
"acceptedCommitmentAmount": 987.65
}
SubFundCommitmentAmountAggregateResult
Fields
| Field Name | Description |
|---|---|
count -
Int
|
|
estimatedCommitmentAmountMin -
Float
|
|
estimatedCommitmentAmountMax -
Float
|
|
estimatedCommitmentAmountSum -
Float
|
|
estimatedCommitmentAmountAvg -
Float
|
|
submittedCommitmentAmountMin -
Float
|
|
submittedCommitmentAmountMax -
Float
|
|
submittedCommitmentAmountSum -
Float
|
|
submittedCommitmentAmountAvg -
Float
|
|
acceptedCommitmentAmountMin -
Float
|
|
acceptedCommitmentAmountMax -
Float
|
|
acceptedCommitmentAmountSum -
Float
|
|
acceptedCommitmentAmountAvg -
Float
|
Example
{
"count": 123,
"estimatedCommitmentAmountMin": 987.65,
"estimatedCommitmentAmountMax": 987.65,
"estimatedCommitmentAmountSum": 987.65,
"estimatedCommitmentAmountAvg": 987.65,
"submittedCommitmentAmountMin": 987.65,
"submittedCommitmentAmountMax": 987.65,
"submittedCommitmentAmountSum": 987.65,
"submittedCommitmentAmountAvg": 123.45,
"acceptedCommitmentAmountMin": 123.45,
"acceptedCommitmentAmountMax": 987.65,
"acceptedCommitmentAmountSum": 987.65,
"acceptedCommitmentAmountAvg": 123.45
}
SubscriptionDocReviewInfo
Fields
| Field Name | Description |
|---|---|
id -
String!
|
|
versionIndex -
Int!
|
|
status -
ReviewStatus
|
|
currentPendingStepId -
String
|
For internal use only! |
Example
{
"id": "abc123",
"versionIndex": 123,
"status": "NOT_STARTED",
"currentPendingStepId": "abc123"
}
SupportingDocument
Description
Containing the supporting documents for a Subscription.
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
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": "4",
"order": Order,
"name": "abc123",
"markedAsNa": true,
"submitted": false,
"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 -
DateTime
|
The time at which the Tag was created. |
Example
{
"id": "xyz789",
"fund": FundSubscription,
"orders": [Order],
"name": "abc123",
"creator": User,
"createdAt": "2007-12-03T10:15:30Z"
}
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 -
DateTime
|
A system generated timestamp upon the creation of the template. |
lastUpdatedAt -
DateTime
|
A timestamp of the last update to the template. |
Example
{
"id": "abc123",
"name": "abc123",
"templateType": "IMPORT",
"lastChangeDescription": "xyz789",
"spreadsheetFile": File,
"columns": [TemplateColumn],
"createdBy": User,
"createdAt": "2007-12-03T10:15:30Z",
"lastUpdatedAt": "2007-12-03T10:15:30Z"
}
TemplateColumn
TemplateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
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": "xyz789",
"lastName": "abc123"
}