Chart of Accounts

Query the chart-of-accounts (account item) configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains accounting subjects — counter, subject attribute, subject level, subject code, external subject code, subject name and balance side; the master data for accounting entries.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_book.book_items_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Child attributes

out_subject_codestring

Filters results by External subject code.

subject_codestring

Filters results by Subject code.

idstring

Filters results by G/L account ID.

featurestring

Values come from the pg_book_account_features dynamic enumeration and are not fixed.; queryable via GET /v1/datasets/refs/book_account_features

levelstring

Filters results by Account level. Values come from a backend data dictionary.

Values

1: Level 1
2: Level 2
3: Level 3

full_namestring

Filters results by Account name.

directstring

Filters results by Balance side. Values come from a backend data dictionary.

Values

1: Debit
2: Credit

pageinteger

page_sizeinteger

Responses

HTTP 200On success, returns paginated Chart of Accounts records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

Accounting account ID. Returned value: Accounting account record ID.

account_channelstring

Account channel. Returned value: Account channel the account belongs to.

featurestring

Account attribute. Returned value: Account attribute (display value; the raw code is in the matching _val field).

feature_valstring

Raw value behind field feature: feature returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

levelstring

Account level. Returned value: Account level (display value; the raw code is in the matching _val field).

level_valstring

Raw value behind field level: level returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

subject_codestring

Account code. Returned value: Account code.

out_subject_codestring

External account code. Returned value: External account code.

full_namestring

Account name. Returned value: Account name.

directstring

Balance side. Returned value: Balance side (display value; the raw code is in the matching _val field); values match the filters.direct request parameter.

direct_valstring

Raw value behind field direct: direct returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

updated_atstring

Updated at. Returned value: Unix timestamp in seconds, returned as a string.

totalintegerrequired

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "1000000001",
        "account_channel": "longport_test",
        "feature": "string",
        "feature_val": "1",
        "level": "1",
        "level_val": "1",
        "subject_code": "1",
        "out_subject_code": "1",
        "full_name": "张三",
        "direct": "1",
        "direct_val": "1",
        "updated_at": "1789713827"
      }
    ],
    "total": 1
  }
}

Export

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

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

lb_hk_book.book_items_query

Export options Export records Download result