Operation results

A write answers 202 with its operation, and GET /v1/operations/{operationId} carries its result once it succeeds. Every result carries actor, role, authority, updateId and offset, as its operation does. A write that moves units or cash adds the fields below; a field absent from a step that has nothing to say is left out. Kinds: subscription.deliver · subscription.settle · redemption.settle · dealing-cycle.settle · standing-settlement.settle · distribution.execute · distribution.roll · holder.force-transfer · holder.recover · instrument.force-transfer · instrument.recover.

`subscription.deliver`

What subscription.deliver came to: the subscription bound to the Registrar’s mint of it, the holder’s row taking its units.

Field	What it carries
`subscriptionId`	The subscription delivered.
`state`	`delivered`.
`deliveredIn`	The reference of the Registrar’s mint it is bound to; the mint request’s contract where that is the subscription’s own id.
`mintRequestCid`	The holder’s mint request the Registrar accepted.
`mintOffset`	The offset of the Registrar’s accept.
`rowOpened`	Whether the delivery opened the holder’s row, the holder having none.
`note`	Present when an earlier run of the operation had submitted the command already.

`subscription.settle`

What subscription.settle came to: the next step of a subscription paid on the ledger, the ask its investor answers or the settlement.

Field	What it carries
`subscriptionId`	The subscription.
`payment`	The payment asset’s id.
`state`	`priced` while the investor is asked to pay, `delivered` once settled.
`orderState`	`awaiting-payment` while asked, `minted` once settled.
`amount`	What the investor pays in the payment asset.
`allocationRequestCid`	The allocation request the investor answers, made or found by this step; absent once settled.
`awaiting`	The investor’s allocations still awaited, the request being out already.
`released`	What the step released before asking again, the earlier request’s deadline having passed.
`released.allocations`	The investor’s allocations the venue cancelled, as their executor.
`released.allocationRequests`	The allocation requests it withdrew.
`deliveredIn`	Once settled, the subscription’s own id, which its lot is delivered under.
`rowOpened`	Once settled, whether it opened the holder’s row, the holder having none.
`note`	Present when an earlier run of the operation had submitted the command already.

`redemption.settle`

What redemption.settle came to: the next step of one paid on the ledger, its ask or its settlement, or its settlement on the Registrar’s burn.

Field	What it carries
`redemptionId`	The redemption.
`state`	`claimed` while its investor is asked, or its claim is written again; `settled` once settled.
`payment`	On a fund paid on the ledger, the payment asset’s id.
`orderState`	On a fund paid on the ledger: `claimed` while asked, `redeemed` once settled.
`amount`	On a fund paid on the ledger, what the investor is paid in the payment asset.
`allocationRequestCid`	The allocation request the investor answers, made or found by this step.
`awaiting`	The investor’s allocations still awaited, the request being out already.
`released`	What the step released, before asking again or with the claim written again.
`released.allocations`	The investor’s allocations the venue cancelled, as their executor.
`released.allocationRequests`	The allocation requests it withdrew.
`burnedIn`	Once settled, its burn: the Registrar’s burn request, or the redemption’s own id when settled against the payment asset.
`burnOffset`	Settled on the Registrar’s burn, the offset of its accept.
`subscriptions`	Once settled, the holder’s delivered subscriptions it redeemed from, oldest first.
`subscriptions[].subscriptionId`	The delivered subscription; its lot’s contract for one made under no id.
`subscriptions[].redeemed`	The units of it the redemption took.
`subscriptions[].closed`	Whether that was all it had left.
`unlotted`	Once settled, the units no delivered subscription carried.
`unmarked`	The payment asset the claim named and no longer does, its fund paid off the ledger now.
`replaces`	The claim contract written again without it.
`claimCid`	The claim contract written in its place.
`note`	Present when an earlier run of the operation had submitted the command already.

`dealing-cycle.settle`

What dealing-cycle.settle came to: the cycle settled in one transaction, or the orders whose allocations are awaited.

Field	What it carries
`dealingCycleId`	The dealing cycle.
`instrumentId`	The fund’s id on the Registry.
`payment`	The payment asset’s id.
`strike`	The one NAV every order deals at.
`orders`	The cycle’s orders, each as if it settled alone.
`orders[].kind`	What `id` names: a subscription or a redemption.
`orders[].id`	The subscription’s or the redemption’s id, by `kind`.
`orders[].holderId`	The order’s holder; null when no holder names its party.
`orders[].party`	The holder’s party.
`orders[].units`	The units of the fund.
`orders[].amount`	What it pays (rounded up) or is paid (rounded down) in the payment asset, as if alone.
`paidIn`	Every subscription’s payment into the fund’s payment account.
`paidOut`	Every redemption’s payout from it.
`net`	`paidIn` less `paidOut`; below zero, a net payout the treasury funds.
`state`	`awaiting-allocations` while an investor’s allocations are awaited, `settled` once settled.
`awaiting`	While awaited, each order still missing an allocation.
`awaiting[].kind`	What `id` names: a subscription or a redemption.
`awaiting[].id`	The subscription’s or the redemption’s id, by `kind`.
`awaiting[].holderId`	The order’s holder; null when no holder names its party.
`awaiting[].missing`	The investor’s allocations not on the ledger as the cycle asked them.
`treasuryFunding`	Once settled, what the treasury funded of a net payout; 0 when the cycle paid in net.
`treasuryInputs`	Once settled, the treasury’s holdings that funding came from.
`note`	Present when an earlier run of the operation had submitted the command already.

