--- title: "List ledger accounts" method: GET path: "/v1/ledger-accounts" tags: ["v1 - Ledger accounts"] --- # List ledger accounts `GET /v1/ledger-accounts` ## Request - Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from) - URL: `https://light.inc/v1/ledger-accounts` - Auth: one of: - API key in header `Authorization` - HTTP bearer Returns a paginated list of ledger accounts ## Query parameters - `sort` string: Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `code`, `label`, `context`, `type`, `category`, `status`, `createdAt`, `updatedAt`. - `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: `id`, `companyEntityId`, `code`, `sourceType`, `status`, `type`, `category`, `createdAt`, `updatedAt`. - `limit` integer - `offset` integer - `cursor` string - `ledgerFeature` 'ALL' | 'CARD_TRANSACTIONS' | 'INVOICE_PAYABLES' | 'INVOICE_RECEIVABLES' | 'JOURNAL_ENTRIES' | 'PURCHASE_ORDERS' | 'REIMBURSEMENTS': ⚠️ This enum is not exhaustive; new values may be added in the future. - `includeCustomProperties` boolean ## Response `default` default response - ExternalPaginatedResponseV1ModelExternalLedgerAccountV1Model - `records` ExternalLedgerAccountV1Model[]: List of records for the current page - `id` string, uuid - `companyId` string, uuid - `bankAccountId` string, uuid, nullable - `cardAccountId` string, uuid, nullable - `cashAndEquivalentsAccountId` string, uuid, nullable - `code` integer - `label` string - `type` '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': ⚠️ This enum is not exhaustive; new values may be added in the future. - `status` 'ACTIVE' | 'DISABLED_EXTERNALLY' | 'DISABLED': ⚠️ This enum is not exhaustive; new values may be added in the future. - `context` string, nullable - `revaluateFxBalance` boolean - `companyEntities` ExternalCompanyEntityV1Model[] - `id` string, uuid - `companyId` string, uuid - `code` string - `parentCompanyEntityId` string, uuid - `localCurrency` string - `displayName` string - `vatNumber` string - `name` string - `address` Address - `country` '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': ⚠️ This enum is not exhaustive; new values may be added in the future. - `city` string - `state` string - `zipcode` string - `street` string - `street2` string - `status` 'ACTIVE' | 'HIDDEN' | 'INACTIVE': ⚠️ This enum is not exhaustive; new values may be added in the future. - `seedInvoiceNumber` integer: This field is used to offset the invoice number sequence for this company entity. The first invoice issued for this company entity will have the number seedInvoiceNumber. This field is optional (default is 1) and can be used to set a custom starting point for invoice numbering or to synchronize with an existing invoicing system. After the first invoice is issued, the sequence will continue without gaps and the seedInvoiceNumber will be ignored. - `createdAt` string, date-time - `updatedAt` string, date-time - `customProperties` ExternalCustomPropertyV1Model[], nullable - `groupId` string, uuid: ID of the custom property group - `groupInternalName` string: Internal name of the custom property group - `values` ExternalCustomPropertyValueV1Model[]: List of values. Note that this will be a single value unless the group input type supports multiple values - `id` string, uuid: Unique identifier for the object - `groupId` string, uuid: ID of the custom property group - `groupInternalName` string: Internal name of the custom property group - `companyId` string, uuid: ID of the company - `internalName` string: Internal name of the custom property value - `label` string: Label of the custom property value - `context` string, nullable: Context/description of the custom property value - `createdAt` string, date-time: Timestamp when the custom property value was created - `updatedAt` string, date-time: Timestamp when the custom property value was last updated - `createdAt` string, date-time - `updatedAt` string, date-time - `hasMore` boolean: Boolean flag indicating if there are more records available - `total` integer, nullable: Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination. - `nextCursor` string, nullable: Cursor for fetching the next page (only for cursor pagination) - `prevCursor` string, nullable: Cursor for fetching the previous page (only for cursor pagination) --- [API](https://skmtc.dev/light/apis/light-api.md) - [All operations](https://skmtc.dev/light/apis/light-api/llms.txt) - [OpenAPI document](https://skmtc.dev/light/apis/light-api/revisions/84f51306f648?raw)