Cash flow totals per calendar month

GET

/provider/{provider_id}/business_entity/{business_entity_id}/financial_reports/cash_flow_report/monthly/summary

curl --request GET \
  --url 'https://api.flychain.us/external/v1/provider/9c1e7a42-0b3d-4e58-9f21-6a8b5c4d3e2f/business_entity/3f5d8b16-7c94-42a1-b0e6-58d9c2a71b43/financial_reports/cash_flow_report/monthly/summary?start_date=2026-07-01&end_date=2026-07-31' \
  --header 'Authorization: Bearer <token>'

• Production

Provider keys only. A partner key is refused with 403 ENDPOINT_NOT_AVAILABLE.

The report totals per calendar month across the range, plus the whole period — one request covers a trailing-twelve-month cash view for an entity. This is the endpoint a recurring job should use.

Each period carries its own is_closed and is_complete flags, so a job can narrow its work to the months that can still move and treat closed months as settled.

whole_period is computed over the full range independently rather than summed. For cash flow that is worth stating precisely: its three flow figures equal the sum of the periods’, while starting_cash_balance_cents is the first period’s start balance and ending_cash_balance_cents the last period’s end balance. Do not add the balances up.

Months at the edge of the range are clipped, not extended: a range starting mid-month yields a first period that starts on your start_date, and that period’s starting_cash_balance_cents is the balance on that date rather than on the first of the month.

Authorizations

• ProviderApiKey

Parameters

Path Parameters

provider_id

required

string format: uuid

The provider, from GET /providers or the provider_id on a business-entity record. With a partner key it must be a provider in your partner relationship; with a provider key it is always your own provider_id, which GET /providers returns.

Example

9c1e7a42-0b3d-4e58-9f21-6a8b5c4d3e2f

business_entity_id

required

string format: uuid

The business entity, from GET /business_entities. Must belong to the provider_id in the same path.

Example

3f5d8b16-7c94-42a1-b0e6-58d9c2a71b43

Query Parameters

start_date

required

string format: date

/^\d{4}-\d{2}-\d{2}$/

First day of the requested range, inclusive.

Must be a real calendar date, zero-padded, in YYYY-MM-DD form — 2026-7-1 and 2026-02-31 are both 400 INVALID_REQUEST. Ranges are evaluated in UTC.

Raised to the entity’s books_start_date when it falls earlier. If the whole requested range sits before the books begin, the result is 400 INVALID_REQUEST rather than a zero statement, so a range with no books behind it can never read as a period with no revenue.

Example

2026-07-01

end_date

required

string format: date

/^\d{4}-\d{2}-\d{2}$/

Last day of the requested range, inclusive. Same format rules as start_date, and must not be earlier than it.

Capped at today when it falls in the future, which is the ordinary case for a job that asks for the current month every day. The response echoes the effective range it used.

Example

2026-07-31

Responses

200

Report totals per period, plus the whole period.

Media typeapplication/json

Report totals per period, plus the whole range.

object

provider_id

required

string format: uuid

business_entity_id

required

string format: uuid

accounting_basis

required

The basis an entity’s financials are prepared on.

A property of the entity, not a request parameter. A report is produced on the basis the underlying books are kept on; there is no per-request switch. It is returned on every entity record and every report so a figure is never ambiguous, and it will not change without notice. See guides/data-semantics.

null only where the entity has no books yet — every entity with reporting_available: true carries a basis.

string | null

Allowed values: CASH ACCRUAL

currency

required

string

Allowed values: USD

generated_at

required

When this payload was produced, ISO 8601 UTC.

string format: date-time

periods

required

Chronological, one entry per month in the effective range.

Array

A period carrying the report totals.

object

label

required

Month and year of this period, e.g. July 2026. Derived from start_date, so a clipped period still reads as its calendar month — use the dates, not the label, to know what the period covers.

string

start_date

required

First day of the period, inclusive.

string format: date

end_date

required

Last day of the period, inclusive.

string format: date

is_closed

required

