- Series
- Create a new series
Series
Create a new series
/sequence/v1/series/{id}
curl --request PUT \
--url https://api.invopop.com/sequence/v1/series/{id} \
--header 'Authorization: Bearer AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"id": "string",
"name": "string"
}'
{
"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"
]
}
Parameters
New Series UUID
Body
An ID must be provided by the client so that all requests are idempotent.
Set of characters provided before each code in the series.
The number of 0s with which to pad the sequence code.
Fixed characters to include after the padded index.
Which number to start counting from.
JSON Web Signature used to sign the request.
Response
UUID that uniquely identifies the series.
Human reference for the series.
Optional details about this series.
Optional fixed code that will be set alongside the generated number.
Text to insert at start of generated codes.
Minimum length of a code's number part, padded with 0s.
Text to insert after the number in generated codes.
The last number used in the series.
Last inserted Entry UUID
JSON Web Signatures generated when the series was created.
curl --request PUT \
--url https://api.invopop.com/sequence/v1/series/{id} \
--header 'Authorization: Bearer AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"id": "string",
"name": "string"
}'
{
"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"
]
}