Light APIv1.0.0

API / Reference / Ledger Transactions

List ledger transaction lines

GET https://api.light.inc/v1/ledger-transaction-lines

Returns a paginated list of ledger transaction lines

Signed amounts on these lines are credit-positive — the opposite polarity to the balances GET /v1/general-ledger-summary returns. debit, credit and dcSign are declared on the amounts model but are not returned, so the sign of signedLocalAmount is the direction.

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: accountingDocumentNumber, transactionSequenceId, documentSequenceId, documentType, accountCode, accountLabel, postingDate, accountType, taxTagLabel, 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, accountId, accountType, accDocId, businessPartnerId, businessPartnerName, companyEntityCode, companyEntityId, createdAt, customPropertyValueId, documentSequenceId, documentType, eliminationOffset, groupAmount, groupCurrency, id, ledgerName, lineType, localAmount, localCurrency, postingDate, taxTagLabel, transactionCurrency, transactionId, transactionSequenceId.

    These fields accept only a subset of the operators: customPropertyValueId (eq, in).

  • 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.

  • includeCustomProperties boolean

  • includeMaxLineAmount booleandeprecated

    If true, includes the maximum line amount in the response. This field is deprecated and will be removed, please fetch all lines and compute this locally if needed

Response

  • maxTransactionAmount integer · int64deprecated

    Maximum line amount in transaction currency across all records. This field is deprecated and will be removed, please fetch all lines and compute this locally if needed

  • records array of object

    List of records for the current page

    • id string · uuid

    • ledgerTransactionId string · uuid

    • transactionSequenceId string

    • companyId string · uuid

    • companyEntityId string · uuid

    • companyEntityCode string

    • companyEntityName string

    • ledgerName string

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

      One of PRIMARY ELIMINATION

    • accountId string · uuid

    • accountCode integer · int32

    • accountLabel string

    • accountType string

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

      One of 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

    • accountingDocumentLineId string · uuid

    • documentSequenceId string

    • accountingDocumentId string · uuid

    • accountingDocumentNumber string

    • documentType string

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

      One of AP AR BP CC CN CT DE FX JE YC

    • postingDate string · date

    • valuationDate string · date

    • description string

    • documentDescription string

    • amounts object

      • dcSign string

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

        Declared in the schema but not returned by this endpoint in practice. Take the direction from the sign of signedLocalAmount instead.

        One of D C

      • transactionAmount integer · int64

        Unsigned magnitude. The direction lives in the sign of signedTransactionAmount, not here.

      • transactionAmountInMajors number

      • signedTransactionAmount integer · int64

        Credit-positive: a credit is positive, a debit is negative, in minor units. This is the opposite polarity to the balances GET /v1/general-ledger-summary returns, which are debit-positive — reconciling one against the other means flipping the sign on one side. There is no InMajors counterpart to this field; the unsigned *InMajors value beside it carries the magnitude only.

      • transactionCurrency string

      • localAmount integer · int64

        Unsigned magnitude. The direction lives in the sign of signedLocalAmount, not here.

      • localAmountInMajors number

      • signedLocalAmount integer · int64

        Credit-positive: a credit is positive, a debit is negative, in minor units. This is the opposite polarity to the balances GET /v1/general-ledger-summary returns, which are debit-positive — reconciling one against the other means flipping the sign on one side. There is no InMajors counterpart to this field; the unsigned *InMajors value beside it carries the magnitude only.

      • localCurrency string

      • groupAmount integer · int64

        Unsigned magnitude. The direction lives in the sign of signedGroupAmount, not here.

      • groupAmountInMajors number

      • signedGroupAmount integer · int64

        Credit-positive: a credit is positive, a debit is negative, in minor units. This is the opposite polarity to the balances GET /v1/general-ledger-summary returns, which are debit-positive — reconciling one against the other means flipping the sign on one side. There is no InMajors counterpart to this field; the unsigned *InMajors value beside it carries the magnitude only.

      • groupCurrency string

      • debit boolean

        Declared in the schema but not returned by this endpoint in practice. Take the direction from the sign of signedLocalAmount instead.

      • credit boolean

        Declared in the schema but not returned by this endpoint in practice. Take the direction from the sign of signedLocalAmount instead.

    • taxId string · uuid

    • taxTagLabel string

    • taxCode string

    • businessPartnerName string

    • businessPartnerId string · uuid

    • costCenterId string · uuid

    • accruedLedgerTransactionLineId string · uuid

    • ledgerTransactionType string

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

      One of DEFAULT AMORTIZATION FX CTA BANK_CLEARING

    • isAmortized boolean

    • accountingReleaseStartDate string · date

    • accountingReleaseEndDate string · date

    • createdAt string · date-time

    • createdBy string · uuid

    • customProperties array of object

      • 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

  • 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)