Introduction

The design of the CoreLink public API, a design preview that is not operational yet, to read company data and issue invoices from your servers.

CoreLink is a cloud ERP. Its public API is designed to let your servers work with the data of one CoreLink company: read third parties, products, invoices with their status before the tax authority, received documents, receivables, the payment schedule and the company structure, and transmit invoices that are ready to issue.

Design principles

• One key, one company. Every key belongs to a single company, and the environment (test or live) comes from that company. See Authentication.
• Versioned in the path. Every route starts with /v1. Additive changes don’t change the version.
• Public contracts. Responses are contracts of their own, mapped from CoreLink’s data; internal changes don’t break them.
• Safe retries. Every POST requires an Idempotency-Key.
• Synchronization. Lists use cursor pagination and accept updated_since.
• Standard errors. RFC 7807 problem documents with a stable code. See Errors.

Modules

The reference is grouped by CoreLink module. Modules without resources in the first version are listed with what is planned, and no operations.

Module	Resources in v1
Sales and invoicing	Invoices
Accounts receivable	Receivables
Purchasing	Received documents
Accounts payable	Scheduled payments
Inventory	Products
Treasury	Not included in v1
Accounting and taxes	Not included in v1
Payroll	Not included in v1
Third parties	Parties
Organization	API key, Company, Units

Start here

1. Quickstart: the first calls, step by step.
2. Authentication: keys per company, environments and scopes.
3. Errors: the error catalog and how to retry.
4. Modules: every resource and operation, module by module.

The API reference is generated from the same OpenAPI 3.1 document, available at /openapi.json.