Key Concepts
Get familiar with core terminologies in Anduin's Fund Subscription
Introduction
Acquaint yourself with the fundamental concepts and objects within Anduin's Fund Subscription product to optimize your utilization of the public API. This page serves as a guide, leading you through the primary components you will engage with using both GraphQL and REST API
Leveraging our public APIs enables automation of crucial tasks:
- Invite investors, optionally prefilling form data and metadata.
- Monitor investors' progress on their subscriptions through webhooks.
- Export investors' subscription data, including contacts and key information from the subscription form.
- Download investors' documents.
Main Objects
The Fund Subscription API serves as the gateway for customers to engage with different components within the workflow. While there are various objects available, the primary focus will typically revolve around two key concepts: FundSubscription and Order.
- FundSubscription: This object represents a singular fund environment within the Anduin platform. Depending on your specific configuration, a FundSubscription may contain one or multiple vehicles.
- Order: This object represents a single subscription form completed by an investor. In cases where an investor utilizes multiple investment entities to participate in a fundraise, they may have more than one order associated with a single FundSubscription.
A crucial concept in the API is the Close object, which represents a specific date when a group of investors in a fund completes their participation. Fund managers leverage this as a mechanism for categorizing investors within the FundSubscription. Fund structures may vary, with some having multiple distinct fund closings, while others maintain a single, continuous open-ended closing to which new investors are consistently added.
The following graph displays the relationship between these three objects:
Working with FundSubscription
The FundSubscription object is designed to provide general information about a particular environment. This includes details such as orders, closes, members of the fund side, supported import and export templates, and more. Refer below for the list of objects associated with FundSubscription.
FundSubscription
An environment enables Fund managers and Limited Partners to facilitate a subscription to a fund
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the FundSubscription is created | String |
| admins | Users on the fund side with access to the fund subscription | List[User] |
| currency | The currency on the fund dashboard used across the fund | String |
| closes | The planned completion of the fundraise by which investors must have all documentation completed. | List[Close] |
| tags | Supplemental textual elements | List[Tag] |
| referenceDocs | The list of documents the fund shares with all of the orders | List[File] |
| orders | The list of orders contained within the fund subscription | List[Order] |
| templates | The available template to import or export data for the fund | List[Template] |
Close
A specific date when a group of investors in a fund completes their participation
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the Close is created | String |
| fund | The FundSubscription to which the Close has been associated | List[Fund] |
| name | The descriptive name of the close provided upon creating the Close | String |
| targetDate | The planned completion of the Close assigned upon creation of the Close | DateTime |
Tag
Supplemental textual elements for the orders
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the Tag is created | String |
| fund | The FundSubscription to which the Tag has been applied | FundSubscription |
| orders | List of orders where this tag has been applied | Orders |
| name | The label applied for the tag | String |
| creator | The user who created the tag | User |
| createdAt | The timestamp at which the Tag was created. | DateTime |
Template
The available template to import or export data for the fund
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the template is created | String |
| name | Name of the template. | String |
| templateType | Type of the template, which specifies what the template can be used for. Can be either Import or Export. | TemplateType |
| lastChangeDescription | Description about the last update. | String |
| spreadsheetFile | The sample spreadsheet file for the template | File |
| columns | List of columns in the spreadsheet template | TemplateColumn |
| createdBy | The user who created the template. | User |
| createdAt | A system-generated timestamp upon the creation of the template. | DateTime |
| lastUpdatedAt | A timestamp of the last update to the template. | DateTime |
TemplateType
Type of the template, which specifies what the template can be used for.
| Field Name | Field Description | Data Type |
|---|---|---|
| Import | Template can be used to import data when inviting an investor | |
| Export | Template can be used to export data from submitted forms |
TemplateColumn
List of columns available in the spreadsheet template
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the template is created. | |
| index | The order of this column in the spreadsheet | |
| title | The column title |
Working with Order
The FundSubscription object is designed to provide exhaustive details about a specific subscription document. This encompasses crucial information such as the investor's subscription status, contact details, commitment amount, responses within the subscription document, and more. Customers can leverage this essential object to execute pivotal actions, including inviting investors, prefilling their subscription documents, and more.
Order
An order is a subscription of a single investment entity.
| Field Name | Field Description | Data Type |
|---|---|---|
| id | The ID the system generates for the order when it’s created and is unique within a fund | String |
| customId | The order ID set by the user. customId does not need to be unique. | String |
| orderType | Determine whether the order contacts have been invited. There can be 2 values:Normal: Contacts have been invitedOffline: Contacts haven't been invited | OrderType |
| investmentEntity | The name of the investment entity that will appear in the legal document. This value will be updated with the investor input in the form | String |
| mainLp | The email address of the named user associated as the "primary" or "owner" of an order. This email can't be removed. | User |
| collaborators | The other contacts associated with the order. They can be added and removed. | List[User] |
| close | The close associated with the order. | Close |
| status | The status of the subscription document. | OrderStatus |
| lastUpdatedAt | A timestamp of the order’s latest activity. This can be seen in the activity log of the order. | DateTime |
| expectedCommitment | The amount the fund expected the order to commit. | Float |
| submittedCommitment | The commitment amount provided in the FormQuestionData. | Float |
| acceptedCommitment | The commitment amount accepted by the Fund post review. | Float |
| formFillingProgress | The percentage of the form sections with all of the required fields completed | Float |
| pendingMembers | The contacts who have been invited to access the order but have not joined. | List[User] |
| createdAt | A system-generated timestamp upon the creation of the order | DateTime |
| lastReminderSentAt | A timestamp of the last reminder sent to users | DateTime |
| submittedDocs | The list of signed subscription documents that have been submitted by the investor | List[LpDocument] |
| countersignedDocs | Countersigned subscription documents that are not yet shared with the investor | List[LpDocument] |
| uploadedCountersignedDocs | List[LpDocument] | |
| requiredDocs | List of the documents the investor needs to submit for the order to be completed | List[RequiredDoc] |
| referenceDocs | The list of documents the fund shares with all of the orders | List[File] |
| supportingDocSignatureRequests | Additional documents that require the investor to sign | List[SignatureRequest] |
Order Status
The status of the subscription document
| Field Name | Field Description |
|---|---|
| NOT_STARTED | The contacts for the order have been invited though they have not started editing the form |
| IN_PROGRESS | The form is being edited |
| CHANGE_IN_PROGRESS | The form is being edited after the GP requests an update |
| PENDING_REVIEW | The unsigned form is waiting to be reviewed by the fund |
| REQUESTED_SIGNATURE | The form is waiting to be signed |
| PENDING_SUBMISSION | The form is waiting to be submitted |
| PENDING_REVIEW | The signed form is waiting to be approved by the fund |
| SUBMITTED | The signed form has been submitted to the fund by the investor |
| COUNTERSIGNED | The form has been countersigned but not yet shared with the investor |
| DISTRIBUTED | The countersigned form has been shared with the investor |
| REMOVED | The order has been removed from the fund subscription |
Other Objects
In addition to the primary objects, the Fund Subscription public API provides customers with access to an extensive array of objects within the workflow. The comprehensive list of these items is detailed below.
File
A file on the Anduin system
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the file is created | String |
| name | The name of the file that has been created. | String |
RequiredDoc
List of the documents the investor needs to submit for the order to be completed
| Field Name | Field Description | Data Type |
|---|---|---|
| name | The label of the required document | String |
| markedAsNA | The value indicates whether an investor has marked this document as not applicable to their subscription | Boolean |
| submitted | The value indicates whether an investor has submitted this document | Boolean |
FundSubDocType
Specify the type of document
| Field Name | Field Description |
|---|---|
| FilledForm | Main subscription document has been completed by investors but not yet signed |
| LpSignedDoc | Main subscription document has been completed and signed by investors |
| SigningCertificate | Anduin's signature certificate for e-signed documents |
| TaxForm | Tax form submitted by investors |
| CountersignedDoc | Form has been countersigned by a member of the fund side |
| SupportingDoc | Supporting documents submitted by investors |
| Others | Other type of documents |
User
A user on the Anduin system
| Field Name | Field Description | Data Type |
|---|---|---|
| id | A system-generated value provided at the time the user is created. | String |
| The email address associated with a given user profile | String | |
| firstName | The first name of the user on the profile | String |
| lastName | The last name of the user on the profile | String |
Updated 8 months ago