Retainer

Object

_id

workspaceId

documentNumber

The number the workspace's retainer series issued this retainer, drawn at create the way an invoice draws its own. Unique within the workspace, and what every surface names the retainer by.

glCompanyId

The company whose books hold the funded credit — the write boundary's resolved answer, never the caller's raw input. Null on retainers created before company scope existed, which the default company's read bridge owns.

billingAgreementId

Commercial retainer this advance cash funds.

clientAccountId

customerAccountId

counterpartyName

The name of the client this retainer is held for, joined from the account it points at: customerAccountId where the retainer names one, else clientAccountId — the same pair every retainer posting stamps as its line counterparty. Null when the account cannot be resolved; the caller renders the absence rather than a raw id.

projectId

projectName

Name of the project this document is filed against, resolved at read time and scoped to what the requesting member may see. Null when the project no longer exists or is not visible to them — clients render their unlinked fallback for both, and must never assume the name of a project the reader cannot open.

originalAmount

balance

applications

currencyConversion

What a retainer in another currency was funded at, and what its funded credit is still carried at. Absent on a retainer in the workspace base currency.

paymentState

history

status

voidedAt

Set when the retainer is voided; the unused funded balance was reversed out of the liability.

voidedBy

voidReason

createdAt

modifiedAt

createdBy

modifiedBy