API

Purpose of this page

This page describes how users can leverage the Invisible Collector’s API to develop an integration between their information system and Invisible Collector.

API

The Invisible Collector’s REST API provides programatic access to read and write Invisible Collector’s data which includes among other things:

• Access company info;
• Register debts;
• Register credit notes or debit notes;
• Register payments;

All information exchanged is JSON based and through TLS for security reasons.

We already provide client libraries in some programming languages to reduce the integration time. All of them are available on Github with instructions on how to use them.

Data Model

Invisible Collector models the information around the exchange of documents between 2 entities: companies and customers. The exchanged documents can be either one of:

• debts (invoices for instance);
• credit notes or debit notes;
• payments;

Assuming a relational model you can say that:

• a company can have many customers;
• a customer is issued many debts;
• a payment can pay (totally or partially) many debts;
• Credit notes and debit notes can reference many debts and update the value owed accordingly.

Returned Server Errors format

The errors returned by the server have the following JSON format:

{ "code": 404, "message": "error message" }

Some server errors may have have additional name/value pairs, such as the 409 status code for conflicting model fields:

{ "code": 409, "gid": "0d3987e3-a6df-422c-8722-3fde26eec9a8", "message": "conflicting field" }

Error message body