PUT
/
sequence
/
v1
/
series
/
{id}
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"
}

{
    "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.

Example:

"a8904315-3d16-4a95-91c1-30d6cdde553e"

Body

application/json
​
code
string

A code that can be used to identify the series.

Example:

"SALES-2020"

​
description
string

A description of the series.

Example:

"This series is used for sales."

​
id
string

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

Example:

"a8904315-3d16-4a95-91c1-30d6cdde553e"

​
name
string

The name of the series.

Example:

"My Series"

​
padding
integer

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

Example:

5

​
prefix
string

A prefix that will be prepended to all entries.

Example:

"INV-"

​
sig
string

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

​
start
integer

The starting index for the series.

Example:

1

​
suffix
string

A suffix that will be appended to all entries.

Example:

"-F1"

Response

200 - application/json
OK
​
code
string

A code that can be used to identify the series.

Example:

"SALES-2020"

​
created_at
string

The date and time the series was created.

Example:

"2020-10-01T00:00:00Z"

​
description
string

A description of the series.

Example:

"This series is used for sales."

​
id
string

The UUID (any version) of the series.

Example:

"a8904315-3d16-4a95-91c1-30d6cdde553e"

​
last_entry_id
string

The ID of the last entry in the series.

Example:

"a8904315-3d16-4a95-91c1-30d6cdde553e"

​
last_index
integer

The last index used in the series.

Example:

100

​
name
string

The name of the series.

Example:

"My Series"

​
padding
integer

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

Example:

5

​
prefix
string

A prefix that will be prepended to all entries.

Example:

"INV-"

​
suffix
string

A suffix that will be appended to all entries.

Example:

"-F1"

​
updated_at
string

The date and time the series was last updated.

Example:

"2020-10-01T00:00:00Z"

Fetch all seriesFetch a series