Skip to content
Summary check

Deposit in transit - Summary check

Queries the in-transit deposit summary reconciliation, letting finance reconcile in-transit deposit balances and discrepancies per company bank account and currency for each accounting date.

Request parameters

  • Combine business filters through filters (see the filter-field notes below for the available fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Each record is aggregated by bank account, currency, and accounting date, carrying opening/closing amounts, deposit amount, received amount, in-transit amount, in-transit discrepancy, in-transit and statement adjustments, reconciliation result (consistent / inconsistent), and remarks.

  • Typically used for finance reconciliation to spot in-transit discrepancies and follow up on adjustments until the result is consistent.

  • The table is large (about 2.38 million rows). Filter by a single ledger date (reconciliation_at with equal gte and lte) plus currency; wider date ranges time out (504/500).

  • Rows include ref_no (formatted dit-{reconciliation_at}-{currency}-{bank_account}-{simple_name}), which can be passed directly to modify_summary_recon_items.

Returns

On success, returns the matched record list with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/booking_deposit_in_transit

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_book.book_detail_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
reconciliation_atobject

Filters results by Accounting Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

currencystring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies_with_all to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

statestring

Filters results by Check the results.

Allowed values: 1 Consistent, 2 Inconsistent

Values
1
Consistent
2
Inconsistent
lb_bank_accounts_idstring

Filters results by Bank Account No..

Values are dynamic. Call GET /v1/datasets/refs/company_bank_account_full_names to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Deposit in transit - Summary check records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

reconciliation_atstring

Returned value: Accounting date. The date or time format follows the value returned by the API.

currencystring

Returned value: Currency.

bank_accountstring

Returned value: Bank Account No..

simple_namestring

Returned value: Company bank abbreviation.

bank_namestring

Returned value: Bank.

begin_amountstring

Returned value: Opening In-transit.

deposit_amountstring

Returned value: Deposit funds.

withdrawal_refund_amountstring

Returned value: Withdrawal refund.

received_amountstring

Returned value: Received by bank- Client funds.

bank_withdrawal_refund_amountstring

Returned value: Bank withdrawal refund.

bank_deposit_refund_amountstring

Returned value: Bank deposit refund.

statement_adjustmentstring

Returned value: Statement Adjustment.

end_amountstring

Returned value: Closing In-transit.

in_transit_adjustmentstring

Returned value: In-Transit Adjustment.

in_transit_amountstring

Returned value: Actual In-transit.

in_transit_discrepanciesstring

Returned value: In-Transit Discrepancies.

statestring

Returned value: Check Results.

state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

Returned value: Update At. The date or time format follows the value returned by the API.

remarksstring

Returned value: Remarks.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs