API reference

Home

Cash, burn, runway, MRR and ARR, all read from the books at one posting sequence.

GET/v1/homeGet cash, burn, runway and MRR at one posting sequence, and cash after known bills
GET/v1/home/attentionList what needs a person today

Get cash, burn, runway and MRR at one posting sequence, and cash after known bills

GET/v1/home

client.home.get()

Cash, burn, runway, MRR and ARR, every one read from the books at the same posting sequence — so the page never mixes before and after a post, and the same sequence always gives the same figures.

Beside them, cash after known bills: cash less the bills coming due and the payroll expected over the next 90 days. The bills and payroll are read as the books stand, not at the sequence (decision 0167).

Parameters

Name	Type	Description
`through_sequence`Query	integer or null	Read the books as posted through this sequence. Defaults to the latest.
`as_of`Query	string (date) or null	Defaults to today.

Response

200HomeOut

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

List what needs a person today

GET/v1/home/attention

client.home.attention()

What needs a person today: an unhealthy connection (failing, needing a sign-in within a week, or behind its freshness target) or an overdue close first, because the books are wrong or late until someone acts, then the open questions waiting on the caller, transactions to review, receipts to match and the open items waiting on the owner — not the ones with the books' accountant.

A question waits on the member it was asked of. For an owner or admin (questions.business) it also counts the business's questions: those asked of an owner or admin, or of nobody who still opens the books, such as a member who has left — the questions that make the month's Questions part the owner's.

Response

200AttentionOut

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

Objects

The objects these operations take and return.

HomeOut

The books' headline figures, at one posting sequence.

Name	Type	Description
`after_known_bills`	KnownOutflowsOut or null	Cash after the bills and payroll due in the next 90 days; null for books not set up yet.
`arr`Required	string	MRR × 12.
`as_of`Required	string (date)
`burning`Required	boolean	True when the net burn is above zero.
`cash`Required	string	Cash across every cash account at the end of `as_of`.
`currency`Required	string
`gross_burn`Required	string or null	Operating cash that left in the last complete month, as a positive figure.
`mrr`Required	string	Subscription revenue recognized in `mrr_month`, read from the books (decision 0036).
`mrr_month`Required	string (date)	The complete month MRR is for: the first day of it.
`net_burn`Required	string or null	Average net burn of the last complete months (up to three); null with none yet.
`runway_months`Required	string or null	Months of cash at the net burn, to one decimal; null when not burning.
`through_sequence`Required	integer	Every figure counts the book's entries posted up to and including this sequence, and nothing after. Pass it back as `through_sequence` to read the same cut again.
`trailing_months`Required	integer	How many complete months `net_burn` averages.

AttentionOut

What needs a person today, blocking items first; nothing listed when nothing needs anyone.

Name	Type	Description
`items`Required	array of AttentionItemOut

KnownOutflowsOut

Cash less what the books know is due soon (decision 0167).

Name	Type	Description
`bills`Required	string	What is due by `through` on the bills in and the bills vendors' rhythms say are coming, late ones included: the total of `GET /v1/reports/upcoming_bills` over the same days.
`cash_after`Required	string	`cash` less `bills` and `payroll`. The cash is the cut's, at `through_sequence`; the bills and payroll are the books' as they stand when read, so this one figure is not pinned to the sequence.
`payroll`Required	string	The payroll runs expected by `through`, each payroll provider's at the rhythm of its last two runs and at what its last run took out of cash. A provider with no run in 60 days is left out.
`payroll_estimated`Required	boolean	True when `payroll` is projected from the last run rather than runs a provider has scheduled: always, when there is any.
`through`Required	string (date)	The last day counted: 90 days from `as_of`, `as_of` included.

AttentionItemOut

Name	Type	Description
`blocking`Required	boolean	True for what stops the books being right: an unhealthy connection, an overdue close.
`count`Required	integer	How many: connections (also those that may not read the provider's people), overdue tasks, open questions waiting on the caller (`questions_for_you`), transactions, documents, or open items waiting on the owner (`exceptions_open`).
`kind`Required	string	`connection_failing`, `connection_reauth`, `connection_behind`, `close_overdue`, `connection_people_unreadable`, `questions_for_you`, `transactions_to_review`, `documents_to_match` or `exceptions_open`.
`period_key`	string or null	For `close_overdue`, the month (`2026-09`) whose tasks are overdue.
`provider`	string or null	For a connection item, the provider of the first such connection, such as `mercury`.
`subject_about`	string or null	What kind of record that is: `transaction` or `journal_entry`.
`subject_id`	string or null	An id. Which resource it names is given by the field beside it.