Definitions

This section defines the fundamentals of the entities available in the INFast API.

If you're interested in the technical approach of these entities (schemas, routes, events), you can check the API Reference.

📄️ Authentication (OAuth)

Access to the INFast API is authenticated using OAuth2. To be more specific, we implement OAuth2 with Client Credentials as the Grant Type. Then, we use a Bearer Token to authenticate requests.

📄️ Rate limiting

The INFast API employs a rate limiter to prevent overloading our services. The limit is applied per IP address. The limit is set at 10 requests per second (which should be more than enough for smooth operation).

📄️ Common fields

Fields

📄️ Portal

The Portal is an entity that represents an INFast account. A portal is linked to a single company, and every company has its own portal.

📄️ Customers

The Customer entity represents a customer of the company. Customers are linked to Documents and Transactions.

📄️ Items

The Item entity represents a service (labor, consulting, travel) or a product (a faucet, a sandwich, clothing). This entity populates the item catalog of the portal on INFast. Items can then be used in a Document (invoice, quotation, etc.).

📄️ Documents

The Document entity is the fundamental entity in INFast. It represents all the documents generated in INFast (invoices, quotations, etc.). The concept of a document is closely tied to legal and accounting rules regarding invoicing. Therefore, documents have a specific workflow impacting its status and version. A document can have various type and subtype.

📄️ Transactions

The Transaction entity represents a real financial movement between a Customer and the Portal.

📄️ TransactionUsages

The TransactionUsage entity represents the use of the amount, or part of the amount, of a Transaction or a CreditNote to partially or fully settle the accounting situation of a Document.