Reports

Profit & Loss across companies

Read-only firm staff report. Runs each selected accessible company's Profit & Loss for the same dates (client companies only by default; firm books need explicit opt-in and permission). Returns startDate, endDate, basis, mixedBasis, companies (organizationId, name, basis, revenueCents, expenseCents, askClientNetCents, netIncomeCents, optional revenueAccounts and expenseAccounts, error when one company's report failed), and totals across companies that reported. Integer cents matching each company's Profit & Loss.

get/reports/firm-profit-and-loss

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/reports/firm-profit-and-loss
  • 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.

includeAccountsboolean

Also return each company's non-zero income and expense account lines.

Response

Profit & Loss per company with combined totals

Changes

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