Flychain Reporting API

Read-only access to the books Flychain keeps, so financial figures can be sourced directly from us instead of from an accounting system.

There are two kinds of caller, and which one you are decides where to start:

• a partner — a platform reading the books of the providers in its partner relationship;
• a provider — a Flychain client reading its own books.

You hold one kind of API key or the other, never both, and the key carries its own scope.

Four things to know before you write any code

Two levels. A provider is the business as a client of Flychain. A business entity is a legal entity whose books we keep, and reports are produced at that level, because that is the level a set of books exists at. Most providers are a single legal entity; the distinction exists so a figure is never an accidental blend of two.

Scope comes from the key. A partner key is scoped to your partner relationship; a provider key is scoped to that one provider. Either way no partner or organization identifier appears in any path. For a partner, a provider joining Flychain simply appears in your results — there is no per-provider authorization step.

Amounts are integers in cents (USD). We hold monetary values in cents internally to avoid floating-point rounding in financial calculations, and expose them the same way so no precision is lost in transit.

Everything is a GET. There is nothing in this API that can modify data on our side.

Not every endpoint is open to both

The discovery endpoints and the income statement take either kind of key. The balance sheet and cash flow families are provider-key only, and a partner key calling one gets 403 ENDPOINT_NOT_AVAILABLE.

Authentication carries the full endpoint-by-endpoint table, and every operation in the reference names the kinds of key it serves.

Where to start

If you hold a partner key:

1. Authentication — how keys work, which endpoints yours reaches, and how to rotate one without downtime. Start here; you need a key before anything else responds.
2. Data semantics — the things a schema cannot state: what is_closed means versus is_complete, why accounting basis is a property of the entity rather than a request parameter, and how a requested date range is clamped to the date an entity’s books begin. Read this before trusting a figure.
3. Migrating from the QuickBooks P&L — the field-by-field mapping, if you are replacing a QuickBooks pull.
4. Versioning — what may change within v1 and what may not.

If you hold a provider key:

1. Provider quickstart — what your key reaches, and how to get from your first call to a financial report.
2. Authentication — issuing, rotating and revoking keys, and what each failure response means.
3. Data semantics — as above. Read this before trusting a figure.
4. Versioning — what may change within v1 and what may not.

The API reference is generated from the OpenAPI 3.1 document we publish as the contract, so it is the authoritative description of every field.

Getting access

Keys are issued from your Flychain partner dashboard or provider dashboard, and your organization must be enrolled in the API programme first.

A 403 on a key you believe is good is almost always enrollment or account state rather than the credential — PARTNER_API_NOT_ENABLED, PROVIDER_API_NOT_ENABLED or PROVIDER_NOT_ACTIVE. In every one of those cases the key is fine and rotating it changes nothing; contact us instead. Authentication has the full table.