Update fund

Update an existing fund. This is a full update: an omitted active deactivates the fund, and the startingBalances list replaces the existing unreconciled starting balances (omitting it removes them). The linked equity account's name, number, and category are kept in sync. First retrieve the current fund from /api/funds/{id}, apply your changes, then send back the full object.

Required permission: Accounting Settings

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the fund

Body Params

The current version of the fund

string | null
required

The fund's name.

string | null
required

The fund's display color, as a hex value.

boolean

Whether the fund is active. New funds are always created active.

int32 | null

The account number of the fund's linked equity account. Must be unique.

category
object | null

The category of the fund's linked equity account. On writes, provide the id or code.

startingBalances
array of objects | null

The starting balances entered for the fund, one per asset or liability account. On writes, the list replaces the existing unreconciled starting balances; omitting it removes them.

startingBalances
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json