DocsAPIProceeds

Update proceed

Updates a proceed. Only the fields present in the payload are changed; send null to clear one.

PATCH
/proceeds/{id}
Path

Proceed ID

Example: 3

Body

Example: 2024-05-20

Example: divestment

Example: Trade sale

Example: 2500000

Example: 95238

Example: 1000000

Example: false

Example: Partial exit alongside the Series C

Request Body

application/jsonOptional
datestring

Transaction date

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

What kind of proceed this is

Value in: "interest" | "dividends" | "divestment" | "divestment_payout"
divestment_typestring

How the holding was exited. Required for divestments. Use Token sale when tokens rather than shares were sold – it reduces the fund's tokens instead of its shareholding.

Value in: "Trade sale" | "Secondary sale" | "IPO" | "Liquidation" | "Bankruptcy" | "Token sale"
proceeds_receivednumber

Amount received, in the fund's currency

shares_exitednumber

Shares sold in the transaction – or tokens, for a Token sale, where fractional amounts are allowed. Required for divestments.

fund_divestmentnumber

Acquisition cost divested, in the fund's currency. Optional – left unset it is derived from the shares exited.

is_valuation_basisboolean

Whether the share price (or token price, for a Token sale) implied by this divestment becomes the valuation basis

commentsstring

Internal comments

fieldsobject

Custom fields

Path Parameters

idRequiredstring

Proceed ID

Pattern: "^\\d+$"

Credentials

Bearer
curl -X PATCH "https://api.fundra.com/v1/proceeds/3" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2024-05-20",
    "proceed_type": "divestment",
    "divestment_type": "Trade sale",
    "proceeds_received": 2500000,
    "shares_exited": 95238,
    "fund_divestment": 1000000,
    "is_valuation_basis": false,
    "comments": "Partial exit alongside the Series C",
    "fields": {
      "property1": null,
      "property2": null
    }
  }'

Proceed updated

{
  "data": {
    "id": "3",
    "uuid": "V1StGXR8",
    "portfolio_company_id": "10",
    "date": "2024-05-20",
    "proceed_type": "divestment",
    "divestment_type": "Trade sale",
    "proceeds_received": 2500000,
    "shares_exited": 95238,
    "fund_divestment": 1000000,
    "is_valuation_basis": false,
    "comments": "Partial exit alongside the Series C",
    "fields": {
      "property1": null,
      "property2": null
    },
    "created_at": "2024-05-21T10:30:00Z",
    "updated_at": "2024-05-22T09:00:00Z"
  }
}

Previous

Add proceedPOST

Next

Delete proceedDELETE