report
The portfolio report — every active agreement on the tenant (or one, by id), with its earned / settled / open accrual, basis, status, and when it last calculated. This is the book-at-a-glance a controller watches: which agreements are live, what each has earned vs paid out, and what is open. Pass agreement_id for a single agreement, or status to filter the list (active / draft / closed / superseded). Read-only — it computes nothing new, it reports the canonical ledger. Requires a connected Aurgus account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter the list by lifecycle status. Default: active. | |
| agreement_id | No | Report on ONE agreement by id. Omit for the whole book. |