LegalContract
/api/v1/legal/contractsA legal contract record (MSA, partnership, vendor, employment).
listgetcreateupdatedeleteSchema
| 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. |
| title* | string | Contract title. |
| type | enum | service | partnership | vendor | employment | otherContract type. |
| status | enum | draft | review | signed | active | expired | terminatedContract lifecycle status. |
| parties | json | Parties to the contract. |
| effective_date | date-time | ISO 8601 date the contract becomes effective. |
| expiration_date | date-time | ISO 8601 date the contract expires. |
| value | number | Total contract value. |
| clauses | json | Structured clauses of the contract. |
| vendor_id | uuid | ID of the associated vendor. |
| owner_id | uuid | User ID of the contract owner. |
| name | string | Display name of the contract. |
| signed_date | date-time | ISO 8601 date the contract was signed. |
| expiry_date | date-time | ISO 8601 date the contract expires. |
| notice_period_days | integer | Notice period in days before termination. |
| auto_renewal_window_days | integer | Auto-renewal window in days before expiry. |
| currency | string | Currency code for the contract value. |
| linked_license_ids | json | IDs of licenses linked to this contract. |
| document_ref | string | Storage reference to the contract document. |
| notes | string | Free-form notes about the contract. |
| tags | json | Tags for categorizing the contract. |
API
Loading manifest…