> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voyantcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Contract Series

> Configure numbering series used when issuing contracts via the booking engine or manual workflows.

## 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. |

<Info>
  Read operations require the `contract-series:read` scope. Creating, updating, deleting, or setting the default requires `contract-series:write`.
</Info>

## Key concepts

* A series defines how contract numbers are generated: prefix, pattern, start value, and reset cadence (`year`, `quarter`, `month`, or `never`).
* `enforceGapless` ensures numbers remain sequential even if contracts are deleted. `enforceMonotonicDates` blocks back-dating.
* `defaultForBe` marks 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.