Reports

Largest expense accounts across companies

Read-only firm staff report. Runs Transaction Detail by Account for each selected accessible company (client companies only by default; firm books need explicit opt-in and permission), groups expense accounts by name across companies, and ranks them. Returns companies (organizationId, name, basis, expenseTotalCents, excludedCents, includedCents, error when one company's report failed), includedTotalCents, accounts (rank, name, totalCents, shareOfIncludedPct, lineCount, byCompany, topPayees), otherAccounts, and excludedAccounts. Amounts are positive integer cents matching each company's Profit & Loss for the same dates and basis.

get/reports/firm-expense-breakdown

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/reports/firm-expense-breakdown
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Query parameters

companyIdsstring

Comma-separated company organization UUIDs (up to 100). Omit for every accessible client company.

includeFirmBooksboolean
period'this_month' | 'last_month' | 'this_quarter' | 'last_quarter' | 'ytd' | 'this_year' | 'last_year'

Preset range; defaults to ytd. startDate/endDate override it.

startDatestring date

Inclusive period start, YYYY-MM-DD.

endDatestring date

Inclusive period end, YYYY-MM-DD.

basis'accrual' | 'cash'

Financial reporting basis. Omit to use the company's default_report_basis. Cash responses include coverage metadata and structured issues; amounts remain integer cents.

excludeAccountsstring

Comma-separated words; expense accounts whose name contains any of them (case-insensitive) are left out and listed in excludedAccounts.

topinteger
payeesPerAccountinteger
includeAskClientboolean

Include each company's Ask Client expense account as its own line.

Response

Ranked expense accounts across companies with payees and exclusions

Changes

No recorded changes to this operation across all 5 revisions of this API.