API reference

Report runs

Reports kept as they stood, produced again figure for figure after later corrections and reopened months.

GET/v1/report_runsList kept reports
POST/v1/report_runsKeep a report
GET/v1/report_runs/{run_id}Produce a kept report again
GET/v1/report_runs/{run_id}/explainExplain a figure in a kept report

Guides: Read and export reports

List kept reports

GET/v1/report_runs

client.reportRuns.list()

Kept reports, the newest first: those kept by hand, and those each close kept of its month.

Parameters

Name	Type	Description
`report`Query	string or null	Only runs of this report. One of `trial_balance`, `balance_sheet`, `income_statement`, `cash_flow`, `board_pack`
`close_run_id`Query	string or null	An id that starts with `close_run_`.
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

Response

200ReportRunPage

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/report_runs" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Keep a report

POST/v1/report_runs· Idempotent

client.reportRuns.create()

Keep a report as it stands now: the books read through their latest posting sequence, and the manifest recorded so it can be produced again exactly. Any member may keep one, a viewer included; a read-only API key may not, since keeping is a write.

Request body

ReportRunCreate

Response

201ReportRunWithReportOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/report_runs" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"report":"trial_balance"}'

Produce a kept report again

GET/v1/report_runs/{run_id}

client.reportRuns.get()

A kept report, produced again from its manifest, with whether it says exactly what it said when it was kept.

Parameters

Name	Type	Description
`run_id`Path · Required	string	An id that starts with `rpt_run_`.

Response

200ReportRunWithReportOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/report_runs/{run_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Explain a figure in a kept report

GET/v1/report_runs/{run_id}/explain

client.reportRuns.explain()

Why a figure in a kept report is what it is: every journal line behind it, read through the posting sequence the report was, with the entry each belongs to and the transactions and documents behind that entry. Name an account, or a figure.

For a report over a window (the income statement, the cash flow statement, a board pack's figures) the figure is what the lines moved, closing entries left out. For a report as of a day (the balance sheet, the trial balance) and for cash, it is the balance on the day: the opening balance, then the lines of the month the day ends. The newest 500 lines are listed.

Parameters

Name	Type	Description
`run_id`Path · Required	string	An id that starts with `rpt_run_`.
`account_id`Query	string or null	An id that starts with `gla_`.
`figure`Query	string or null	A figure that is not one account's: `cash`, or `mrr` for a report over a window. One of `cash`, `mrr`

Response

200ExplanationOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/report_runs/{run_id}/explain" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Objects

The objects these operations take and return.

ReportRunPage

Name	Type	Description
`data`Required	array of ReportRunOut
`has_more`Required	boolean
`next_cursor`Required	string or null

ReportRunCreate

Name	Type	Description
`as_of`	string (date) or null	For the trial balance and the balance sheet: the day. Defaults to today.
`report`Required	string	`trial_balance`, `balance_sheet`, `income_statement` or `cash_flow`. A board pack's figures are kept by its close. One of `trial_balance`, `balance_sheet`, `income_statement`, `cash_flow`
`since`	string (date) or null	For the income statement and the cash flow statement: the first day. Defaults to this month's first.
`until`	string (date) or null	For the income statement and the cash flow statement: the last day. Defaults to today.

ReportRunWithReportOut

A run with the report it keeps, produced again from its manifest.

Name	Type	Description
`artifact_hash`Required	string	The sha256 of what the report said.
`balance_sheet`	BalanceSheetOut or null
`board_pack`	BoardPackFiguresOut or null
`cash_flow`	CashFlowStatementOut or null
`close_run_id`Required	string or null	An id that starts with `close_run_`.
`created_by`Required	string or null	An id that starts with `usr_`.
`definition_version`Required	integer	The version of the report's definition it was made under.
`id`Required	string	An id that starts with `rpt_run_`.
`income_statement`	IncomeStatementOut or null
`parameters`Required	object	What it was asked for.
`period`Required	string	The day (`2026-09-30`), or the window (`2026-01-01..2026-09-30`).
`recorded_at`Required	string (date-time)
`report`Required	string	One of `trial_balance`, `balance_sheet`, `income_statement`, `cash_flow`, `board_pack`
`reproduced_hash`Required	string	The sha256 of the report as produced now from the manifest.
`reproduces`Required	boolean	True when its figures are exactly what they were when it was kept. Since definition version 2 an account renamed in between does not count against it.
`through_sequence`Required	integer	The books were read as posted through this sequence, and no further.
`trial_balance`	TrialBalanceOut or null

ExplanationOut

Why a figure in a kept report is what it is: the journal lines it adds up from, read through the same posting sequence the report was, so they add up to the kept figure after any later posting or reopen.

Name	Type	Description
`accounts`Required	array of ExplanationAccountOut	The accounts the figure is read from: the account and every account beneath it, or every cash account.
`closing_balance`Required	string	The balance on `until`, as posted through the sequence.
`currency`Required	string
`figure`Required	string	What the report says: the closing balance, or what moved.
`kind`Required	string	`balance`: the figure is the accounts' balance on `until`, the opening balance plus the lines from `since`. `movement`: the figure is what the lines moved from `since` to `until`. One of `balance`, `movement`
`lines`Required	array of ExplanationLineOut	Oldest first.
`opening_balance`Required	string	The balance before `since`, as posted through the sequence.
`report`Required	string	One of `trial_balance`, `balance_sheet`, `income_statement`, `cash_flow`, `board_pack`
`report_run_id`Required	string	An id that starts with `rpt_run_`.
`since`Required	string (date)
`subject`Required	string	What is explained: the account asked for, or a figure (`cash`, `mrr`). One of `account`, `cash`, `mrr`
`through_sequence`Required	integer	Every line here was posted at or before this sequence.
`truncated`Required	boolean	True when older lines were left out; the opening balance is then what stood before the oldest line shown, so the lines still add up.
`until`Required	string (date)

ReportRunOut

A kept report's manifest.

Name	Type	Description
`artifact_hash`Required	string	The sha256 of what the report said.
`close_run_id`Required	string or null	An id that starts with `close_run_`.
`created_by`Required	string or null	An id that starts with `usr_`.
`definition_version`Required	integer	The version of the report's definition it was made under.
`id`Required	string	An id that starts with `rpt_run_`.
`parameters`Required	object	What it was asked for.
`period`Required	string	The day (`2026-09-30`), or the window (`2026-01-01..2026-09-30`).
`recorded_at`Required	string (date-time)
`report`Required	string	One of `trial_balance`, `balance_sheet`, `income_statement`, `cash_flow`, `board_pack`
`through_sequence`Required	integer	The books were read as posted through this sequence, and no further.

BalanceSheetOut

Name	Type	Description
`as_of`Required	string (date)
`assets`Required	BalanceSheetSectionOut
`balanced`Required	boolean
`currency`Required	string
`difference`Required	string
`equity`Required	BalanceSheetSectionOut
`liabilities`Required	BalanceSheetSectionOut
`total_assets`Required	string
`total_liabilities_and_equity`Required	string

BoardPackFiguresOut

What a month's board pack says in figures, every one read from the books through the same posting sequence.

Name	Type	Description
`arr`Required	string	MRR times twelve.
`burning`Required	boolean	True when the trailing net burn is above zero.
`cash`Required	string	Cash across every cash account at the end of the month.
`currency`Required	string	The books' currency, as an ISO 4217 code.
`gross_burn`Required	string or null	Operating cash that left in the month, as a positive figure. Null before the books began.
`gross_margin`Required	string or null	Gross profit over revenue, as a fraction (0.9 = 90%); null with no revenue.
`months`Required	array of BurnMonthOut	Burn for up to six complete months, oldest first, ending with this one; months before the books began are left out.
`mrr`Required	string	Subscription revenue recognized in the month, as Home reads it.
`mrr_month`Required	string (date)	The month MRR is for: this one, by its first day.
`net_burn`Required	string or null	The month's gross burn less its operating inflows. Positive means more went out than came in.
`net_income`Required	string	Net income in the month.
`operating_expenses`Required	string	Operating expenses in the month.
`revenue`Required	string	Revenue in the month, from the income statement.
`runway_months`Required	string or null	Months of cash at the trailing net burn, to one decimal; null when not burning.
`since`Required	string (date)	The month's first day.
`trailing_months`Required	integer	How many months `trailing_net_burn` averages.
`trailing_net_burn`Required	string or null	Average net burn of the three complete months ending with this one: what runway divides by. The figure Home shows as net burn.
`until`Required	string (date)	The month's last day.

CashFlowStatementOut

Name	Type	Description
`balanced`Required	boolean
`beginning_cash`Required	string
`currency`Required	string
`difference`Required	string
`ending_cash`Required	string
`net_change`Required	string
`net_income`Required	string
`sections`Required	array of CashFlowSectionOut
`since`Required	string (date)
`until`Required	string (date)

IncomeStatementOut

Name	Type	Description
`cost_of_revenue`Required	string
`currency`Required	string
`gross_margin`Required	string or null
`gross_profit`Required	string
`net_income`Required	string
`operating_expenses`Required	string
`operating_income`Required	string
`other_expense`Required	string
`other_income`Required	string
`revenue`Required	string
`sections`Required	array of IncomeSectionOut
`since`Required	string (date)
`until`Required	string (date)

TrialBalanceOut

Name	Type	Description
`as_of`Required	string (date)
`balanced`Required	boolean
`currency`Required	string
`difference`Required	string
`rows`Required	array of TrialBalanceRowOut
`total_credits`Required	string
`total_debits`Required	string

ExplanationAccountOut

Name	Type	Description
`code`Required	string
`id`Required	string	An id that starts with `gla_`.
`name`Required	string

ExplanationLineOut

One journal line behind the figure, with the entry it belongs to and the evidence behind that entry.

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`amount`Required	string
`description`Required	string
`direction`Required	string	One of `debit`, `credit`
`document_ids`Required	array of string	The receipts and invoices that support them.
`entry_date`Required	string (date)
`entry_id`Required	string	The journal entry to cite.
`entry_no`Required	integer
`line_id`Required	string	An id that starts with `jel_`.
`memo`Required	string or null
`signed_amount`Required	string	`amount` signed in the account type's normal direction.
`source`Required	string	How the entry was written: `ingest`, `manual`, `schedule`, …
`transaction_ids`Required	array of string	The bank, card or processor transactions the entry was filed from.

BalanceSheetSectionOut

Name	Type	Description
`lines`Required	array of BalanceSheetLineOut
`total`Required	string

BurnMonthOut

Name	Type	Description
`complete`Required	boolean	False for the current month, which is month to date.
`gross_burn`Required	string	Operating cash that left in the month, as a positive figure.
`month`Required	string (date)	The first day of the month.
`net_burn`Required	string	Gross burn less operating inflows. Positive means more went out than came in.
`operating_inflows`Required	string	Operating cash that came in during the month, as a positive figure.

CashFlowSectionOut

Name	Type	Description
`key`Required	string
`lines`Required	array of CashFlowLineOut
`name`Required	string
`total`Required	string

IncomeSectionOut

Name	Type	Description
`groups`Required	array of IncomeGroupOut
`key`Required	string
`name`Required	string
`total`Required	string

TrialBalanceRowOut

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`code`Required	string
`credit`Required	string
`debit`Required	string
`name`Required	string
`type`Required	string

BalanceSheetLineOut

Name	Type	Description
`account_id`Required	string or null	An id that starts with `gla_`.
`amount`Required	string
`code`Required	string
`name`Required	string

CashFlowLineOut

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`amount`Required	string
`code`Required	string
`name`Required	string

IncomeGroupOut

Name	Type	Description
`code`Required	string
`lines`Required	array of IncomeLineOut
`name`Required	string
`total`Required	string

IncomeLineOut

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`amount`Required	string
`code`Required	string
`name`Required	string