Skip to content
Day-End Tasks

Start Auto Clearing

Trigger one-click full end-of-day clearing for the current ledger date, running all clearing steps of the specified workflow in order.

Request parameters

  • Required: busin_no (workflow number), steps (list of steps to run)
  • Optional: audit_frontend_resource (audit context)
  • See each field's description for format, value range, and business meaning.

Business notes

This endpoint chains the entire market-wide end-of-day settlement; use with caution.

Risk warning

This operation affects market-wide end-of-day settlement or the settlement cutoff time and carries very high risk. Verify the ledger date, market scope, and action type, and ensure proper authorization before calling.

Result

On success, the operation completes; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/clearing/auto_clearing

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_exec

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

Request body application/json

busin_nointegerrequired

ID of the business flow currently selected.

stepsarray<string>required

All clearing steps pending execution under the current process; each item contains step_id (number), ledger_date (string, the accounting date), method (string, the clearing method name), and params (string, a JSON-serialized string of that step's parameters, typically supplementing the original parameters with step_id and ledger_date).

audit_frontend_resourceobject

Audit-trail field, not a business parameter, containing $behavior (operation description), $action (fixed to add), busin_no, and ledger_date.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

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