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

general-ledger-summary

curl --request GET \
  --url https://api.light.inc/v1/general-ledger-summary \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/general-ledger-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.light.inc/v1/general-ledger-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.light.inc/v1/general-ledger-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/general-ledger-summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "records": [
    {
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountCode": 123,
      "accountLabel": "<string>",
      "accountType": "BANK",
      "entities": [
        {
          "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "companyEntityCode": "<string>",
          "companyEntityName": "<string>",
          "localCurrency": "USD",
          "amounts": {
            "openingBalance": {
              "groupAmount": 123,
              "localAmount": 123
            },
            "movement": {
              "groupAmount": 123,
              "localAmount": 123
            },
            "closingBalance": {
              "groupAmount": 123,
              "localAmount": 123
            }
          }
        }
      ],
      "subtotal": {
        "openingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "movement": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "closingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        }
      },
      "elimination": {
        "openingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "movement": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "closingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        }
      },
      "total": {
        "openingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "movement": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "closingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        }
      },
      "groupCurrency": "USD"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Query Parameters

from

string<date>

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

Example:

"2026-01-01"

string<date>

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

Example:

"2026-01-31"

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.

Example:

"amount:desc,createdAt:asc"

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.

Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null"

limit

integer<int32>

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

cursor

string

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.

Response

default - application/json;charset=UTF-8

default response

records

object[]

List of records for the current page

Show child attributes

hasMore

boolean

Boolean flag indicating if there are more records available

nextCursor

string | null

Cursor for fetching the next page

prevCursor

string | null

Cursor for fetching the previous page

⌘I

Get general ledger summary

curl --request GET \
  --url https://api.light.inc/v1/general-ledger-summary \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/general-ledger-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.light.inc/v1/general-ledger-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.light.inc/v1/general-ledger-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/general-ledger-summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "records": [
    {
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountCode": 123,
      "accountLabel": "<string>",
      "accountType": "BANK",
      "entities": [
        {
          "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "companyEntityCode": "<string>",
          "companyEntityName": "<string>",
          "localCurrency": "USD",
          "amounts": {
            "openingBalance": {
              "groupAmount": 123,
              "localAmount": 123
            },
            "movement": {
              "groupAmount": 123,
              "localAmount": 123
            },
            "closingBalance": {
              "groupAmount": 123,
              "localAmount": 123
            }
          }
        }
      ],
      "subtotal": {
        "openingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "movement": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "closingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        }
      },
      "elimination": {
        "openingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "movement": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "closingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        }
      },
      "total": {
        "openingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "movement": {
          "groupAmount": 123,
          "localAmount": 123
        },
        "closingBalance": {
          "groupAmount": 123,
          "localAmount": 123
        }
      },
      "groupCurrency": "USD"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Accounting Documents

Attachments

Authorization

Bank Accounts

Card Balance Accounts

Card Customers

Card Transactions

Cards

Companies

Contracts

Credit Notes

Custom Properties

Customer Credits

Customers

Entities

Exchange

Expenses

General Ledger Summary

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

Ledger Transactions

Ledger accounts

Products

Purchase Orders

User Comments

Users

Vendors

Get general ledger summary

Authorizations

Query Parameters

Response