Developers
API reference
Every operation of the public API, drawn from its OpenAPI document. A field or an endpoint appears here the day it ships.
LedgerIt API · Version 1.0.0 · OpenAPI document
Authenticate with an API key from Settings: Authorization: Bearer ll_…. A key acts as the member who made it, in the books it was made in. Errors are {"error": {"type", "code", "message", "param", "request_id"}}; branch on code. Creating calls take an Idempotency-Key, so a retry never writes twice.
Base URL
Every path below is relative to it.
https://api.ledgerit.aiConventions
- Authentication
- Send an API key from Settings as a bearer token. A key acts as the member who made it, in the books it was made in, with that member's role.
- Which books
- A key reaches its own books. A session that opens several sets of books names one with the
X-Entity-Idheader. - Retries
- Operations marked idempotent take an
Idempotency-Keyheader. Retrying with the same key returns the first answer instead of writing twice. Keys are kept for 24 hours. - Errors
- Every failure carries the same envelope. Branch on
code, which is stable;messageis for people.
{
"error": {
"type": "invalid_request_error",
"code": "…",
"message": "…",
"param": null,
"request_id": "…"
}
}Resources
One page per resource, each operation with its parameters, body, response and an example.
- CompanyThe company behind the books: its name, address and fiscal year.2 operations
- BillingThe plan the company is on, the monthly spend it is priced by, the price list, and the Stripe pages that start or change it.7 operations
- HomeCash, burn, runway, MRR and ARR, all read from the books at one posting sequence.2 operations
- TransactionsMoney that moved at a bank, card or processor, and what it was filed as.23 operations
- Bank statementsUploaded statements kept as the bank printed them, each line pointing at the transaction it became.5 operations
- Reconciliation matchesWhich statement lines and which ledger lines are the same money, matched or undone.4 operations
- CommentsNotes on a transaction for everyone in the books, which can mention members and be resolved.4 operations
- QuestionsA question about a transaction asked of one member, and their answer.5 operations
- DocumentsThe receipts and invoices behind transactions, and which transactions each supports.8 operations
- Receipt inboxThe address to forward receipts to, and the emails forwarded there with what became of each.3 operations
- MailboxesA connected Gmail or Outlook mailbox, searched now for the receipts of charges that have none.2 operations
- Mailbox messagesThe emails a mailbox search read, and whether each became a charge's receipt.2 operations
- Receipt searchesOne transaction's receipt, looked for in every connected mailbox, and how far the search got.2 operations
- RulesHow transactions are filed: written rules first, then the model.10 operations
- AutonomyHow much the model may file without a person, and every policy the books have had.4 operations
- AccountsThe chart of accounts, each account's balance and its register.10 operations
- DimensionsThe ways the books are sliced, such as department or project.5 operations
- Dimension valuesThe values a dimension takes, such as Engineering under Department.5 operations
- Journal entriesPosted entries in the ledger. Corrections are reversals, never edits.6 operations
- DraftsEntries being written that have not reached the ledger yet.6 operations
- Opening balancesWhat each balance-sheet account held on the day the books begin.2 operations
- CounterpartiesThe vendors and customers money moves between.9 operations
- Counterparty rolesWhat a counterparty is to the books: customer, vendor, employee, investor, lender or founder.5 operations
- InvoicesWhat customers are billed: drafts written freely, issued onto receivables with their due day, voided by reversal.10 operations
- Credit notesWhat customers are credited: issued against the invoice they correct, or kept as credit to apply to later invoices.8 operations
- BillsWhat vendors billed: drafts entered freely, one vendor's number taken once, approved onto payables with their due day, voided by reversal.9 operations
- Bill inboxThe address vendors send their bills to, and the emails sent there with what became of each.3 operations
- PaymentsMoney received from customers and paid to vendors, applied across invoices and bills, with what is left unapplied.10 operations
- Payment destinationsWhere vendors are paid: versioned bank accounts and addresses, kept encrypted, verified by a person before money goes there.5 operations
- ApprovalsA person's go-ahead for a payment, bound to its amount and destination, expiring, and stale the moment either changes.3 operations
- Financing instrumentsSAFEs from the day the money arrives to the priced round they convert in: issued at proceeds, previewed and converted into preferred stock and paid-in capital.12 operations
- Intercompany transactionsWhat one set of books of an organization is owed by another: one command posts an entry in each, through due-from and due-to accounts; a reversal undoes both.4 operations
- Fixed assetsEquipment in the register, depreciated by every close straight line over its useful life, and disposed of by one entry that posts the gain or loss.6 operations
- BudgetsA plan for a fiscal year by month, account and department, in versions and scenarios, and budget vs. actual read from the ledger.9 operations
- FX ratesWhat one unit of a foreign currency is in your books' currency, day by day. Correcting one never changes a line already posted.5 operations
- RevaluationsForeign balances moved to the closing rate, the difference posted as a gain or loss of its own.2 operations
- Open itemsEvery invoice, bill and payment on receivables and payables, with what each has left.2 operations
- AllocationsPayments applied to invoices and bills, and undoing one.2 operations
- PeriodsThe months of the books: soft-close, close and reopen them.7 operations
- Close tasksThe checklist each month's close works through, and its sign-offs.7 operations
- Close runsEach close of each month: its tasks, who signed each off, and the sequence it closed at.3 operations
- Account reviewsEach balance-sheet account a month's close checks against its support, with the difference and the evidence.6 operations
- ExceptionsWhat blocks a month from closing, and how each one is resolved.7 operations
- ReconciliationsAn account's balance held against its statement.2 operations
- SchedulesPayments and receipts spread over the months they pay for, each month's share taken in at its close.9 operations
- Equity awardsOption, RSA and RSU grants: recorded with their vesting, expensed straight line by every close, and forfeited when the holder leaves.6 operations
- Stock-based compensation runsEach month's stock-based compensation as its close posted it, split by department, with the entry behind it.1 operation
- ReportsThe financial statements, burn and runway, and spend by department.12 operations
- Report runsReports kept as they stood, produced again figure for figure after later corrections and reopened months.4 operations
- Board packsWhat each month's close hands the board: its statements, burn, runway and MRR, and the commentary written about them.5 operations
- MigrationsBooks moved in from QuickBooks, Xero or a file as of a cutover day, mapped account by account and tied out to the cent.12 operations
- Tax linesThe Form 1120 line each GL account reports on, for the CPA's export.2 operations
- W-9 requestsW-9s asked of vendors by email, and what each vendor certified when they completed theirs.4 operations
- Receipt requestsMissing receipts asked of the person who swiped the card, by email, with reminders.7 operations
- Cardholder contactsThe email addresses the books keep for cardholders a card program names without one.5 operations
- Cardholder identitiesThe people a card program names, by its own id for them, and the member of the books each one is.8 operations
- Detected sourcesThe accounts the books' own transactions name and the books do not read yet, such as a Stripe payout or a Gusto debit, with the lines that named them.4 operations
- Investor sharesLinks that share the closed months with an investor, read-only, and when each was last opened.4 operations
- NotificationsWhat LedgerIt told the caller, and marking it read.4 operations
- Notification preferencesWhich kinds of notification the caller has turned off.2 operations
- SearchFind GL accounts, counterparties, transactions, journal entries and rules by name, description, code or number.1 operation
- Audit eventsWhat was done to the books and who decided it, for the whole books or one record.1 operation
- Audit archiveThe audit trail's sealed segments, each downloadable for a short time.2 operations
- ContributionsThe accounting work in the books, counted: who categorized, reconciled, posted or closed what, by day, as a feed and as a year.5 operations
- PeopleWho a contributor is in these books: their name, picture and role while they are a member.1 operation
- Webhook subscriptionsAddresses the books' events are sent to as they happen, signed, with each delivery and its tries.8 operations
- BooksThe books as one archive, restored into empty books with the same trial balance, and each month's share of work done unattended and how ready it is to close.6 operations
- Books check tolerancesThe vendors a daily books check is wider for, and by how much, so a vendor whose amounts vary is not flagged every month.4 operations
- Model proposalsEvery GL account a model proposed for a transaction, with the evidence shown when LedgerIt researched an inbox item, and the department and spread it proposed.2 operations
- ConnectionsEach provider the books are connected to, read only: whether it syncs, when it last did, what went wrong, and whether it may read the provider's people.2 operations
- Bank accounts and cardsEach bank account and card a connection reads, and the GL account it posts to by date, remapped from a date.6 operations