Skip to content
Longport WhaleLongport Whale
Day-End Tasks

Get Business Steps

Get the list of end-of-day clearing workflow steps for a given ledger date.

Request parameters

  • Required: ledger_date (ledger date), format YYYYMMDD.

Returns

On success, returns the clearing workflow step list. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/clearing/get_busin_steps

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_stepsus_clearing.clearing_busin_steps

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

Parameters

ledger_datestringRequired

Trade Ledger Date

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>
Child attributes
flow_namestring

Flow name

busin_nointeger

Busin no

stepsarray<object>

End-of-day clearing steps of this flow

Child attributes
step_idstring

Step id

busin_nointeger

Flow number the step belongs to

step_nointeger

Step no

methodstring

Backend method name of the step

method_namestring

Step name

statusinteger

Status

remarkstring

Remark

paramsstring

Step execution parameters (JSON string); may be an empty string

urlstring

API path that executes the step

start_timestring

Start time

end_timestring

End time

prev_method_namesstring

Prev method names

suggestionstring

Suggestion

readyobject

Pre-clearing readiness check information

Child attributes
method_namestring

Name of the readiness stage

statusinteger

Status

end_timestring

End time

suggestionstring

Hint or suggestion for the readiness stage

itemsarray<object>
Child attributes
item_codestring

Check item code

item_namestring

Check item name

statusinteger

Status

descriptionstring

Description

suggestionstring

Suggestion

item_idstring

Check item record ID

ticket_idstring

Associated ticket ID; 0 when there is none

auto_clearingobject

One-click clearing execution status

Child attributes
ledger_dateinteger

Ledger date, formatted YYYYMMDD (integer)

busin_nointeger

Flow number

task_totalinteger

Task total

task_finishedinteger

Task finished

statusinteger

Status

account_channelstring

Account channel

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