LIlight
v1 - Ledger Transactions

List ledger transaction lines

Returns a paginated list of ledger transaction lines

get/v1/ledger-transaction-lines

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

sortstring

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.

Example:amount:desc,createdAt:asc
filterstring

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, taxReportingDate, taxTagLabel, transactionCurrency, transactionId, transactionSequenceId.

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

Example:state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
limitinteger

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

offsetinteger

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

cursorstring

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.

includeCustomPropertiesboolean
includeMaxLineAmountboolean

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

default response

maxTransactionAmountinteger nullable

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

hasMoreboolean

Boolean flag indicating if there are more records available

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

nextCursorstring nullable

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

prevCursorstring nullable

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

Example response

{
  "records": [
    {
      "amounts": {
        "transactionCurrency": "USD",
        "localCurrency": "USD",
        "groupCurrency": "USD"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.