Entities

Returns every entity visible to the authenticated credential, across all clients it can reach, in the standard v1 list envelope.

Query parameters

client_idstring

Only the entities of this client. A malformed id is a 400; a client you cannot see lists nothing.

limitinteger

Page size. Defaults to 100, capped at 1 000.

cursorstring

Opaque cursor from the previous page's next_cursor. Omit for the first page.

Creates an entity under an existing client. Returns 201 with the created resource.

Body parameters

client_idstring

The client to create the entity under. Required.

namestring

Display name. Required, not blank.

kindstring

person, company, foundation, trust, fund or other. Required.

primary_currencystring

ISO 4217 code, three letters A-Z. Optional, DKK when left out.

Fetch a single entity by id. Returns the bare object, or a 404 problem when the id doesn't exist for this tenant.

Partially updates an entity. Only the fields present in the body are touched. client_id is immutable — an entity cannot move between clients.

Without effective_from the call is a correction: the entity was wrong all along. With effective_from it is a change of the primary currency from that day: the currency in force on the date ends the day before, the new one starts on it, and what stood before stays. A recalculation of the entity's figures from that day is queued. Both are logged with reason.

Body parameters

namestring

New display name. Must not be blank.

kindstring

person, company, foundation, trust, fund or other.

primary_currencystring

ISO 4217 code, three letters A-Z. null is a 422: an entity always has one.

effective_fromstring

YYYY-MM-DD, today or earlier (a later day is 422 effective_from_in_future): the day the new primary_currency starts. Only with primary_currency and no name, kind or valid_to; otherwise 422 effective_from_currency_only.

valid_tostring or null

The entity's last day, or null to open it again. Not before valid_from (400).

reasonstring

Why, for the change list. Optional, not blank.

A body without name, kind, primary_currency or valid_to is 422 empty_patch; primary_currency: null is 422 currency_required.

Ending an entity changes nothing else: its cash and custody accounts, the economic ownerships it is owner or owned in, and its tag assignments keep their own periods. The answer is the entity plus warnings: for a valid_to date, each of those rows that still holds after that day, as {code: "open_after_end", kind, id, valid_to}, with kind cash_account, custody_account, ownership or tag_assignment and the row's own last day (null when open), ordered by kind and id. End each one on its own route. Any other PATCH answers warnings: [].

Removes an entity that nothing uses. Returns 204 on success, 404 if the id doesn't exist for this tenant.

An entity with cash or custody accounts, transactions, holdings, figures computed on it, custodian positions, reconciliation breaks, ownerships, tags, custodian authorities, access grants, dated currency versions, price, exchange-rate or basic-data hierarchies set on it, documents, lens rules that name it, or assets built on it is not deleted: the answer is 409 in_use, and next_action points to PATCH /v1/entities/{id} with valid_to, which ends it instead.

A lens that only holds the entity through a broader rule, such as the client's structure lens (include client), does not block the delete. Neither do cash and custody accounts that were deleted before it. The entity leaves those lenses when it is deleted.

Who owns the entity on as_of (default today), with the owner's name, in the standard v1 list envelope with as_of. Same fields as an ownership, with ownership_id and owner_name. 404 if you cannot see the entity. Any other query parameter is a 400.

Query parameters

as_ofstring

YYYY-MM-DD. Defaults to today.

limitinteger

Page size. Defaults to 100, capped at 1 000.

cursorstring

Opaque cursor from the previous page's next_cursor.

Every ownership in force on as_of (default today) that you can see, ordered by owned entity, start and id, in the standard v1 list envelope with as_of. Takes as_of, limit and cursor; any other query parameter is a 400.

One ownership by id, whatever its period. 404 when it doesn't exist, you cannot see it, or it is a voting-only row.

Records that a party or an entity owns a share of an entity from valid_from (and up to valid_to, the last day, when it ends).

