List journal entries

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

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 · int32

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

• offset integer · int64deprecated

  Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

• 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

• records array of object

  List of records for the current page

  • id string · uuid

    Note

    The journal entry id, also its accounting document id.

  • companyId string · uuid

    Note

    Your company id.

  • documentNumber string

    Note

    Your own free-text reference for the entry. Not the number Light assigns; that is documentSequenceId.

  • companyEntityId string · uuid

    Note

    The entity whose books the entry posts to.

  • ledgerName string

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

    One of PRIMARY ELIMINATION

  • createdBy string · uuid

    Note

    The principal that created the entry: a user or an API key.

  • updatedBy string · uuid

    Note

    The principal that last changed it.

  • documentSequenceId string

    Note

    null until the entry is posted.

  • status string

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

    One of DRAFT APPROVAL_PENDING APPROVED POSTED PARTIALLY_CLEARED CLEARED ARCHIVED

  • description string

    Note

    The entry's description.

  • currency string

    Note

    The currency of the line amounts.

  • postingDate string · date

    Note

    The ledger date; the accounting period covering it must be open to post.

  • documentDate string · date

    Note

    The date on the underlying document, informational.

  • valuationDate string · date

    Note

    The date whose exchange rate converted the lines to local and group currency; resolved at posting when not set.

  • localCurrencyFxRate number

    Custom foreign exchange rate for the ledger's local currency. If not provided, Light uses official ECB rates

    Note

    Echoes the override you sent; null when Light applied its own rate, not the rate that was applied.

  • groupCurrencyFxRate number

    Custom foreign exchange rate for the ledger's group currency. If not provided, Light uses official ECB rates

    Note

    Echoes the override you sent; null when Light applied its own rate, not the rate that was applied.

  • areLinesWithTax boolean

    Note

    Whether line amounts were entered gross of tax (true) or net (false, the default).

  • failureContext object

    Failure context when vendor onboarding fails.

    Note

    The error of the last failed posting attempt, typically from the approval workflow; cleared on the next successful post. The description about vendor onboarding is a copy-paste from another model.

    • name string

      The error name

    • type string

      The error type

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

      One of BAD_REQUEST UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_CONTENT

    • errors array of object

      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 array of string

        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

        Optional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error

  • lines array of object

    Note

    The lines as entered. The ledger lines Light derived (tax, rounding) are not here; read them from ledger transaction lines.

    • id string · uuid

      Note

      The line id.

    • journalEntryId string · uuid

      Note

      The entry the line belongs to.

    • netTransactionAmount object

      Note

      The line amount excluding tax, unsigned with dcSign, in the entry's currency.

      • amount integer · int64

        Note

        Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

      • dcSign string

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

        One of D C

    • grossTransactionAmount object

      Note

      The line amount including tax.

      • amount integer · int64

        Note

        Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

      • dcSign string

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

        One of D C

    • taxTransactionAmount object

      Note

      The tax portion; null without a tax code.

      • amount integer · int64

        Note

        Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

      • dcSign string

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

        One of D C

    • description string

      Note

      The line description.

    • targetCompanyEntityId string · uuid

      Note

      For an intercompany line, the entity on the other side ("To entity" in the product). null on ordinary lines.

    • ledgerTaxId string · uuid

      Note

      Tax code id. Other documents call the same id taxCodeId.

    • ledgerAccountId string · uuid

      Note

      The ledger account the line posts to.

    • costCenterId string · uuid

      Note

      Cost center on the line; null when none.

    • customProperties array of object

      Note

      Custom property values on the line.

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • values array of object

        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

          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

      Note

      When the line was created.

    • updatedAt string · date-time

      Note

      When it was last changed.

    • amortizationTemplateId string · uuid

      Note

      Release template id when the line is spread over a schedule instead of hitting the account at once; null otherwise.

    • amortizationStartDate string · date

      Note

      First date of that schedule.

    • amortizationEndDate string · date

      Note

      Last date of that schedule.

  • customProperties array of object

    Note

    Custom property values on the entry header.

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      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

        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

    Note

    Optional vendor or customer shown on the entry.

  • businessPartnerId string · uuid

    Note

    Id of that vendor or customer.

  • createdAt string · date-time

    Note

    When the entry was created.

  • updatedAt string · date-time

    Note

    When it was last changed.

  • totalNetTransactionAmount object

    Note

    Sum of the lines' net amounts as one directed figure. Read the magnitude as the entry's size; its dcSign carries no accounting meaning on a balanced entry.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • totalTaxTransactionAmount object

    Note

    Sum of the lines' tax amounts, read like the net total.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • totalGrossTransactionAmount object

    Note

    Sum of the lines' gross amounts, read like the net total.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • multiJournalEntryId string · uuid

    Note

    Set when this entry is one entity's part of a multi-entity journal entry made in the product; entries sharing the id were entered together. null for entries created through the API.

• hasMore boolean

  Boolean flag indicating if there are more records available

• total integer · int64deprecated

  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

  Cursor for fetching the next page (only for cursor pagination)

• prevCursor string

  Cursor for fetching the previous page (only for cursor pagination)