Skip to content
Eternify Labs

Build on your books.

The Eternify Ledger API reads the books and drafts work in them. This page covers who gets a key, the address, a first request, the limits and how a change is announced.

A key is for customers.

An administrator of a company's books makes a key in the app. There is no developer sign-up. A company that is not a customer yet can book a demo, and anything about access can go to info@eternifylabs.com.

An API key

A key reads, or reads and drafts, on one ledger. Send it as a bearer token in the Authorization header. A key starts with evk_ and is shown once, when it is made. It lasts 90 days unless the administrator sets another time, up to 366 days, and a ledger holds at most 25 live keys.

A connected app

An app a person connects gets an access token. It is sent the same way, and the app acts with that person’s own role, inside what they allowed. Their name is on every change.

Keep a key in a secret manager. Never put it in a URL, a log or a shared document. A key that is lost is revoked and replaced.

Make a request.

Every call is an HTTPS request to https://api.eternifylabs.com. The path starts with /v1, and every answer is JSON.

List one bill, with curl
curl "https://api.eternifylabs.com/v1/bills?limit=1" \
  -H "Authorization: Bearer $ETERNIFY_API_KEY"
The same call, with the SDK
import { createLedgerClient } from "@eternify-labs/ledger";
import type { paths } from "./generated"; // from openapi-typescript, run on the contract

const ledger = createLedgerClient<paths>({ apiKey: process.env.ETERNIFY_API_KEY! });
const { data } = await ledger.GET("/v1/bills", { params: { query: { limit: 1 } } });

A list answers { data, nextCursor, total }: one page, the cursor for the next, and the database’s total. Send Eternify-Version: 2026-08-31 to pin the wire version; the SDK does it for you.

Writes can be retried.

Every request that changes something carries an Idempotency-Key, a new UUID for each new request. Send the same key again to retry a request whose answer was lost, and the first answer comes back with nothing written twice.

Create a bill, with a key you can retry
curl -X POST "https://api.eternifylabs.com/v1/bills" \
  -H "Authorization: Bearer $ETERNIFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d @bill.json
  • A key is kept for 7 days.
  • A write with no key answers idempotency_key_required.
  • The same key with a different body answers idempotency_conflict.
  • The same key while the first call still runs answers idempotency_in_flight.
  • Each is explained on the errors page.

Limits and pages.

The numbers below are read from the contract. An answer to a call whose key or token was accepted carries RateLimit-Policy and RateLimit headers, errors included. A 429 for a key over its minute carries both and Retry-After. A refused credential (a 401, or a 403 for a key whose maker left) carries none of them, and a 429 for too many invalid keys from one address carries Retry-After alone.

Limits of the API
LimitValue
Reads300 a minute
Writes60 a minute
Request bodyUp to 1 MiB
Page size50 by default, up to 200 with limit
Idempotency keyKept for 7 days
Webhook event bodyAt most 2 KiB

What is on the API.

The reference lists 959 operations: 33 stable and 926 beta. An operation that is not in the reference is not on the API.

Operations by area
AreaStableBetaContract
PurchasesVendors, bills, purchase orders, payment runs and vendor credits.20284Download purchases
SalesCustomers, invoices, receipts and receivables.0166Download sales
AccountingThe chart of accounts, entities, journal entries, dimensions and payment terms.5103Download accounting
Banking and paymentsBank connections, statements, reconciliation and payments.571Download banking and payments
TaxTax codes, registrations, returns and filings.128Download tax
ReportsFinancial reports and their exports.020Download reports
ClosePeriod close, year-end and the checklists around them.021Download close
SettingsWorkspace and ledger settings.0108Download settings
DocumentsFiles, attachments and document intake.066Download documents
PeopleTeam members, seats and invitations.01Download people
PlatformEvents and the other operations that serve integrations.258Download platform

The whole contract is one OpenAPI 3.1 file: download all 959 operations.

What a key cannot do.

A key has the access of a viewer or a preparer. It has no approver or administrator level.

A call that approves, releases money or changes who has access answers a key with permission_denied (403). A person with the right role does it in the app. A connected app is different: it acts with the role of the person who connected it, and money out, filings with the CRA and large batches wait for that person to confirm on our page, with a code if they have two-factor sign-in turned on.

Changes come with notice.

One version, extended

Every path starts with /v1, and changes add: a field, an operation, a value. A change that would break a caller ships as a new operation, and the old one is deprecated.

365 days or 30

A stable operation changes only with 365 days’ notice. A beta operation changes with 30. The reference marks which is which.

Told in the answer

A deprecated operation answers with Deprecation and Sunset headers and a link to the changelog. After the sunset day it answers operation_sunset.

There is no separate sandbox address. Calls go to https://api.eternifylabs.com with a key made for the books they should reach.

Not a customer yet?

Book a demo and we show you the books your key would reach.