The economic shares of an entity may not pass 100 % on any of its cash or custody accounts on any day: that answers 400 ownership_over_100. Shares under 100 % are allowed while you build the structure, and the answer then carries a warning in warnings. An ownership that would make an entity own itself answers 400 ownership_cycle. The same owner owning the same entity in an overlapping period answers 409 ownership_overlap, with next_action on the existing ownership (PATCH, effective_from): change that one instead. A voting-only ownership does not count.

Body parameters

owner_kindstring

party or entity. Required.

owner_idstring

The owning party or entity. Required.

owned_entity_idstring

The entity owned. Required.

percentagestring

The share, a decimal string from 0 to 100. Required.

valid_fromstring

The first day. Required.

valid_tostring

The last day. Optional.

Response fields

warningsarray

shares_below_100 when the cash and custody accounts the ownership covers hold less than 100 % on some day of its period: allocated_percentage is the lowest sum in the period and on the first day it holds. Empty when they hold 100 %.

Corrects an ownership, or changes its share from a date. Returns 200 with the resulting ownership and warnings as on create, 404 if you cannot see the ownership, its owner, a new owner or the entity it owns.

Without effective_from the call is a correction: the ownership was wrong all along, and it is rewritten in its whole period under the same id. You may send percentage, owner_kind with owner_id, valid_from and valid_to (null for open-ended).

With effective_from the call is a change: the share is new from that day. The ownership ends the day before, and a new ownership with the new percentage runs from effective_from to the old end; the answer is the new one. Only percentage goes with effective_from, and the date must fall inside the ownership's period.

Both are logged as a change with reason. The share and cycle rules of create apply (400 ownership_over_100, 400 ownership_cycle), and a second ownership of the same owner starting the same day is 409 ownership_overlap. The owned entity cannot be changed.

Request fields

percentagestring

The share, a decimal string from 0 to 100.

owner_kindstring

party or entity, with owner_id. Correction only.

valid_fromstring

The first day. Correction only.

valid_tostring

The last day, or null. Correction only.

effective_fromstring

The day the new share starts.

reasonstring

Why, for the change list.

Removes an ownership no figure ever rested on, for a typing mistake. Returns 204, 404 if you cannot see the ownership, its owner or the entity it owns.

An ownership is used once its period holds data in the cash and custody accounts it reaches: transactions before it ends, or holdings, net asset values, custodian positions or manual holdings inside it, also further down through entities the owned entity owns. A used ownership answers 409 in_use with next_action end_date on PATCH /v1/ownerships/{id} (valid_to).

Closes an entity's period up to and including closed_through, or opens it again. The date is stored on the entity only. Two more routes take the same body and set the same date on several entities in one call: PUT /v1/clients/{id}/period-lock (the client's own entities) and PUT /v1/tenants/current/period-lock (every entity). There is no DELETE: an earlier date opens the days after it, and null opens everything.

Once a period is closed, a write dated on or before the date on a cash or custody account the lock covers answers 409 period_locked. To correct something in a closed period: unlock, register, then lock again. Each move is logged as a change (lock or unlock) with its reason.

Only an admin sets the lock (Aleta too, when every cash and custody account the call covers is one Aleta runs); anyone else gets 403 forbidden. Until your move to v1 is done the legacy platform's monthly lock is the one that counts, so the routes answer 409 legacy_managed. A refusal comes in that order: 400 for the body, 404 for an entity or client you cannot see, then 403, then 409. Takes dry_run and Idempotency-Key: a dry run answers what the call would lock and open, and changes nothing.

Body parameters

closed_throughstring or null

YYYY-MM-DD, today or earlier, or null to open everything. Required. A date in the future is a 400.

reasonstring

Why, for the change log. Optional.

Response

closed_throughstring or null

The date the call set.

entitiesarray

Every entity the call covers, by id, with entity_id, previous_closed_through and closed_through.

lockedarray

The covered cash and custody accounts (kind, id, entity_id) of the entities whose closed period grew.

unlockedarray

The covered cash and custody accounts of the entities whose closed period shrank.