List the ledger lines to match bank transactions with
https://api.light.inc/v1/bank-accounts/{bankAccountId}/ledger-transaction-lines
Returns the ledger transaction lines posted to this bank account's ledger account, each with its reconciliationStatus and, once matched, its matchingGroupId. Filter on reconciliationStatus:eq:UNMATCHED for the lines reconcile-transactions accepts. Reversed transactions and their reversals are left out, as on the bank reconciliation page. Sorted by newest posting date first unless sort is given. The dcSign and transactionCurrency filters read amounts.dcSign and amounts.transactionCurrency. Fails with 404 when the bank account doesn't exist or the API key can't access its entity.
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
-
bankAccountIdstring · uuidrequired
Query parameters
-
sortstringSort string in the format
field:direction. To provide multiple sort fields, separate them with commas.Available directions:
asc,desc.Available fields:
postingDate. -
filterstringFilter 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
inandnot_inoperators, provide multiple values separated by the pipe character (|).
Available fields:
dcSign,id,matchingGroupId,postingDate,reconciliationStatus,transactionCurrency. - For
-
limitinteger · int32Maximum number of items to return. Default is 50, maximum is 200.
-
offsetinteger · int64deprecatedNumber of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.
-
cursorstringThe cursor position to start returning results from. To opt-in into cursor-based pagination, provide
0for the initial request. For subsequent requests, usenextCursorandprevCursorfrom the previous response to navigate. Cursor values are opaque and should not be constructed manually.
Response
-
recordsarray of objectList of records for the current page
-
idstring · uuidID of the ledger transaction line; the ID to match with
-
ledgerTransactionIdstring · uuidID of the ledger transaction the line belongs to
-
accountingDocumentIdstring · uuidID of the accounting document that posted the line
-
accountingDocumentNumberstringNumber of the accounting document
-
documentTypestringType of the accounting document
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
APARBPCCCNCTDEFXJEYC -
postingDatestring · datePosting date of the line
-
descriptionstringDescription of the line
-
amountsobject-
dcSignstring⚠️ This enum is not exhaustive; new values may be added in the future.
Note
DorC. Redundant with the sign ofsignedLocalAmount(Dis negative there) and withdebit/credit.One of
DC -
transactionAmountinteger · int64Note
Unsigned magnitude. The direction lives in the sign of
signedTransactionAmount, not here. -
transactionAmountInMajorsnumberNote
transactionAmountas a decimal, unsigned. For display, not arithmetic. -
signedTransactionAmountinteger · int64Note
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-summaryreturns, which are debit-positive — reconciling one against the other means flipping the sign on one side. There is noInMajorscounterpart to this field; the unsigned*InMajorsvalue beside it carries the magnitude only. -
transactionCurrencystringNote
The document's currency.
nullon lines with no transaction amount: rounding, revaluation and translation-adjustment lines. -
localAmountinteger · int64Note
Unsigned magnitude. The direction lives in the sign of
signedLocalAmount, not here. -
localAmountInMajorsnumberNote
localAmountas a decimal, unsigned. -
signedLocalAmountinteger · int64Note
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-summaryreturns, which are debit-positive — reconciling one against the other means flipping the sign on one side. There is noInMajorscounterpart to this field; the unsigned*InMajorsvalue beside it carries the magnitude only. -
localCurrencystringNote
The entity's local currency.
-
groupAmountinteger · int64Note
Unsigned magnitude. The direction lives in the sign of
signedGroupAmount, not here. -
groupAmountInMajorsnumberNote
groupAmountas a decimal, unsigned. -
signedGroupAmountinteger · int64Note
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-summaryreturns, which are debit-positive — reconciling one against the other means flipping the sign on one side. There is noInMajorscounterpart to this field; the unsigned*InMajorsvalue beside it carries the magnitude only. -
groupCurrencystringNote
The company's group currency, the same on every line.
-
debitbooleanNote
trueon a debit line. Redundant withdcSignand with a negativesignedLocalAmount. -
creditbooleanNote
trueon a credit line. Redundant withdcSignand with a positivesignedLocalAmount.
-
-
businessPartnerNamestringName of the vendor or customer of the document
-
reconciliationStatusstringWhether the line is matched with bank transactions, excluded from reconciliation, or neither
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
EXCLUDEDMATCHEDUNMATCHED -
matchingGroupIdstring · uuidID of the matching group the line is in, when it is matched
-
matchedAtstring · date-timeWhen the line was matched
-
-
hasMorebooleanBoolean flag indicating if there are more records available
-
totalinteger · int64deprecatedTotal 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.
-
nextCursorstringCursor for fetching the next page (only for cursor pagination)
-
prevCursorstringCursor for fetching the previous page (only for cursor pagination)