`standing-settlement.settle`

What standing-settlement.settle came to: one iteration, a sweep’s subscription or a pool’s redemption, settled or asked for.

Field	What it carries
`standingSettlementId`	The standing settlement.
`kind`	Its kind: a sweep settles a subscription, a liquidity pool pays a redemption.
`subscriptionId`	A sweep’s iteration: the subscription it settled.
`redemptionId`	A pool’s iteration: the redemption it paid or asked for.
`holderId`	The order’s holder; null when no holder names its party.
`units`	The units of the fund.
`nav`	A pool’s iteration: the fund oracle’s price of the claim.
`amount`	What the iteration pays in the payment asset.
`rest`	Once settled, what the sweep or the pool still commits.
`state`	`settled`; or `awaiting-allocations` while a pool’s redeemer has not allocated as the pool asked.
`allocationRequestCid`	While awaited, the pool’s allocation request for the claim.
`awaiting`	While awaited, the redeemer’s allocations not on the ledger as asked.
`note`	Present when an earlier run of the operation had submitted the command already.

`distribution.execute`

What distribution.execute came to: the plan frozen.

Field	What it carries
`distributionId`	The distribution it made.
`instrumentId`	The instrument’s id on the Registry.
`period`	The period, `uuuu-MM`.
`state`	Where the distribution stands once its plan is frozen.
`totalPayout`	What the plan pays: every line’s payout.
`holders`	The lines the plan pays.
`standingApproval`	Executed under a standing approval: the grant, its maker and its approvers.
`standingApproval.standingApprovalId`	The standing approval it ran under.
`standingApproval.maker`	Who made the grant, by `sub`.
`standingApproval.signedBy`	Who approved the grant, by `sub`.
`approvedBy`	The approver whose approval ran it, by `sub`; absent under a standing approval.
`recovered`	Present when the engine confirmed it from the distribution after a restart; the figures are then the distribution’s to read.

`distribution.roll`

What distribution.roll came to: each line whose payout reached its holder charged to the holder’s row.

Field	What it carries
`distributionId`	The distribution rolled.
`instrumentId`	The instrument’s id on the Registry.
`period`	The period, `uuuu-MM`.
`state`	Where the distribution stands after the roll.
`lines`	The plan’s lines.
`rolled`	The lines rolled, by this roll or an earlier one.
`pending`	The lines whose payout has not reached their holder yet.
`roll`	What the roll found for each line.
`roll[].account`	The Registry account of the line.
`roll[].account.owner`	The account’s owner.
`roll[].account.provider`	The account’s provider; null when it names none.
`roll[].account.id`	The account’s id within its owner and provider.
`roll[].payout`	The line’s payout.
`roll[].charged`	What the roll charges to the holder’s row: the payout and the withholding.
`roll[].withheld`	The line’s withholding.
`roll[].state`	What the roll found for the line.
`roll[].detail`	What the roll found, in its words.
`roll[].commandId`	The command that rolled it; null where nothing was submitted.
`roll[].rowCid`	The holder row the roll read; null where it found none.
`roll[].offset`	The offset the roll committed at; null where nothing was submitted.

`holder.force-transfer`

What a forced transfer or a recovery came to, of one holder or a batch: each move with its own ledger update.

Field	What it carries
`moves`	The moves made, each committed.
`moves[].fromHolderId`	The holder whose units moved.
`moves[].toHolderId`	The holder they moved to.
`moves[].instrumentId`	The instrument’s id on the Registry.
`moves[].units`	The units moved, a decimal in plain notation.
`moves[].rowsMoved`	Whether the holders’ rows moved with the units, the instrument rebasing.
`moves[].blockListLifted`	Whether the move took a holder the Registrar lists off its block list, and back on.
`moves[].updateId`	The ledger update the move committed in; null where an earlier run had submitted it.
`transactions`	The ledger transactions they took: one, or one per move where a move lifts a listed holder.
`kind`	The power used: a forced transfer or a recovery.
`rationale`	Why the units were moved.
`instrumentId`	A batch’s instrument, which every move moves.
`restrictionsCarried`	A recovery’s restrictions carried to the successor, by id.
`approvedBy`	The approver whose approval ran it, by `sub`.
`signedBy`	Every approver who signed it off, by `sub`.

