Skip to content
Merge

Accounting Entries - Summary

Queries merged accounting entries from the accounting hub, letting finance staff review posted debit/credit entries and their original and converted amounts by 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

  • Data comes from accounting entries generated by the accounting hub, returned in descending accounting-date order, with the debit and credit sides under one voucher aggregated into a single entry.
  • Each record carries the voucher number, account (subject) code and name, external subject code, original-currency debit/credit amounts, converted debit/credit amounts, exchange rate, currency, and the entry maker.
  • Typically used for entry review, general-ledger reconciliation, and finance closing.

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_account_details_merged

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
voucherstring

Filters results by Document No.

original_currencystring

Filters results by Currency.

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

out_subject_codestring

Filters results by External Account Code.

account_atobject

Filters results by Accounting Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Accounting Entries - Summary 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.

account_atstring

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

voucherstring

Returned value: Document No.

makerstring

Returned value: Maker.

maker_valstring

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

subject_codestring

Returned value: Account Code (Level 3).

subject_namestring

Returned value: Account Name (Level 3).

out_subject_codestring

Returned value: External Account Code.

namestring

Returned value: Entry Summary.

original_currencystring

Returned value: Currency.

convert_currencystring

Returned value: Local currency.

ratestring

Returned value: Exchange Rate.

original_debit_amountstring

Returned value: Original currency debit amount.

original_credit_amountstring

Returned value: Original currency credit amount.

converted_debit_amountstring

Returned value: Debit Amount in Local Currency.

converted_credit_amountstring

Returned value: Credit Amount in Local Currency.

created_atstring

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

broker_codestring

Returned value: AE Code.

business_namestring

Returned value: Consolidated business name.

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