--- title: "List journal entries" method: GET path: "/v1/journal-entries" tags: ["v1 - Journal Entries"] --- # List journal entries `GET /v1/journal-entries` ## Request - Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from) - URL: `https://light.inc/v1/journal-entries` - Auth: one of: - API key in header `Authorization` - HTTP bearer Returns a paginated list of journal entries, each with its lines and custom properties ## 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: `documentSequenceId`, `postingDate`, `valuationDate`, `documentDate`, `businessPartnerName`, `status`, `createdBy`, `createdAt`. - `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`, `accountLabel`, `id`, `documentSequenceId`, `documentNumber`, `companyEntityId`, `ledgerName`, `businessPartnerName`, `status`, `currency`, `postingDate`, `documentDate`, `valuationDate`, `intercompanyJournalEntryId`, `intercompanyDocumentId`, `taxCode`, `createdAt`, `createdBy`. - `limit` integer - `offset` integer - `cursor` string ## Response `default` default response - ExternalPaginatedResponseV1ModelExternalJournalEntryV1Model - `records` ExternalJournalEntryV1Model[]: List of records for the current page - `id` string, uuid - `companyId` string, uuid - `documentNumber` string - `companyEntityId` string, uuid - `ledgerName` 'PRIMARY' | 'ELIMINATION': ⚠️ This enum is not exhaustive; new values may be added in the future. - `createdBy` string, uuid - `updatedBy` string, uuid - `documentSequenceId` string - `status` 'DRAFT' | 'APPROVAL_PENDING' | 'APPROVED' | 'POSTED' | 'PARTIALLY_CLEARED' | 'CLEARED' | 'ARCHIVED': ⚠️ This enum is not exhaustive; new values may be added in the future. - `description` string - `currency` string - `postingDate` string, date - `documentDate` string, date - `valuationDate` string, date - `localCurrencyFxRate` number, nullable: Custom foreign exchange rate for the ledger's local currency. If not provided, Light uses official ECB rates - `groupCurrencyFxRate` number, nullable: Custom foreign exchange rate for the ledger's group currency. If not provided, Light uses official ECB rates - `areLinesWithTax` boolean - `failureContext` ExternalUiClientExceptionV1Model, nullable: Failure context when vendor onboarding fails. - `name` string: The error name - `type` 'BAD_REQUEST' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'NOT_FOUND' | 'CONFLICT' | 'UNPROCESSABLE_CONTENT': The error type ⚠️ This enum is not exhaustive; new values may be added in the future. - `errors` ExternalUiClientExceptionErrorV1Model[]: List of errors providing details about what went wrong - `type` string: A string code identifying the error type - `message` string: A human-readable message providing more details about the error - `path` string[], nullable: Optional path of the error when the error is for a specific field. Used mostly on BAD_REQUEST errors, that path will match the field name on the request object - `context` object, nullable: Optional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error - `lines` ExternalJournalEntryLineV1Model[] - `id` string, uuid - `journalEntryId` string, uuid - `netTransactionAmount` DirectedAmount - `amount` integer - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future. - `grossTransactionAmount` DirectedAmount - `amount` integer - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future. - `taxTransactionAmount` DirectedAmount - `amount` integer - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future. - `description` string - `targetCompanyEntityId` string, uuid - `ledgerTaxId` string, uuid - `ledgerAccountId` string, uuid - `costCenterId` string, uuid - `customProperties` ExternalCustomPropertyV1Model[] - `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 - `amortizationTemplateId` string, uuid - `amortizationStartDate` string, date - `amortizationEndDate` string, date - `customProperties` ExternalCustomPropertyV1Model[] - `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 - `businessPartnerName` string - `businessPartnerId` string, uuid - `createdAt` string, date-time - `updatedAt` string, date-time - `totalNetTransactionAmount` DirectedAmount - `amount` integer - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future. - `totalTaxTransactionAmount` DirectedAmount - `amount` integer - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future. - `totalGrossTransactionAmount` DirectedAmount - `amount` integer - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future. - `multiJournalEntryId` string, uuid - `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)