LIlight
v1 - General Ledger Summary

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.

get/v1/general-ledger-summary

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

fromstring date
Example:2026-01-01

First day included in the movement figures, inclusive. A UTC calendar date in YYYY-MM-DD format.

tostring date
Example:2026-01-31

Last day included in the movement figures, inclusive. A UTC calendar date in YYYY-MM-DD format.

sortstring

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
filterstring

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
limitinteger

Maximum number of items to return. Default is 50, maximum is 200.

cursorstring

The cursor position to start returning results from. Omit it, or provide 0, for the initial request. For subsequent requests, use nextCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually. This endpoint paginates by cursor only and has no offset parameter.

Response

default response

hasMoreboolean

Boolean flag indicating if there are more records available

nextCursorstring nullable

Cursor for fetching the next page

prevCursorstring nullable

Cursor for fetching the previous page

Example response

{
  "records": [
    {
      "entities": [
        {
          "localCurrency": "USD"
        }
      ],
      "groupCurrency": "USD"
    }
  ]
}

Changes

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