defunct_agreement
Retire a WRONG agreement that has already accrued — reverse its postings, then archive it. Voiding alone only stops FUTURE accruals; this UNWINDS what already accrued by appending a Reversal for every earning event (earned → $0, strictly append-only — the originals AND the reversals both stay on the ledger for audit), then voids the agreement. Call WITHOUT confirm first to DRY-RUN — it reports how many postings and how much $ will be reversed and warns if any was already settled (a clawback). Call again with confirm:true to apply. Refuses if the agreement is posted to the ERP (supersede it instead). Needs the agreement_id. Requires a connected Aurgus account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Omit/false to DRY-RUN (preview the reversal); true to actually reverse the postings and archive the agreement. | |
| agreement_id | Yes | The agreement to reverse & defunct. |