> ## Documentation Index
> Fetch the complete documentation index at: https://docs.light.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# Get general ledger summary

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



## OpenAPI

````yaml /openapi-public.json get /v1/general-ledger-summary
openapi: 3.0.1
info:
  title: Light API
  version: 1.0.0
servers: []
security:
  - apiKeyAuth: []
  - bearerAuth: []
paths:
  /v1/general-ledger-summary:
    get:
      tags:
        - v1 - General Ledger Summary
      summary: Get general ledger summary
      description: >-
        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.
      operationId: getGeneralLedgerSummary
      parameters:
        - name: from
          in: query
          description: >-
            First day included in the movement figures, inclusive. A UTC
            calendar date in `YYYY-MM-DD` format.
          schema:
            type: string
            format: date
            example: '2026-01-01'
        - name: to
          in: query
          description: >-
            Last day included in the movement figures, inclusive. A UTC calendar
            date in `YYYY-MM-DD` format.
          schema:
            type: string
            format: date
            example: '2026-01-31'
        - name: sort
          in: query
          schema:
            type: string
            description: >-
              Sort string in the format `field:direction`. To provide multiple
              sort fields, separate them with commas.


              Available directions: `asc`, `desc`. 


              Available fields: `accountCode`.
            example: amount:desc,createdAt:asc
        - name: filter
          in: query
          schema:
            type: string
            description: >-
              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`.
            example: state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
        - name: limit
          in: query
          description: Maximum number of items to return. Default is 50, maximum is 200.
          schema:
            type: integer
            format: int32
        - name: cursor
          in: query
          description: >-
            The cursor position to start returning results from.

            To opt-in into cursor-based pagination, provide `0` for the initial
            request.

            For subsequent requests, use `nextCursor` and `prevCursor` from the
            previous response to navigate.

            Cursor values are opaque and should not be constructed manually.
          schema:
            type: string
      responses:
        default:
          description: default response
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: >-
                  #/components/schemas/ExternalCursorPaginatedResponseV1ModelExternalGeneralLedgerSummaryRowV1Model
components:
  schemas:
    ExternalCursorPaginatedResponseV1ModelExternalGeneralLedgerSummaryRowV1Model:
      type: object
      properties:
        records:
          type: array
          description: List of records for the current page
          items:
            $ref: '#/components/schemas/ExternalGeneralLedgerSummaryRowV1Model'
        hasMore:
          type: boolean
          description: Boolean flag indicating if there are more records available
        nextCursor:
          type: string
          description: Cursor for fetching the next page
          nullable: true
        prevCursor:
          type: string
          description: Cursor for fetching the previous page
          nullable: true
    ExternalGeneralLedgerSummaryRowV1Model:
      type: object
      properties:
        accountId:
          type: string
          format: uuid
        accountCode:
          type: integer
          format: int32
        accountLabel:
          type: string
        accountType:
          type: string
          description: >-
            ⚠️ This enum is not exhaustive; new values may be added in the
            future.
          nullable: true
          deprecated: false
          enum:
            - 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
        entities:
          type: array
          description: >-
            One result per entity in scope, whether or not it posted to this
            account
          items:
            $ref: >-
              #/components/schemas/ExternalGeneralLedgerSummaryEntityResultV1Model
        subtotal:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryAmountsV1Model'
        elimination:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryAmountsV1Model'
        total:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryAmountsV1Model'
        groupCurrency:
          type: string
          example: USD
      description: List of records for the current page
    ExternalGeneralLedgerSummaryEntityResultV1Model:
      type: object
      properties:
        companyEntityId:
          type: string
          format: uuid
        companyEntityCode:
          type: string
        companyEntityName:
          type: string
        localCurrency:
          type: string
          nullable: true
          example: USD
        amounts:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryAmountsV1Model'
      description: One entity's own book, before any elimination
    ExternalGeneralLedgerSummaryAmountsV1Model:
      type: object
      properties:
        openingBalance:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryFigureV1Model'
        movement:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryFigureV1Model'
        closingBalance:
          $ref: '#/components/schemas/ExternalGeneralLedgerSummaryFigureV1Model'
      description: >-
        Balance carried into the period, the period's own net, and the two added
        together
    ExternalGeneralLedgerSummaryFigureV1Model:
      type: object
      properties:
        groupAmount:
          type: integer
          description: Amount in currency of base company
          format: int64
        localAmount:
          type: integer
          description: >-
            Amount in local currency of entity, null on figures that cover more
            than one entity
          format: int64
          nullable: true
      description: >-
        A signed, debit-positive figure in the group currency, and in the
        entity's local currency when the figure belongs to one entity
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      description: >-
        Basic authentication header of the form **Basic** **<api_key>**, where
        **<api_key>** is your api key.
      name: Authorization
      in: header
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````