Modules

Every resource and operation of the planned CoreLink API, grouped by CoreLink module, with the scope each operation requires.

The API follows CoreLink’s modules. Lists accept limit (1 to 100), cursor and, in most cases, updated_since. The request and response schemas are in the API reference.

Sales and invoicing

Electronic sales invoices, credit notes and debit notes, and their status before the tax authority.

Invoices. Sales invoices, credit notes and debit notes: read them with their tax authority status, CUFE and number, download their PDF and XML, and transmit invoices that are ready.

Operation	Summary	Scope
GET /v1/invoices	List invoices	invoices:read
GET /v1/invoices/{id}	Get an invoice	invoices:read
GET /v1/invoices/{id}/pdf	Download the invoice PDF	invoices:read
GET /v1/invoices/{id}/xml	Download the invoice XML	invoices:read
POST /v1/invoices/{id}/issue	Transmit an invoice	invoices:write

Accounts receivable

What customers owe the company: one receivable per invoice, with its payments and balance.

Receivables. Customer balances, document by document. Filter by customer to get the open portfolio of one party.

Operation	Summary	Scope
GET /v1/receivables	List receivables	receivables:read
GET /v1/receivables/{id}	Get a receivable	receivables:read

Purchasing

Electronic documents that suppliers issued to the company, and their RADIAN acknowledgement status. Purchase requisitions and purchase orders are not part of v1.

Received documents. Electronic invoices and notes that suppliers issued to the company (reception inbox).

Operation	Summary	Scope
GET /v1/received-documents	List received documents	received:read

Accounts payable

What the company owes its suppliers. v1 exposes the payment schedule: accounted documents ready to pay and those already scheduled for a date.

Scheduled payments. Supplier documents ready to pay or scheduled for payment. Paying them is not part of v1.

Operation	Summary	Scope
GET /v1/scheduled-payments	List scheduled payments	payments:read
GET /v1/scheduled-payments/{id}	Get a scheduled payment	payments:read

Inventory

The catalog of products and services the company buys and sells.

Products. Products and services with their codes for electronic invoicing.

Operation	Summary	Scope
GET /v1/products	List products	products:read
GET /v1/products/{id}	Get a product	products:read

Treasury

Not included in v1. No operations are published for this module yet. In CoreLink this module manages bank accounts, payment vouchers to suppliers and bank reconciliation. Registering payments through the API is planned for a later phase, once payment calculation runs on the server (scope payments:write, reserved).

Accounting and taxes

Not included in v1. No operations are published for this module yet. Accounting (chart of accounts, journal entries, closings) and tax configuration (rates, withholding rules, UVT) are out of scope for the public API for now.

Payroll

Not included in v1. No operations are published for this module yet. Payroll data is personal and sensitive; it is explicitly out of scope for the public API.

Third parties

The single third-party master shared by every module: one record per tax id, with its roles (customer, supplier, employee…), locations and contacts.

Parties. Customers, suppliers and other third parties of the company.

Operation	Summary	Scope
GET /v1/parties	List parties	parties:read
GET /v1/parties/{id}	Get a party	parties:read

Organization

Who the API key belongs to, the organization and company it acts for, and the company's operating units.

API key. Inspect the key in use: company, environment and scopes. Start every integration here.

Operation	Summary	Scope
GET /v1/me	Get the current API key	Any valid key

Company. The organization and the company the key acts for.

Operation	Summary	Scope
GET /v1/organization	Get the organization	organization:read
GET /v1/company	Get the company	organization:read

Units. Operation centers and branches of the company. Documents reference them through unit_id.

Operation	Summary	Scope
GET /v1/units	List units	organization:read
GET /v1/units/{id}	Get a unit	organization:read