Skip to content
Longport WhaleLongport Whale
Bill Rules

Automatic Marking Rules

Queries Automatic Marking Rules data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_book_bill_rules

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheaderaccounting.bill_ruleRequired

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
idstring

ID. Filters results by ID.

bank_serial_nostring

Online Bank Serial No.. Filters results by Online Bank Serial No..

bank_accountstring

Bank Account of Payer. Filters results by Bank Account of Payer.

bank_user_namestring

Name of Payer. Filters results by Name of Payer.

fund_type_idstring

Fund Type. Filters results by Fund Type.

Values are dynamic. Call GET /v1/datasets/refs/fund_business_type to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

bill_typestring

Fund Flow. Filters results by Fund Flow.

Allowed values:

  • 1 - In
  • 2 - Out

12

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Automatic Marking Rules records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

ID. Returned value: Unique identifier of the current record.

bill_typestring

Fund Flow. Returned value: Fund Flow.

bill_type_valstring

Fund Flow (raw value). Raw value of bill_type. The bill_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

fund_type_idstring

Fund Type. Returned value: Fund Type.

fund_type_id_valstring

Fund Type (raw value). Raw value of fund_type_id. The fund_type_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bank_serial_nostring

Online Bank Serial No.. Returned value: Online Bank Serial No..

bank_accountstring

Bank Account of Counterparty. Returned value: Bank Account of Counterparty.

bank_user_namestring

Name of Counterparty. Returned value: Name of Counterparty.

bank_busi_typestring

Business Type. Returned value: Business Type.

bank_remarkstring

Bank Remark. Returned value: Bank Remark.

company_bank_accountstring

Bank Account No.. Returned value: Bank Account No..

currencystring

Currency. Returned value: Currency.

submit_namestring

Submit Name. Returned value: Submit Name.

deleted_namestring

Deleted Name. Returned value: Deleted Name.

updated_atstring

Updated Time. Returned value: Updated Time. The date or time format follows the value returned by the API.

totalintegerrequired

Total. 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