Commission Monthly Report

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_billing_dcp_monthly_reports

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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 below, 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_monthstring

Filters results by Month.

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 Monthly 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_monthstring

Returned value: Month.

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/booking_billing_dcp_monthly_reports' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "biz_month": "202607",
        "broker_code": "DT851987964599174",
        "broker_team_code": "",
        "dcp_name": "北包包",
        "trade_amount": "11236180.00",
        "currency": "HKD",
        "broker_commission_amount": "4210.55",
        "org_commission_amount": "42.57",
        "commission_amount": "4253.12"
      }
    ],
    "total": 0
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_billing_dcp_monthly_reports/download

b2b_billing.dcp_report

Export options Export records Download result