Light APIv1.0.0

API / Reference / Bank Accounts

List bank transactions

GET https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions

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

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

Path parameters

  • bankAccountId string · uuidrequired

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

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

  • 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

  • total integer · int64

  • records array of object

    • id string · uuid

      Unique identifier for the bank transaction

    • bankAccountId string · uuid

      ID of the bank account this transaction belongs to

    • date string · date

      Transaction date

    • amount integer · int64

      Transaction amount in minor units (e.g. cents)

    • dcSign string

      Debit/credit sign

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

      One of D C

    • reconciliationStatus string

      Reconciliation status

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

      One of EXCLUDED MATCHED UNMATCHED

    • name string

      Transaction name / payee

    • memo string

      Transaction memo / description

    • reference string

      Transaction reference

    • transactionId string

      External transaction identifier for idempotency

    • createdAt string · date-time

      Timestamp when the transaction was created

  • balance integer · int64