Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /v1/contract-series | List contract series for the current workspace. |
| POST | /v1/contract-series | Create a new contract series. |
| GET | /v1/contract-series/:id | Retrieve a contract series by ID. |
| PUT | /v1/contract-series/:id | Update a contract series. |
| DELETE | /v1/contract-series/:id | Delete a contract series. |
| POST | /v1/contract-series/:id/set-default | Set a contract series as the booking-engine default. |
Read operations require the
contract-series:read scope. Creating, updating, deleting, or setting the default requires contract-series:write.Key concepts
- A series defines how contract numbers are generated: prefix, pattern, start value, and reset cadence (
year,quarter,month, ornever). enforceGaplessensures numbers remain sequential even if contracts are deleted.enforceMonotonicDatesblocks back-dating.defaultForBemarks the series used automatically by the booking engine; only one series can be default at a time.- Webhook events (
contract-series.created,contract-series.updated,contract-series.deleted,contract-series.set-as-default) fire on changes for downstream sync.