Skip to content
Longport WhaleLongport Whale
Financing Interest Statement

Financing Interest

Query financing-interest accrual and freeze records, aggregating each client's financing interest and settlement status by billing month for the billing and clearing teams to reconcile.

Request parameters

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

Business notes

  • Records are organized by client and billing month, capturing the accrual, deduction, and freeze details of financing interest.
  • Each record carries the contract number, client ID, securities account, client name, currency, business type, start/end ledger dates, amount, and settlement status.
  • Can be filtered by business type (such as interest payable) and status (settled / unsettled).
  • Typically used to reconcile a client's financing interest for a given month and its settlement progress.

Returns

On success, returns the matching records and pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.billing_financing_interest_frozen

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
aaidstring

Filters results by Client.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

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.

year_monthstring

Filters results by Month.

biz_typestring

Filters results by Biz type.

Allowed values: 2 Interest Payable, 3 Interest Receive

Values
2
Interest Payable
3
Interest Receive
statusstring

Filters results by Status.

Allowed values: 1 Settled failed, 2 Unsettled, 3 Settled

Values
1
Settled failed
2
Unsettled
3
Settled
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Financing Interest 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
biz_typestring

Returned value: Biz Type.

biz_type_valstring

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

idstring

Returned value: Unique identifier of the current record.

member_idstring

Returned value: Member Id.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Client Name.

year_monthstring

Returned value: Month.

currencystring

Returned value: Currency.

nostring

Returned value: No.

charge_amountstring

Returned value: Interest After Discount.

delta_amountstring

Returned value: Total Adjustments.

amountstring

Returned value: Current Interest Amt.

begin_biz_datestring

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

last_biz_datestring

Returned value: Expected Posting Day (Reset Date). The date or time format follows the value returned by the API.

statusstring

Returned value: State.

status_valstring

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

calculate_out_amountstring

Returned value: Interest Before Discount.

deduction_amountstring

Returned value: Fee Discount.

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