Series
Fetch all series
API
- Introduction
- Authentication
- Idempotency
- Versioning
- Silo
- Transform
- Sequences
- Access
- Utils
Series
Fetch all series
Fetch all the series in the current company.
GET
/
sequence
/
v1
/
series
curl --request GET \
--url https://api.invopop.com/sequence/v1/series
{
"list": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2023-01-25T08:04:14.245Z",
"updated_at": "2023-01-25T08:04:14.245Z",
"name": "string",
"description": "string",
"code": "string",
"prefix": "string",
"padding": 0,
"suffix": "string",
"last_index": 0,
"last_entry_id": "string",
"sigs": ["string"]
}
]
}
{
"list": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2023-01-25T08:04:14.245Z",
"updated_at": "2023-01-25T08:04:14.245Z",
"name": "string",
"description": "string",
"code": "string",
"prefix": "string",
"padding": 0,
"suffix": "string",
"last_index": 0,
"last_entry_id": "string",
"sigs": ["string"]
}
]
}
Response
200 - application/json
OK
A list of series.
A code that can be used to identify the series.
Example:
"SALES-2020"
The date and time the series was created.
Example:
"2020-10-01T00:00:00Z"
A description of the series.
Example:
"This series is used for sales."
The UUID (any version) of the series.
Example:
"a8904315-3d16-4a95-91c1-30d6cdde553e"
The ID of the last entry in the series.
Example:
"a8904315-3d16-4a95-91c1-30d6cdde553e"
The last index used in the series.
Example:
100
The name of the series.
Example:
"My Series"
The number of 0s to pad the generated codes with.
Example:
5
A prefix that will be prepended to all entries.
Example:
"INV-"
A suffix that will be appended to all entries.
Example:
"-F1"
The date and time the series was last updated.
Example:
"2020-10-01T00:00:00Z"
curl --request GET \
--url https://api.invopop.com/sequence/v1/series
{
"list": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2023-01-25T08:04:14.245Z",
"updated_at": "2023-01-25T08:04:14.245Z",
"name": "string",
"description": "string",
"code": "string",
"prefix": "string",
"padding": 0,
"suffix": "string",
"last_index": 0,
"last_entry_id": "string",
"sigs": ["string"]
}
]
}