Reports

General ledger (recent posted journal entries)

get/companies/{companyId}/reports/general-ledger

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/reports/general-ledger
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid

Concrete legal entity to read. Mutually exclusive with reportingScopeId/scopeAsOf. Omission is accepted only when the actor is authorized to exactly one concrete entity.

reportingScopeIdstring uuid

Immutable within-company consolidated reporting-scope identity. Must be supplied with scopeAsOf and cannot be combined with entityId.

scopeAsOfstring date

ISO date used to pin the effective sealed reporting-scope hierarchy version. Must be supplied with reportingScopeId.

startDatestring date

Inclusive period start (YYYY-MM-DD). Must be supplied together with endDate.

endDatestring date

Inclusive period end (YYYY-MM-DD). Must be supplied together with startDate.

allTime'true'

true reports from the first through the last posted month on the P&L and cash flow, where omitting startDate/endDate still returns only the latest posted month, so "all time" must be requested by name. The general ledger reads an omitted range as the whole ledger either way. Cannot be combined with startDate/endDate, month or a comparePeriod other than none (400).

classIdstring

Optional class filter for class-aware report endpoints. Pass a company-scoped accounting class UUID, or unassigned for journal lines with no class. Customer-facing use returns data only for active approved company classes.

limitinteger

Maximum journal entries per page. Defaults to 200 and is clamped to 1000.

cursorstring

Response

General ledger payload

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.