`holder.recover`

What a forced transfer or a recovery came to, of one holder or a batch: each move with its own ledger update.

Field	What it carries
`moves`	The moves made, each committed.
`moves[].fromHolderId`	The holder whose units moved.
`moves[].toHolderId`	The holder they moved to.
`moves[].instrumentId`	The instrument’s id on the Registry.
`moves[].units`	The units moved, a decimal in plain notation.
`moves[].rowsMoved`	Whether the holders’ rows moved with the units, the instrument rebasing.
`moves[].blockListLifted`	Whether the move took a holder the Registrar lists off its block list, and back on.
`moves[].updateId`	The ledger update the move committed in; null where an earlier run had submitted it.
`transactions`	The ledger transactions they took: one, or one per move where a move lifts a listed holder.
`kind`	The power used: a forced transfer or a recovery.
`rationale`	Why the units were moved.
`instrumentId`	A batch’s instrument, which every move moves.
`restrictionsCarried`	A recovery’s restrictions carried to the successor, by id.
`approvedBy`	The approver whose approval ran it, by `sub`.
`signedBy`	Every approver who signed it off, by `sub`.

`instrument.force-transfer`

What a forced transfer or a recovery came to, of one holder or a batch: each move with its own ledger update.

Field	What it carries
`moves`	The moves made, each committed.
`moves[].fromHolderId`	The holder whose units moved.
`moves[].toHolderId`	The holder they moved to.
`moves[].instrumentId`	The instrument’s id on the Registry.
`moves[].units`	The units moved, a decimal in plain notation.
`moves[].rowsMoved`	Whether the holders’ rows moved with the units, the instrument rebasing.
`moves[].blockListLifted`	Whether the move took a holder the Registrar lists off its block list, and back on.
`moves[].updateId`	The ledger update the move committed in; null where an earlier run had submitted it.
`transactions`	The ledger transactions they took: one, or one per move where a move lifts a listed holder.
`kind`	The power used: a forced transfer or a recovery.
`rationale`	Why the units were moved.
`instrumentId`	A batch’s instrument, which every move moves.
`restrictionsCarried`	A recovery’s restrictions carried to the successor, by id.
`approvedBy`	The approver whose approval ran it, by `sub`.
`signedBy`	Every approver who signed it off, by `sub`.

`instrument.recover`

What a forced transfer or a recovery came to, of one holder or a batch: each move with its own ledger update.

Field	What it carries
`moves`	The moves made, each committed.
`moves[].fromHolderId`	The holder whose units moved.
`moves[].toHolderId`	The holder they moved to.
`moves[].instrumentId`	The instrument’s id on the Registry.
`moves[].units`	The units moved, a decimal in plain notation.
`moves[].rowsMoved`	Whether the holders’ rows moved with the units, the instrument rebasing.
`moves[].blockListLifted`	Whether the move took a holder the Registrar lists off its block list, and back on.
`moves[].updateId`	The ledger update the move committed in; null where an earlier run had submitted it.
`transactions`	The ledger transactions they took: one, or one per move where a move lifts a listed holder.
`kind`	The power used: a forced transfer or a recovery.
`rationale`	Why the units were moved.
`instrumentId`	A batch’s instrument, which every move moves.
`restrictionsCarried`	A recovery’s restrictions carried to the successor, by id.
`approvedBy`	The approver whose approval ran it, by `sub`.
`signedBy`	Every approver who signed it off, by `sub`.

Related: Conventions · Webhook events

Get started

Instruments

Policies

Prices

Holders

Subscriptions

Redemptions

Dealing cycles

Reserves

Standing settlements

Distributions

Restrictions and issuer powers

Holds and pauses

Reconciliation

Approvals and operations

Reports

Events

System

`subscription.deliver`

`subscription.settle`

`redemption.settle`

`dealing-cycle.settle`

`standing-settlement.settle`

`distribution.execute`

`distribution.roll`

`holder.force-transfer`

`holder.recover`

`instrument.force-transfer`

`instrument.recover`

​subscription.deliver

​subscription.settle

​redemption.settle

​dealing-cycle.settle

​standing-settlement.settle

​distribution.execute

​distribution.roll

​holder.force-transfer

​holder.recover

​instrument.force-transfer

​instrument.recover

`subscription.deliver`

`subscription.settle`

`redemption.settle`

`dealing-cycle.settle`

`standing-settlement.settle`

`distribution.execute`

`distribution.roll`

`holder.force-transfer`

`holder.recover`

`instrument.force-transfer`

`instrument.recover`