Reports

Generate a financial packet JSON

Returns normalized financial statement JSON with integer-cent amounts. Clients render PDFs/HTML from this JSON.

get/reports/financial-packet

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/reports/financial-packet
  • 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

startDatestring date
endDatestring date
includestring

Comma-separated reports: profit-and-loss,balance-sheet,trial-balance,general-ledger,bank-reconciliation-status

generalLedgerLimitinteger
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.

Response

Financial packet JSON

organizationobject
currencyCodestring
generatedAtstring date-time
amountUnit'integer_cents'
basis'accrual' | 'cash'
defaultReportBasis'accrual' | 'cash'
reportsobject
warningsstring[]

Changes

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