Skip to content
Annual Report

Commission Annual Report

Queries the yearly commission settlement summary of broker (AE) commission-split packages, used for annual reconciliation of brokerage commission sharing.

Request parameters

  • Combine business filters through filters (available fields are described under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data is aggregated by ledger year, broker (AE), AE group, commission-split package, and currency, and can be filtered by ledger year, currency, and broker.

Each record carries the trade amount, total commission, AE commission, company (brokerage) commission, and currency.

It is typically used to reconcile each broker's yearly trading volume and commission split across different commission-split packages.

Returns

On success, returns the matching record list together with pagination information. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

b2b_billing.dcp_report

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
biz_yearstring

Filters results by Year.

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.

broker_codestring

Filters results by AE.

Values are dynamic. Call GET /v1/datasets/refs/broker_accounts_for_select 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 Commission Annual Report 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: Records matching the query conditions.

Child attributes
biz_yearstring

Returned value: Year.

broker_codestring

Returned value: AE.

broker_team_codestring

Returned value: AE Group.

dcp_namestring

Returned value: Package Name.

trade_amountstring

Returned value: Trade Amt.

currencystring

Returned value: Currency.

broker_commission_amountstring

Returned value: AE Commission.

org_commission_amountstring

Returned value: Company Commission.

commission_amountstring

Returned value: Total Commission.

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