Skip to main content
POST
Preview the settlement allocation waterfall

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Path Parameters

resolutionId
string
required

Resolution id

Query Parameters

organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Body

application/json
amountCents
integer
Required range: 0 <= x <= 100000000000
excludeExpenseIds
string[]
Maximum array length: 200
Required string length: 1 - 200
excludeLienIds
string[]
Maximum array length: 200
Required string length: 1 - 200
subtractExisting
boolean

Response

{ success: true, preview }

success
boolean
required
{key}
any