Fetch all the integrations in the current company.

Fetch all integrations

Contact Us

GitHub

Invopop

Welcome to the Invopop Public API Documentation site! Here you'll be able to find all the information you'll need to get up and running with Invopop.

Overview

A brief glossary of the main terms used in the platform.

Glossary

To get started using the Invopop API, you'll need to generate an access token for the "company" you'll be working with.

Authentication

Idempotency

Grouping sets of endpoints together by business objective.

Services

Versioning is one of those difficult areas of APIs that can be cumbersome to use and develop around.

Versioning

After completing this quick start guide you'll have generated and tested an authentication token that can be used in all subsequent requests to the Invopop API.

Invoice

Quickly test access credentials and that the service will respond to your requests.

Ping

UUID

The Invopop Sequence service makes it easy to reliably generate sequential numbers.

Introduction

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

Fetch all the series in the current company.

Fetch all series

Create a new series idempotently with the given UUID (any version).

Create a series

Fetch a series

An entry represents a single index or code number inside a series. Essentially, its a mapping of a UUID to a code number.

Fetch all series entries

Create a new entry in a given series idempotently with the given UUID (any version).

Create a series entry

Fetch an existing entry in a series given its UUID.

Fetch a series entry

Fetch all the silo entries in the current company.

Fetch all entries

Create a new silo entry idempotently with the given UUIDv1 (other versions not supported).

Create an entry

Create a new silo entry non-idempotently without an explicit UUID. Only recommended for testing purposes, production environments should use the PUT method.

Create an entry (POST)

Create an entry (non-idempotent)

Fetch an existing silo entry given its UUID.

Fetch an entry

Update an existing silo entry given its UUID.

Update an entry

Create a new integration idempotently with the given UUID (any version).

Create an integration

Fetch an existing integration given its UUID.

Fetch an integration

Update an existing integration given its UUID.

Update an integration

Fetch all the workflows in the current company.

Fetch all workflows

Create a new workflow idempotently with the given UUID (any version).

Create a workflow

Fetch an existing workflow given its UUID.

Fetch a workflow

Update an existing workflow given its UUID.

Update a workflow

Create a new job idempotently with the given UUIDv1 (other versions not supported).

Create a job

Create a new job non-idempotently without an explicit UUID. Only recommended for testing purposes, production environments should use the PUT method.

Create a job (POST)

Create a job (non-idempotent)

Fetch a job

Invopop Developers

Set of end-points that help you test access to the Invopop API and generate data.

Apache 2.0

Utils Service API

The Invopop Sequence Service API allows you to define a "series" whose entries are guaranteed to be sequential.

Sequence Service API

The Invopop Silo Service API allows you to define allows you to store entries.

Silo Service API

The Invopop Transform Service API offers end points to be able to manage tasks and workflows with the primary objective being to send requests for jobs.

Transform Service API

Output after fetching a single entry by ID

Output from list query with a limit set to 1 for the sake of the example

Testing

The fields required to create a new series for the current company.


An Entry represents a single number inside the sequence series and provides the complete code to be presented.
Meta information may be included and signed when creating an entry.


A Series keeps together an ordered sequence of entries.


A collection of series that belong to the currently authorized company.


Introduction

Quick Start

Utils

Sequences

Silo

Transform

Fetch all integrations

Response

Introduction

Quick Start

Utils

Sequences

Silo

Transform

​Response

Response