Skip to content

app.settlement_lines

TableRow level security on

Lines of a settlement. The amount is unsigned; the kind decides whether it adds or subtracts. A NULL amount is unpriced.

Primary key: id

Columns of app.settlement_lines
ColumnTypeNullableDescription
iduuidNoPrimary key, UUID v7.
org_iduuidNoOwning org, derived from app.settlements on insert; never accepted from the caller and never changed.References app.organizations.id
settlement_iduuidNoSettlement the line belongs to.References app.settlements.id
line_numberintegerNoOrder of the line.
line_kindapp.settlement_line_kindNoGuarantee, Bonus, Split, Expense, Deduction or Withholding.
descriptiontextNoWhat the line settles.
amount_minorbigintYesAmount in minor units of the settlement currency; NULL is unpriced.
deleted_attimestamp with time zoneYesSoft delete time. A row with deleted_at set is ignored by every access helper.
created_attimestamp with time zoneNoWhen the row was inserted. Set by the database.
created_byuuidYesPerson who inserted the row, or null for a platform process. Set by the database.References app.people.id
updated_attimestamp with time zoneNoWhen the row last changed. Set by the database.
updated_byuuidYesPerson who last changed the row, or null for a platform process. Set by the database.References app.people.id