edit_agreement
Change an agreement's TERMS — its name, the counterparty (customer_name), the direction (payable_sell_side = you pay a rebate / receivable_buy_side = you earn one), the validity window (valid_from / valid_to, YYYY-MM-DD; pass valid_to:null for open-ended), or the accrual / settlement cadence. Send only the fields to change. This runs the SAME governed core as the workspace edit form (one implementation): activating is blocked if the config isn't ASC-606-conformant; a cadence/validity value must satisfy the agreement type's contract; direction and type are posting-locked once a document hits the ERP; and because a validity change re-evaluates already-accrued periods, it does NOT post money through you — it raises a gated Recalculate card the operator approves in the workspace (nothing is backdated without approval). To CHANGE RATES use edit_agreement_rates; to change STATUS use the audited status flow. Needs the agreement_id. Requires a connected Aurgus account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New agreement name. | |
| valid_to | No | New validity end, YYYY-MM-DD, or null for open-ended. A validity change raises a gated Recalculate card. | |
| direction | No | payable_sell_side (you pay the rebate) or receivable_buy_side (you earn it). Posting-locked once a document is posted to the ERP. | |
| valid_from | No | New validity start, YYYY-MM-DD (bare calendar date). | |
| agreement_id | Yes | The agreement to edit. | |
| customer_name | No | New counterparty / customer name. | |
| accrual_cadence | No | How often to accrue: realtime | daily | weekly | monthly | per_event. | |
| settlement_cadence | No | How often it settles: weekly | semi_monthly | monthly | quarterly | semi_annual | annual | threshold | ad_hoc. |