This API creates an investee fund entity. The request body should be an object containing multiple fields. These fields can be found in the ‘Get Investee Custom Fields’ endpoint, where you can also check the required fields. The ‘fullName’ field must be unique and cannot be duplicated.
| Value |
|---|
Description | Create an investee fund entity. |
Path | /api/entities/investeefund/{scopeId} |
Method | POST |
Request Parameters |
- *scopeId:** Scope internal id that a new investee fund creates on that scope.
|
Request Body | {
“fullName”: string,
“totalCommitment”: number,
“fundCurrency”: string // 3 alphabets currency.
... // another field from ‘Get investee custom fields’ endpoint.
}
|
Responses |
- *200 (OK):** A new investee fund creates successfully.
- *400 (Bad Request):** Required fields aren’t provided.
- *400 (Bad Request):** ‘Full name’ duplicate with other existing investee funds.
- *401 (Unauthorized):** Access token is not valid.
- *403 (Forbidden):** Token has no permission.
|
This API updates an investee fund entity. The {fundIdOrInternalId} parameter must be a valid value within the scope. The request body should be an object containing multiple fields. These fields can be found in the ‘Get Investee Custom Fields’ endpoint, where you can also check the required fields. The ‘fullName’ field must be unique and cannot be duplicated.
| Value |
|---|
Description | Update an investee fund entity. |
Path | /api/entities/investeefund/{scopeId}/{fundIdOrInternalId} |
Method | PUT |
Request Parameters |
- *scopeId:** Scope internal id that a new investee fund creates on that scope.
- *fundIdOrInternalId:** The existing investee fund id or internal id that needs to update.
|
Request Body | {
“fullName”: string,
“totalCommitment”: number,
“fundCurrency”: string // 3 alphabets currency.
... // another field from ‘Get investee custom fields’ endpoint.
}
|
Responses |
- *200 (OK):** A new investee fund updates successfully.
- *400 (Bad Request): **Required fields aren’t provided.
- *400 (Bad Request):** ‘Full name’ duplicate with other existing investee funds.
- *401 (Unauthorized):** Access token is not valid.
- *403 (Forbidden):** Access token has no permission.
- *404 (Not found):** fundIdOrInternalId value does not exist in our system.
|
This API deactivates an investee fund entity. The {fundIdOrInternalId} parameter’s value must be valid and exist in the system.
| Value |
|---|
Description | Deactivate an investee fund entity. |
Path | /api/entities/investeefund/{scopeId}/{fundIdOrInternalId} |
Method | DELETE |
Request Parameters |
- *scopeId:** Scope internal id that a new investee fund creates on that scope.
- *fundIdOrInternalId: **The existing investee fund id or internal id that needs to update.
|
Request Body | N/A |
Responses |
- *200 (OK):** A new investee fund deactivates successfully.
- *401 (Unauthorized):** Access token is not valid.
- *403 (Forbidden):** Access token has no permission.
- *404 (Not found):** fundIdOrInternalId value does not exist in our system.
|