Whether a Flychain bookkeeper has finalized the books through end_date. This is the flag that says a figure is final.

boolean

is_complete

required

Whether this period’s end_date is in the past. false for the in-progress current month.

Note this is about the period, not the calendar month: a period clipped by the requested range reads true once its end date has passed, even though the calendar month it is labelled with is not fully covered.

boolean

totals

required

The five figures a cash flow report carries besides its ledgers, every one a signed integer in cents.

Three are flows over the range and three are related by net_cash_flow_cents = total_inflow_cents + total_outflow_cents — outflows are already negative, so they sum rather than subtract. Two are positions at the range’s endpoints. The distinction matters when you combine periods: the flows of two adjacent ranges add up, the balances do not.

object

total_inflow_cents

required

Cash in over the range. Positive.

integer

total_outflow_cents

required

Cash out over the range, as a negative number — or 0 where nothing left in the range. Unlike the income statement’s expense categories, which are positive magnitudes, outflows here carry their sign so that inflow plus outflow is the net.

integer

starting_cash_balance_cents

required

Cash on hand at the start of the effective range. A position, not a flow — do not sum it across periods.

integer

ending_cash_balance_cents

required

Cash on hand at the end of the effective range. Equal to starting_cash_balance_cents + net_cash_flow_cents.

integer

net_cash_flow_cents

required

total_inflow_cents + total_outflow_cents. Negative where the entity spent more than it took in over the range.

integer

key

additional properties

any

whole_period

required

The whole range carrying the report totals.

object

start_date

required

First day of the effective range, inclusive.

string format: date

end_date

required

Last day of the effective range, inclusive.

string format: date

is_closed

required

Whether the books are finalized through end_date.

boolean

totals

required

The five figures a cash flow report carries besides its ledgers, every one a signed integer in cents.

Three are flows over the range and three are related by net_cash_flow_cents = total_inflow_cents + total_outflow_cents — outflows are already negative, so they sum rather than subtract. Two are positions at the range’s endpoints. The distinction matters when you combine periods: the flows of two adjacent ranges add up, the balances do not.

object

total_inflow_cents

required

Cash in over the range. Positive.

integer

total_outflow_cents

required

Cash out over the range, as a negative number — or 0 where nothing left in the range. Unlike the income statement’s expense categories, which are positive magnitudes, outflows here carry their sign so that inflow plus outflow is the net.

integer

starting_cash_balance_cents

required

Cash on hand at the start of the effective range. A position, not a flow — do not sum it across periods.

integer

ending_cash_balance_cents

required

Cash on hand at the end of the effective range. Equal to starting_cash_balance_cents + net_cash_flow_cents.

integer

net_cash_flow_cents

required

total_inflow_cents + total_outflow_cents. Negative where the entity spent more than it took in over the range.

integer

key

additional properties

any

Examples

ExampletwoMonthsCashFlow

Two months of cash flow totals, plus the whole range

GET .../financial_reports/cash_flow_report/monthly/summary?start_date=2026-06-01&end_date=2026-07-31

June is closed and settled; July is complete as a calendar month but its books are not yet closed, so its figures can still move.

Note how whole_period combines the two: the flows are the sums (3980000 + 4167000 = 8147000), while the balances are the endpoints — starting_cash_balance_cents is June’s start and ending_cash_balance_cents is July’s end. Adding the balances up would be meaningless. Each month’s ending balance is also the next month’s starting balance.

