Reports

General ledger

Returns account activity in integer cents with totalEntries and full-period totals independent of paging. Accounts include openingBalance (zero by default). Entries include journalEntryId, sourceKind, sourceId, and synthetic for source-entry links and cash-basis adjustment identification. includeOpeningBalance=true adds the balance before startDate to running and ending balances, including accounts with no period activity.

get/reports/general-ledger

Request

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

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.

startDatestring date

Inclusive period start, YYYY-MM-DD.

endDatestring date

Inclusive period end, YYYY-MM-DD.

accountIdstring uuid

Limit activity to this company's chart account.

offsetinteger

Rows to skip for an account-specific activity page.

limitinteger

Maximum activity rows per account.

includeOpeningBalanceboolean

Include the balance before startDate and carry it into running and ending balances, using the selected accounting basis.

Response

General ledger with resolved basis and coverage metadata

basis'accrual' | 'cash' required
amountUnit'integer_cents' required

Changes

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