settle
Settle an agreement — post the PAYOUT. Creates per-bucket Settlement event(s) totalling the open accrual (earned − already settled), moving the open balance to $0. This is the money-OUT step (distinct from compute_close, which accrues, and true_up, which reconciles the accrual to a prior settlement). Call WITHOUT confirm to DRY-RUN — it reports the open accrual that would be paid and any gate that blocks it (a named settlement approver, an incomplete agreement, or an anomaly hold). Call again with confirm:true to post it. Governed by the SAME gates as the workspace Settle button (one core). Needs the agreement_id. Requires a connected Aurgus account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Omit/false to DRY-RUN (preview the payout + any blocking gate); true to post the Settlement event(s). | |
| agreement_id | Yes | The agreement to settle (pay out its open accrual). |