set_cadence
Set how often an agreement ACCRUES and SETTLES. Ask the user these when setting an agreement up (or to change them later): (1) how often to accrue — 'realtime' as sales land, or batched 'daily' / 'weekly' / 'monthly' / 'per_event'; (2) how often it settles — when the money actually hits their account — 'weekly', 'semi_monthly', 'monthly', 'quarterly', 'semi_annual', 'annual', 'threshold' (when a dollar threshold is hit), or 'ad_hoc'. Pass the agreement_id and whichever cadence(s) the user chose; you can set one or both. Requires a connected Aurgus account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agreement_id | Yes | The agreement whose cadence to set. | |
| accrual_cadence | No | How often to accrue. 'realtime' = as each sale lands. | |
| settlement_cadence | No | How often it settles — when the rebate is actually paid out. | |
| settlement_approver_email | No | If someone must APPROVE each settlement before money moves, their email. Aurgus holds every settlement and emails them a one-time confirm link; nothing settles until they approve. Pass an empty string to turn the approval requirement off. |