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

# Overview

> A series is in effect a placeholder for a counter with number formatting details to be able to generate a code.

## Model

A "Series" object contains the following fields:

| Property        | Type            | Description                                                                                           |
| --------------- | --------------- | ----------------------------------------------------------------------------------------------------- |
| id              | uuid            | Unique identifier in UUIDv4 format.                                                                   |
| name            | string          | Human name to help identify the series.                                                               |
| prefix          | string          | Text to place before a generated code.                                                                |
| padding         | integer         | Width of the code's number, with zero padding.                                                        |
| suffix          | string          | Text added after the series' number.                                                                  |
| last\_index     | integer         | The series' last assigned number, zero, or the defined first index if no entries have been added yet. |
| last\_entry\_id | uuid            | ID of the entry last inserted for this series.                                                        |
| sigs            | array of string | If the series was created with any signatures, they'll be here.                                       |
| created\_at     | date-time       | Timestamp of the series' creation.                                                                    |
| updated\_at     | data-time       | Timestamp of the last update.                                                                         |

A series object may look like:

```json theme={"system"}
{
  "id": "835bb1ca-e7c4-41e6-9e88-464de54cc08e",
  "name": "Testing",
  "prefix": "TEST1",
  "padding": 5,
  "suffix": "-2022",
  "last_index": 1001,
  "last_entry_id": "78b53c40-9b40-11ec-9298-665181255c0a",
  "created_at": "2022-03-03T22:18:50Z",
  "updated_at": "2022-03-03T22:18:50Z"
}
```

The last entry added to that sequence would have generated the code:
`TEST101001-2022`.

## Resources

<Card title="Fetch a collection of Entries in the Series" icon="plus" href="/api-ref/sequences/entries/fetch-all-series-entries">
  PUT [https://api.invopop.com/sequence/v1/series/\{id}](https://api.invopop.com/sequence/v1/series/\{id})
</Card>

<Card title="Fetch a Series" icon="magnifying-glass" href="/api-ref/sequences/series/fetch-a-series">
  GET [https://api.invopop.com/sequence/v1/series/\{id}](https://api.invopop.com/sequence/v1/series/\{id})
</Card>

<Card title="Fetch a list of series" icon="list" href="/api-ref/sequences/series/fetch-all-series">
  GET [https://api.invopop.com/sequence/v1/series](https://api.invopop.com/sequence/v1/series)
</Card>