GET
cURL
Roles: app, approver, auditor, operator, registrar, risk.

Authorizations

Authorization
string
header
required

A JWT from the deployment's identity provider, whose roles claim names the caller's roles and whose holder claim names an investor's holder.

Headers

X-Signature-Key
string

A signed request's key id, as venue.api.signing.clients configures it for the bearer's subject.

X-Signature-Timestamp
string

Seconds since the epoch, within venue.api.signing.window of the engine's clock, 5 minutes by default.

Pattern: ^[0-9]+$
X-Signature-Nonce
string

At least 16 random bytes in base64url, never reused within twice the window.

Required string length: 22 - 128
Pattern: ^[A-Za-z0-9_-]+={0,2}$
X-Signature
string

The base64 HMAC-SHA256, under the key's secret, of the method, the path and query, the timestamp, the nonce and the body's SHA-256.

X-Request-Id
string

Your id for this request, 1 to 128 printable characters, repeated in the answer; absent, the engine makes one.

Maximum string length: 128
Pattern: ^[\x21-\x7E]+$
traceparent
string

A W3C trace context, which the engine joins and passes on.

Pattern: ^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

Path Parameters

distributionId
string
required

The distribution's id.

Query Parameters

format
enum<string>
default:json

json, the default, for the export as JSON, or csv for a CSV file. The form a read answers in.

Available options:
json,
csv

Response

The frozen plan per account.

A distribution's frozen plan, per account.

distributionId
string
required

The distribution's id.

instrumentId
string
required

The instrument's id on the Registry.

isin
string | null
required

The instrument's ISIN, as the manifest records it; null when it records none.

currency
string | null
required

The ISO 4217 currency the instrument records; null when it records none.

recordDate
string | null
required

Its period's record date, yyyy-MM-dd, in the instrument's distribution calendar; null where the calendar gives none.

paymentDate
string | null
required

Its period's payment date, yyyy-MM-dd, in the instrument's distribution calendar; null where the calendar gives none.

entitledAt
string | null
required

The ledger time its plan read the holders' rows at, who was entitled to what; null where the projection cannot date it.

period
string
required

The period, uuuu-MM.

state
enum<string>
required

Where the distribution stands.

Available options:
awaiting-administrator,
payable,
held,
partial,
paid
navAsOf
string
required

The instant of the oracle point the plan is computed at.

nav
number
required

The NAV per unit.

withholdingRate
number
required

The withholding rate the point carries.

totalGross
number
required

The plan's gross, every line together.

totalWithheld
number
required

The plan's withholding, every line together.

totalPayout
number
required

The plan's payout, every line together.

lines
object[]
required

One line per account.