New Light partners with Greenstep to bring agentic finance to the NordicsLight partners with Greenstep Read the announcement

API/Reference/Ledger reports

Generate a ledger report

GET 
https://api.light.inc/v1/ledger-reports/{reportDefinitionId}

Runs a table report definition, such as the balance sheet, the income statement, the trial balance or a VAT return, and returns the same figures the report shows in Light. Find the report definition with listReportDefinitions. A SINGLE report covers exactly one company entity. A CONSOLIDATED report carries one result per company entity in scope, their subtotal, the intercompany eliminations and the total. 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.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

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

  • Bearer token

Path parameters

  • reportDefinitionId string · uuidrequired

Query parameters

  • companyEntityIds array

    Company entities the report covers. A SINGLE report needs exactly one. Without it a CONSOLIDATED report covers every company entity the caller can reach, including inactive ones

  • from string · date

    First day of the report, inclusive. Required when the report definition's period is RANGE; leave it out for a balance as of to. A UTC calendar date in YYYY-MM-DD format.

  • to string · daterequired

    Last day of the report, inclusive. A UTC calendar date in YYYY-MM-DD format.

  • customPropertyValueIds array

    Only include postings tagged with these custom property values

  • currencyType stringrequired

    • LOCAL - The local currency of the company entities, which must all share one
    • GROUP - The group currency of the company

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of LOCAL GROUP

  • reportType stringrequired

    • SINGLE - One company entity's own books, without eliminations. companyEntityIds must hold exactly one company entity
    • CONSOLIDATED - Several company entities added together, with the intercompany eliminations the selection is entitled to

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of SINGLE CONSOLIDATED

Response

  • label string

    Display name of the report

  • country string

    Country of the report definition

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

  • reportDefinitionId string · uuid

  • from string · date

    First day of the report, inclusive. Null when the request gave no from

  • to string · date

    Last day of the report, inclusive

  • currency string

    Currency of the report's amounts

  • companyEntityIds array of string · uuid

    Company entities the report covers

  • columnLabels object

    Heading of each column

  • lines array of object

    • label string

    • rowNumber integer · int32

      Row of the report definition. Null on a ledger account's line

    • parentRowNumber integer · int32

      Row this line is nested under

    • type string

      • TEMPLATE - A row of the report definition
      • DYNAMIC - A ledger account listed under the row it contributes to

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of TEMPLATE DYNAMIC

    • accountCategory string

      Category of the ledger account, on a ledger account's line

      • STANDARD_ACCOUNT - An account that holds postings
      • HEADER_ACCOUNT - An account that only groups other accounts
      • SUM_ACCOUNT - An account that totals other accounts

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of STANDARD_ACCOUNT HEADER_ACCOUNT SUM_ACCOUNT

    • resultsByCompanyEntityId object

    • subtotalResult object

      The value of each column that has one, keyed by column

      • columnBoxes object

    • eliminationResult object

      The value of each column that has one, keyed by column

      • columnBoxes object

    • totalResult object

      The value of each column that has one, keyed by column

      • columnBoxes object