Contact Us

GitHub

Invopop

Build GOBL Envelopes or Objects for validation purposes

Build GOBL Document

Welcome to the Invopop 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

Issue invoices and credit notes in Colombia with Plemsi.

🇨🇴 Colombia

🇪🇸 Spain

🇫🇷 France

🇮🇹 Italy

Issue CFDI documents in Mexico using the SAT Mexico provider.

🇲🇽 Mexico

🇳🇱 Netherlands

Issue invoices and credit notes in Portugal using the InvoiceXpress provider.

🇵🇹 Portugal

🇺🇸 United States

Import and process invoices and credit notes from Chargebee

Chargebee

Send a message to a Slack channel with the status of a job

Slack

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

Perform a free-text search on all documents in the current company.

Search 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

Find silo entries whose document mentions the given entry's UUID.

Find related entries

Sign GOBL Document

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.

Introduction

Quick Start

Utils

Sequences

Silo

Transform

Build GOBL Document

Body

Response