Contract APIs¶
Why This Exists¶
This document defines API responsibilities for the Contract Domain.
It does not define implementation code or final OpenAPI specifications.
Owner¶
The owner is the Chief Product Officer and Enterprise Architect.
Business Value¶
Contract APIs expose governed contract workspace, delivery, financial, risk, performance, closeout, and learning behavior.
API Groups¶
| API group | Responsibilities | Example endpoints |
|---|---|---|
| Contract Workspace API | Create and manage contract workspaces. | POST /contracts/workspaces, GET /contracts/workspaces/{workspaceId} |
| Delivery Plan API | Manage milestones and deliverables. | POST /contracts/workspaces/{id}/delivery-plan |
| Milestone API | Track milestones. | PATCH /contracts/milestones/{milestoneId} |
| Deliverable API | Track deliverables. | PATCH /contracts/deliverables/{deliverableId} |
| Supplier Coordination API | Record contract-specific supplier coordination. | POST /contracts/workspaces/{id}/supplier-coordination |
| Variation API | Manage variations. | POST /contracts/workspaces/{id}/variations |
| Invoice API | Record invoices. | POST /contracts/workspaces/{id}/invoices |
| Payment API | Record payments. | POST /contracts/invoices/{invoiceId}/payments |
| Risk API | Manage contract risks. | POST /contracts/workspaces/{id}/risks |
| Performance API | Record performance metrics. | POST /contracts/workspaces/{id}/performance |
| Closeout API | Manage closeout. | POST /contracts/workspaces/{id}/closeout |
| Lessons API | Capture lessons learned. | POST /contracts/workspaces/{id}/lessons |
API Principles¶
- APIs start contract work only after award or contract creation event.
- APIs must not mutate Bid, Organization, Supplier, Funding, or Intelligence source facts.
- APIs must enforce variation, risk, financial, and closeout rules.
- APIs must publish contract events for meaningful state changes.