API reference

Board packs

What each month's close hands the board: its statements, burn, runway and MRR, and the commentary written about them.

GET/v1/board_packsList board packs
POST/v1/board_packsMake the board pack of a month closed before packs existed
GET/v1/board_packs/{pack_id}Get a board pack with its figures and statements
PATCH/v1/board_packs/{pack_id}Write a board pack's commentary
DELETE/v1/board_packs/{pack_id}Delete a board pack's commentary

List board packs

GET/v1/board_packs

client.boardPacks.list()

Every board pack, the newest first: one for each close of each month, a reopened month's earlier packs kept as they were sent.

Parameters

Name	Type	Description
`period`Query	string or null	Only the packs of this month, like 2026-09.
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

Response

200BoardPackPage

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/board_packs" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Make the board pack of a month closed before packs existed

POST/v1/board_packs· Idempotent

client.boardPacks.create()

Make the board pack of a closed month whose close has none: one closed before board packs existed. Its figures are read through the sequence that close signed off, and kept. Closing a month makes its pack without this. Refused with period_not_closed for a month that is open or reopened, and with board_pack_exists when the close already has one.

Request body

NewBoardPack

Response

201BoardPackDetailOut

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/board_packs" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"period":"…"}'

Get a board pack with its figures and statements

GET/v1/board_packs/{pack_id}

client.boardPacks.get()

A board pack: the month's figures, its balance sheet, income statement and cash flow statement as its close kept them, and the commentary.

Parameters

Name	Type	Description
`pack_id`Path · Required	string	An id that starts with `board_pack_`.

Response

200BoardPackDetailOut

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/board_packs/{pack_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Write a board pack's commentary

PATCH/v1/board_packs/{pack_id}· Idempotent

client.boardPacks.update()

Write a pack's commentary. Its figures cannot change: they are what its close kept.

Parameters

Name	Type	Description
`pack_id`Path · Required	string	An id that starts with `board_pack_`.

Request body

BoardPackChanges

Response

200BoardPackOut

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 PATCH "https://api.ledgerit.ai/v1/board_packs/{pack_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Delete a board pack's commentary

DELETE/v1/board_packs/{pack_id}

client.boardPacks.delete()

Delete a pack and its commentary. The reports its close kept stay, and POST makes the pack again from them.

Parameters

Name	Type	Description
`pack_id`Path · Required	string	An id that starts with `board_pack_`.

Response

204No content

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 DELETE "https://api.ledgerit.ai/v1/board_packs/{pack_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Objects

The objects these operations take and return.

BoardPackPage

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

NewBoardPack

Name	Type	Description
`period`Required	string	A closed month, like 2026-09.

BoardPackDetailOut

A board pack with its figures and statements, each produced again from the report its close kept.

Name	Type	Description
`asks`Required	string or null	What the company asks of its board and investors.
`balance_sheet`Required	BalanceSheetOut or null	As of the month's last day.
`cash_flow`Required	CashFlowStatementOut or null	For the month.
`challenges`Required	string or null	What did not, and what is being done about it.
`close_run_id`Required	string	The close it was made from.
`close_version`Required	integer	Which close of the month: 1 for the first, 2 after a reopen.
`closed_at`Required	string (date-time) or null	When that close was signed off.
`created_at`Required	string (date-time)	When the pack was opened.
`figures`Required	BoardPackFiguresOut or null	Cash, burn, runway, MRR, ARR, revenue and margin for the month.
`highlights`Required	string or null	What went well this month.
`id`Required	string	The pack's id.
`income_statement`Required	IncomeStatementOut or null	For the month.
`period`Required	string	The month it reports, like 2026-09.
`report_run_ids`Required	array of string	The kept reports it is made of: its figures and its three statements.
`reproduces`Required	boolean	True when every figure is exactly what it was when the close kept it.
`stands`Required	boolean	True while its close stands; false once the month was reopened, when the pack keeps the figures the board was given and a later close has its own pack.
`through_sequence`Required	integer	The posting sequence every figure in the pack reads through.
`updated_at`Required	string (date-time)	When its commentary last changed.
`updated_by`Required	string or null	An id that starts with `usr_`.
`updated_by_email`Required	string or null	Their address, while they are a member of these books.

BoardPackChanges

Only the fields sent change; an empty one, or null, clears it.

Name	Type	Description
`asks`	string or null	What the company asks of its board.
`challenges`	string or null	What did not.
`highlights`	string or null	What went well this month.

BoardPackOut

A board pack: one close of one month, and what was written for the board about it.

Name	Type	Description
`asks`Required	string or null	What the company asks of its board and investors.
`challenges`Required	string or null	What did not, and what is being done about it.
`close_run_id`Required	string	The close it was made from.
`close_version`Required	integer	Which close of the month: 1 for the first, 2 after a reopen.
`closed_at`Required	string (date-time) or null	When that close was signed off.
`created_at`Required	string (date-time)	When the pack was opened.
`highlights`Required	string or null	What went well this month.
`id`Required	string	The pack's id.
`period`Required	string	The month it reports, like 2026-09.
`report_run_ids`Required	array of string	The kept reports it is made of: its figures and its three statements.
`stands`Required	boolean	True while its close stands; false once the month was reopened, when the pack keeps the figures the board was given and a later close has its own pack.
`through_sequence`Required	integer	The posting sequence every figure in the pack reads through.
`updated_at`Required	string (date-time)	When its commentary last changed.
`updated_by`Required	string or null	An id that starts with `usr_`.
`updated_by_email`Required	string or null	Their address, while they are a member of these books.

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

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)

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.

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)

BalanceSheetSectionOut

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

CashFlowSectionOut

Name	Type	Description
`key`Required	string
`lines`Required	array of CashFlowLineOut
`name`Required	string
`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.

IncomeSectionOut

Name	Type	Description
`groups`Required	array of IncomeGroupOut
`key`Required	string
`name`Required	string
`total`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