DocsAPIShareholding

Update shareadjustment

Updates a shareadjustment.

PATCH
/shareholding/{id}
Path

Shareholding ID

Example: 12

Body

Example: 10

Example: 2024-03-31

Example: share_adjustment

Example: 1190476

Example: 100000

Example: 1

Example: 10

Example: 5000

Example: 20000

Example: false

Example: 10-for-1 split ahead of the Series B

Request Body

application/jsonOptional
portfolio_company_idstring

Move the record to another portfolio company. Required when switching type to share_issue, since a company-level record has no portfolio company to fall back on.

Pattern: "^\\d+$"
datestring

Date the event takes effect from

Pattern: "^\\d{4}-\\d{2}-\\d{2}$"
typestring

share_adjustment restates the share counts and share_split rebases them by a ratio, both across every fund. share_issue gives shares to this fund only.

Value in: "share_adjustment" | "share_split" | "share_issue"
shares_outstandinginteger

Shares outstanding after the event, fully diluted. Required for share_adjustment; derived from the ratio on a share_split unless split_override is set.

esopinteger

Option pool shares after the event. Required for share_adjustment; derived from the ratio on a share_split unless split_override is set.

split_ratio_frominteger

Shares before the split, per split_ratio_to. Splits only.

Minimum: 0
split_ratio_tointeger

Shares after the split, per split_ratio_from. Splits only.

Minimum: 0
shares_issued_to_fundinteger

Shares issued to the fund. Share issues only.

shares_issuedinteger

Total shares issued to all shareholders. Share issues only.

split_overrideboolean

Set the split's share counts by hand instead of deriving them from the ratio

descriptionstring

Internal comments

fieldsobject

Custom fields

Path Parameters

idRequiredstring

Shareholding ID

Pattern: "^\\d+$"

Credentials

Bearer
curl -X PATCH "https://api.fundra.com/v1/shareholding/12" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "portfolio_company_id": "10",
    "date": "2024-03-31",
    "type": "share_adjustment",
    "shares_outstanding": 1190476,
    "esop": 100000,
    "split_ratio_from": 1,
    "split_ratio_to": 10,
    "shares_issued_to_fund": 5000,
    "shares_issued": 20000,
    "split_override": false,
    "description": "10-for-1 split ahead of the Series B",
    "fields": {
      "property1": null,
      "property2": null
    }
  }'

Shareholding record updated

{
  "data": {
    "id": "12",
    "uuid": "V1StGXR8",
    "portfolio_company_id": "10",
    "company_id": "42",
    "date": "2024-03-31",
    "type": "share_adjustment",
    "shares_outstanding": 1190476,
    "esop": 100000,
    "split_ratio_from": 1,
    "split_ratio_to": 10,
    "shares_issued_to_fund": 5000,
    "shares_issued": 20000,
    "split_override": false,
    "description": "10-for-1 split ahead of the Series B",
    "fields": {
      "property1": null,
      "property2": null
    },
    "created_at": "2024-04-02T10:30:00Z",
    "updated_at": "2024-04-05T09:00:00Z"
  }
}

Previous

Add shareadjustmentPOST

Next

Delete shareadjustmentDELETE