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

API/Reference/Report definitions

Get a table report definition

GET 
https://api.light.inc/v1/report-definitions/table/{reportDefinitionId}

Returns the rows of a table report definition, the country it applies to and whether it covers a date range or a balance as of a date.

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

Response

  • id string · uuid

    Unique identifier for the report definition

  • companyId string · uuid

    ID of the company. Null for a report definition provided by Light

  • country string

    Country the report applies to. A report with a country can only be generated for company entities in that country

    ⚠️ 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

  • label string

    Display name of the report

  • columnLabels object

    Heading of each column

  • lines array of object

    • rowNumber integer · int32

      Position of the row in the report, unique within the report definition

    • label string

    • parentRowNumber integer · int32

      Row this row is nested under

  • period string

    • RANGE - The report covers a date range, so from is required when generating it
    • SNAPSHOT - The report is a balance as of to

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

    One of RANGE SNAPSHOT

  • ignoreYearClosingEntries boolean

    Whether year-closing entries are left out of the figures

  • owner string

    • USER - Created by the company
    • SYSTEM - Provided by Light and read-only

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

    One of USER SYSTEM

  • systemName string

    Which standard report this is. Null for a report the company created

    • BALANCE_SHEET - Balance sheet
    • CASH_FLOW_STATEMENT - Cash flow statement
    • GENERAL_LEDGER - General ledger
    • INCOME_STATEMENT - Income statement (profit and loss)
    • TRIAL_BALANCE - Trial balance
    • VAT_DK - Danish VAT return
    • VAT_UK - UK VAT return
    • VAT_SE - Swedish VAT return

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

    One of BALANCE_SHEET CASH_FLOW_STATEMENT GENERAL_LEDGER INCOME_STATEMENT TRIAL_BALANCE VAT_DK VAT_UK VAT_SE

  • createdAt string · date-time

  • updatedAt string · date-time