{
  "provider_id": "9c1e7a42-0b3d-4e58-9f21-6a8b5c4d3e2f",
  "business_entity_id": "3f5d8b16-7c94-42a1-b0e6-58d9c2a71b43",
  "accounting_basis": "CASH",
  "currency": "USD",
  "generated_at": "2026-08-20T14:02:11Z",
  "periods": [
    {
      "label": "June 2026",
      "start_date": "2026-06-01",
      "end_date": "2026-06-30",
      "is_closed": true,
      "is_complete": true,
      "totals": {
        "total_inflow_cents": 3980000,
        "total_outflow_cents": -2655000,
        "starting_cash_balance_cents": 7125000,
        "ending_cash_balance_cents": 8450000,
        "net_cash_flow_cents": 1325000
      }
    },
    {
      "label": "July 2026",
      "start_date": "2026-07-01",
      "end_date": "2026-07-31",
      "is_closed": false,
      "is_complete": true,
      "totals": {
        "total_inflow_cents": 4167000,
        "total_outflow_cents": -2730000,
        "starting_cash_balance_cents": 8450000,
        "ending_cash_balance_cents": 9887000,
        "net_cash_flow_cents": 1437000
      }
    }
  ],
  "whole_period": {
    "start_date": "2026-06-01",
    "end_date": "2026-07-31",
    "is_closed": false,
    "totals": {
      "total_inflow_cents": 8147000,
      "total_outflow_cents": -5385000,
      "starting_cash_balance_cents": 7125000,
      "ending_cash_balance_cents": 9887000,
      "net_cash_flow_cents": 2762000
    }
  }
}

400

Malformed request — a missing or unparseable date, a path id that is not a UUID, start_date after end_date, or a range that does not overlap the period this entity has books for. Also returned when the request reached us over plaintext HTTP; see INSECURE_TRANSPORT below and guides/authentication.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

Unparseable date

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "start_date must be a valid date in YYYY-MM-DD format."
  }
}

Path id is not a UUID

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "business_entity_id is not a valid UUID."
  }
}

Range sits entirely outside the reportable period

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The requested range does not overlap the period this entity has reportable books for. It must fall on or after books_start_date (see GET /business_entities) and must not be entirely in the future."
  }
}

Request sent over plaintext HTTP

{
  "error": {
    "code": "INSECURE_TRANSPORT",
    "message": "This request was sent over plaintext HTTP, so any API key it carried was transmitted in the clear. Reissue it over HTTPS, and treat the key as compromised: rotate it."
  }
}

401

Missing, invalid, expired or revoked API key. One message covers every case on purpose — a caller cannot tell a revoked key from an unknown one.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

ExampleinvalidKey

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing, invalid, expired or revoked API key."
  }
}

403

Your key is valid, but this call is not allowed. Either the operation is not served for your kind of key — the balance sheet and cash flow families are provider-only, eight operations in all — or your provider’s Flychain account is not active or not enrolled in the API programme. None of these is a credential problem; rotating the key will not help.

The partner scope refusals do not appear here: a partner key cannot reach these operations at all.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

A partner key on a provider-only operation

{
  "error": {
    "code": "ENDPOINT_NOT_AVAILABLE",
    "message": "This endpoint is available to provider API keys only. See the reference at https://docs.flychain.us for the endpoints a partner key can read."
  }
}

Provider key whose Flychain account is not active

{
  "error": {
    "code": "PROVIDER_NOT_ACTIVE",
    "message": "This provider's Flychain account is not active, so the API is not available to it. Contact Flychain."
  }
}

Provider key on an account not enrolled in the API programme

{
  "error": {
    "code": "PROVIDER_API_NOT_ENABLED",
    "message": "This provider is not enrolled in the Flychain external API programme. Contact Flychain to request access."
  }
}

404

No provider or business entity exists with that id.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

{
  "error": {
    "code": "PROVIDER_NOT_FOUND",
    "message": "No provider exists with that id."
  }
}

{
  "error": {
    "code": "BUSINESS_ENTITY_NOT_FOUND",
    "message": "No business entity exists with that id."
  }
}

409

The entity exists and is in your relationship, but has no books a report can be produced from — it is still onboarding, or it has been deactivated. It appears in GET /business_entities with reporting_available: false; skip it rather than recording a zero.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

ExamplenoBooks

{
  "error": {
    "code": "BOOKS_NOT_AVAILABLE",
    "message": "This business entity does not currently have reportable books. GET /business_entities lists it with reporting_available: false."
  }
}

500

Our side. Safe to retry with backoff.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

