PUT
/
sequence
/
v1
/
series
/
{id}
Authorization
Path
Body
curl --request PUT \
  --url https://api.invopop.com/sequence/v1/series/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "SALES-2020",
  "description": "This series is used for sales.",
  "id": "a8904315-3d16-4a95-91c1-30d6cdde553e",
  "name": "My Series",
  "padding": 5,
  "prefix": "INV-",
  "sig": "<string>",
  "start": 1,
  "suffix": "-F1"
}'
{
    "last_index": 1000
    "padding": 5
    "prefix": "TEST1"
    "name": "Testing"
    "created_at": "2022-03-03T22:18:50Z"
    "suffix": "-2022"
    "updated_at": "2022-03-03T22:18:50Z"
    "id": "835bb1ca-e7c4-41e6-9e88-464de54cc08e"
}

Path Parameters

id
string
required

The UUID (any version) of the series to create.

Body

application/json
code
string

A code that can be used to identify the series.

description
string

A description of the series.

id
string

The UUID (any version) of the series to create.

name
string

The name of the series.

padding
integer

The number of 0s to pad the generated codes with.

prefix
string

A prefix that will be prepended to all entries.

sig
string

JSON Web Signature of the key properties used to create the series.

start
integer

The starting index for the series.

suffix
string

A suffix that will be appended to all entries.

Response

200 - application/json
code
string

The complete code for the entry, including prefix and suffix.

created_at
string

The date and time the entry was created.

id
string

The UUID (any version) of the entry.

meta
object

A set of key/value pairs that can be used to store additional information about the entry.

previous_id
string

The UUID of the previous entry in the series.

series_id
string

The UUID of the series the entry belongs to.

sigs
string[]

Set of JSON Web Signatures validating the information contained in the entry.

updated_at
string

The date and time the entry was last updated.

Fetch all seriesFetch a series