LIlight
v1 - Bank Accounts

List bank transactions

Returns a paginated list of bank transactions for the specified bank account, including the balance

get/v1/bank-accounts/{bankAccountId}/bank-transactions

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

Path parameters

bankAccountIdstring uuid required

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: reconciliationStatus, dcSign, date, amount, name, memo.

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: reconciliationStatus, dcSign, date.

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.

Response

default response

totalinteger
balanceinteger

Changes

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