---
title: "Get general ledger summary"
method: GET
path: "/v1/general-ledger-summary"
tags: ["v1 - General Ledger Summary"]
---

# Get general ledger summary

`GET /v1/general-ledger-summary`

## Request

- Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from)
- URL: `https://light.inc/v1/general-ledger-summary`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

Returns the opening balance, net movement and closing balance of every account over a date range. Each account carries one figure per entity in scope, the `subtotal` of those entities' own books, the intercompany `elimination` the selection is entitled to, and their `total`. Without a company entity filter the scope is every entity of the company, including inactive ones. An elimination between two entities applies only when both are in scope; one belonging to the group as a whole applies only when the scope covers the whole company.

## Query parameters

- `from` string, date
- `to` string, date
- `sort` string: Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `accountCode`.
- `filter` string: Filter string in the format `field:operator:value`. To provide multiple filters, separate them with commas. Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`. - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). Available fields: `accountCode`, `accountId`, `accountType`, `companyEntityCode`, `companyEntityId`.
- `limit` integer
- `cursor` string

## Response `default`

default response

- ExternalCursorPaginatedResponseV1ModelExternalGeneralLedgerSummaryRowV1Model
  - `records` ExternalGeneralLedgerSummaryRowV1Model[]: List of records for the current page
    - `accountId` string, uuid
    - `accountCode` integer
    - `accountLabel` string
    - `accountType` 'BANK' | 'CARD' | 'CASH_AND_EQUIVALENTS' | 'ACCOUNTS_RECEIVABLE' | 'INVENTORY' | 'CORPORATE_TAX_RECEIVABLE' | 'OTHER_CURRENT_ASSET' | 'INTANGIBLE_NON_CURRENT_ASSET' | 'TANGIBLE_NON_CURRENT_ASSET' | 'FINANCIAL_NON_CURRENT_ASSET' | 'CORPORATE_TAX_DEFERRED_ASSET' | 'OTHER_NON_CURRENT_ASSET' | 'ACCOUNTS_PAYABLE' | 'OVERDRAFT_FACILITY' | 'CORPORATE_TAX_PAYABLE' | 'OTHER_CURRENT_LIABILITY' | 'LONG_TERM_LOAN' | 'CORPORATE_TAX_DEFERRED_LIABILITY' | 'OTHER_LONG_TERM_LIABILITY' | 'CONTRIBUTED_CAPITAL' | 'RETAINED_EARNINGS' | 'ACCUMULATED_OTHER_COMPREHENSIVE_INCOME' | 'OTHER_EQUITY' | 'COST_OF_SALES' | 'DISTRIBUTION_COST' | 'GENERAL_AND_ADMINISTRATIVE_EXPENSE' | 'PERSONNEL_COST' | 'OTHER_OPERATING_EXPENSE' | 'INCOME_TAX' | 'DEPRECIATION_AND_AMORTIZATION' | 'NON_OPERATING_EXPENSE' | 'INTEREST_EXPENSE' | 'EXCHANGE_RATE_LOSS_REALIZED' | 'EXCHANGE_RATE_LOSS_UNREALIZED' | 'OTHER_FINANCIAL_EXPENSE' | 'REVENUE' | 'DISCOUNT' | 'NON_OPERATING_INCOME' | 'INTEREST_INCOME' | 'EXCHANGE_RATE_GAIN_REALIZED' | 'EXCHANGE_RATE_GAIN_UNREALIZED' | 'OTHER_FINANCIAL_INCOME', nullable: ⚠️ This enum is not exhaustive; new values may be added in the future.
    - `entities` ExternalGeneralLedgerSummaryEntityResultV1Model[]: One result per entity in scope, whether or not it posted to this account
      - `companyEntityId` string, uuid
      - `companyEntityCode` string
      - `companyEntityName` string
      - `localCurrency` string, nullable
      - `amounts` ExternalGeneralLedgerSummaryAmountsV1Model: Balance carried into the period, the period's own net, and the two added together
        - `openingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
          - `groupAmount` integer: Amount in currency of base company
          - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
        - `movement` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
          - `groupAmount` integer: Amount in currency of base company
          - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
        - `closingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
          - `groupAmount` integer: Amount in currency of base company
          - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
    - `subtotal` ExternalGeneralLedgerSummaryAmountsV1Model: Balance carried into the period, the period's own net, and the two added together
      - `openingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
      - `movement` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
      - `closingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
    - `elimination` ExternalGeneralLedgerSummaryAmountsV1Model: Balance carried into the period, the period's own net, and the two added together
      - `openingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
      - `movement` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
      - `closingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
    - `total` ExternalGeneralLedgerSummaryAmountsV1Model: Balance carried into the period, the period's own net, and the two added together
      - `openingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
      - `movement` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
      - `closingBalance` ExternalGeneralLedgerSummaryFigureV1Model: A signed, debit-positive figure in the group currency, and in the entity's local currency when the figure belongs to one entity
        - `groupAmount` integer: Amount in currency of base company
        - `localAmount` integer, nullable: Amount in local currency of entity, null on figures that cover more than one entity
    - `groupCurrency` string
  - `hasMore` boolean: Boolean flag indicating if there are more records available
  - `nextCursor` string, nullable: Cursor for fetching the next page
  - `prevCursor` string, nullable: Cursor for fetching the previous page

---

[API](https://skmtc.dev/light/apis/light-api.md) - [All operations](https://skmtc.dev/light/apis/light-api/llms.txt) - [OpenAPI document](https://skmtc.dev/light/apis/light-api/revisions/84f51306f648?raw)