Skip to content
FlychainFlychainFlychain Docs

Flychain Reporting API

Read-only access to the books Flychain keeps for the providers in your partner relationship, so your platform can source financial figures directly from us instead of from each provider’s accounting system.

Four things to know before you write any code

Section titled “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 API key is scoped to your relationship, so no partner or organization identifier appears in any path. 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.

Where to start

Section titled “Where to start”
  1. Authentication — how keys work, 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.

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

Section titled “Getting access”

Keys are issued from your Flychain partner dashboard, and your organization must be enrolled in the API programme first. If a key you hold returns 403 PARTNER_API_NOT_ENABLED, the key is fine and the enrollment is what is missing — contact us rather than rotating it.