ExampleinternalError

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred. Retry with backoff."
  }
}

503

We could not verify your API key right now — our identity provider was unreachable or rate-limited. This is not an authentication failure: the key may well be valid. Retry with backoff rather than treating it as a 401.

Media typeapplication/json

The failure shape for every error — validation, authorization, ours — so a client needs a single error path.

Match on code, not on message: the code set below is the contract and is stable, while wording may be clarified. New codes may be added within v1 (see guides/versioning), so treat an unrecognised code as “the HTTP status is authoritative”.

This includes a request that never reaches a documented operation at all — an unrouted path or a method we do not serve on that path, which is the failure you are most likely to meet while integrating. Those are answered before any operation runs, so no operation below lists them, but they arrive in this same shape, as ENDPOINT_NOT_FOUND (404) and METHOD_NOT_ALLOWED (405). Either one means check the URL rather than your credentials: the operations below are the whole surface.

object

error

required

object

code

required

Machine-readable cause.

• INVALID_REQUEST (400) — malformed dates, a non-UUID path id, an inverted range, or a range with no reportable books behind it.
• INSECURE_TRANSPORT (400) — the request was sent over plaintext http, so the key crossed the network in the clear. Rotate the key, then fix the URL; we refuse rather than redirect so this cannot pass unnoticed.
• INVALID_API_KEY (401) — missing, invalid, expired or revoked key.
• PARTNER_API_NOT_ENABLED (403) — your key is valid, but your organization is not enrolled in the API programme. Contact us; do not rotate the key.
• PROVIDER_NOT_ACTIVE (403) — a provider key whose Flychain account is not active. Contact us; do not rotate the key.
• PROVIDER_API_NOT_ENABLED (403) — a provider key on an account that is not enrolled in the API programme. Contact us; do not rotate the key.
• ENDPOINT_NOT_AVAILABLE (403) — the path exists and your key is valid, but that operation is not served for your kind of key. The balance sheet and cash flow families are provider-only. Your URL is not wrong; do not rotate the key.
• PROVIDER_NOT_IN_PARTNER_SCOPE (403) — the provider exists but is not in your relationship, including one that has left it.
• BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE (403) — the entity exists but does not belong to the provider_id in the path.
• PROVIDER_NOT_FOUND (404) — no provider with that id.
• BUSINESS_ENTITY_NOT_FOUND (404) — no business entity with that id.
• ENDPOINT_NOT_FOUND (404) — the URL itself is not one we serve, as opposed to a record we do not have. Check the path against the operations below.
• METHOD_NOT_ALLOWED (405) — the path exists but not with that method; the Allow response header lists the ones it takes. Every operation here is a GET.
• BOOKS_NOT_AVAILABLE (409) — the entity has no reportable books.
• INTERNAL_ERROR (500) — ours; retry with backoff.
• AUTH_SERVICE_UNAVAILABLE (503) — we could not verify your key; retry with backoff, and do not treat it as an authentication failure.

string

Allowed values: INVALID_REQUEST INSECURE_TRANSPORT INVALID_API_KEY PARTNER_API_NOT_ENABLED PROVIDER_NOT_ACTIVE PROVIDER_API_NOT_ENABLED ENDPOINT_NOT_AVAILABLE PROVIDER_NOT_IN_PARTNER_SCOPE BUSINESS_ENTITY_NOT_IN_PARTNER_SCOPE PROVIDER_NOT_FOUND BUSINESS_ENTITY_NOT_FOUND ENDPOINT_NOT_FOUND METHOD_NOT_ALLOWED BOOKS_NOT_AVAILABLE INTERNAL_ERROR AUTH_SERVICE_UNAVAILABLE

message

required

Human-readable detail. Do not match on it.

string

key

additional properties

any

key

additional properties

any

Examples

ExampleauthUnavailable

{
  "error": {
    "code": "AUTH_SERVICE_UNAVAILABLE",
    "message": "Unable to verify the API key right now. Retry with backoff."
  }
}