Skip to content

api_external.settlements

View

Settlements of the caller's engagements once submitted to them (Section 4.5.8 Artist Settlement), while the money area is open. Drafts and reworked settlements stay hidden until submitted again. The party accepts or disputes through app.respond_to_settlement.

Columns of api_external.settlements
ColumnTypeNullableDescription
iduuidYesSettlement.
engagement_iduuidYesEngagement settled.
project_iduuidYesProject.
project_nametextYesProject name.
settlement_numberbigintYesNumber from the project sequence.
titletextYesSettlement title.
currency_codecharacter(3)YesISO 4217 currency.
settled_ondateYesDate of the show or period settled.
settlement_stateapp.settlement_stateYesSubmitted, Accepted, Disputed, Paid or Canceled.
net_minorbigintYesAdditions less deductions and withholding in minor units; NULL while any line is unpriced.
submitted_attimestamp with time zoneYesWhen last submitted.
responded_attimestamp with time zoneYesWhen the party last accepted or disputed it.