ContractObligation
/api/v1/contracts/obligationsA specific obligation pulled out of a Contract.
listgetcreateupdatecompleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| contract_id | uuid | UUID of the Contract this obligation belongs to. |
| title | string | Short descriptive title of the obligation (e.g. 'Submit quarterly SOC 2 attestation'). |
| description | string | Detailed description of what is required to fulfil this obligation. |
| due_date | date-time | ISO 8601 date by which this obligation must be completed. For recurring obligations this is the date of the next occurrence. |
| owner_person_id | uuid | UUID of the Person internally responsible for ensuring this obligation is met. Null if unassigned. |
| status | string | Current fulfilment status of the obligation. 'overdue' is set automatically when dueDate passes without completion. 'waived' requires an audit note. |
| recurring | boolean | Whether this obligation repeats on a schedule. If true, recurrenceInterval must be set. |
| recurrence_interval | string | How often the obligation recurs. Required when recurring is true; null otherwise. |
| notes | string | Internal notes about this obligation, including waiver justifications or completion evidence references. |
API
client.contracts.obligations.*Loading manifest…