Corporate GST Fee

Query the Goods and Services Tax (GST) fee configuration for corporate actions; it is the portion of the global fee configuration whose fee type is GST.

Request parameters

This dataset provides no business filter fields; pass an empty object for filters. You can still use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from the corporate-action fee configuration records whose fee type is GST, used to configure the GST rules applied to corporate-action fees.

A record carries parameters such as the tax rate, rounding method, and whether it is enabled.

It is used when maintaining the GST calculation basis for corporate actions.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_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.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Corporate GST Fee 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

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

ref_valuestring

Returned value: Rate.

fraction_typestring

Returned value: Rounding Method.

fraction_type_valstring

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

enablestring

Returned value: Enable.

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.lbkrs.com/v1/datasets/corp_action_gst_fee' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "ref_value": "125630.50",
        "fraction_type": "1",
        "fraction_type_val": "1",
        "enable": "1"
      }
    ],
    "total": 1
  }
}

Export

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

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_gst_fee/download

lb_hk_corporate.corporate_query

Export options Export records Download result