Upsert Clearing Ready Setting

Create or update a pre-clearing readiness check-item setting. Whether an existing record is matched by task_code determines create versus update.

Request parameters

Required: task_code (task code), task_name (task name)
See each field's definition for its format, value range, default behavior, and business meaning.

Business notes

task_code is the business-unique identifier of the check item. When editing an existing record, reuse the target record's task_code; it must not be changed. process_mode controls how the item is handled after a failure, and is_enable controls whether it is enabled. audit_frontend_resource is caller-provided audit context.

Risk warning

This operation changes the check items of the pre-clearing readiness flow and may affect end-of-day clearing execution and interception. Confirm the target record and parameters before calling.

Result

On success the check-item setting is created or updated; see the 200 response definition for the returned content.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_step_edit

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

Request body application/json

task_codestringrequired

The corresponding field is read-only on the edit form. Its submitted value comes from task_code_val on the selected record, not from user input.

task_namestringrequired

On submission, takes the task_code field value (display name) of the current row record, matching the content of the read-only form input.

process_modestring

Processing mode to apply when a pre-clearing check fails.

Allowed values: 0 Tip Only, 1 Ticket Process, 2 Forced Calibration

Values

0: Tip Only
1: Ticket Process
2: Forced Calibration

is_enableboolean

A switch component; before submission it is converted to a boolean via values.is_enable === true || values.is_enable === 'true'.

audit_frontend_resourceobject

A non-business field used only to display the before/after state in the audit log; the front end builds it as {...currentItem, after_enable, before_enable }, containing the two booleans before_enable/after_enable for the enabled state before and after the change.

Responses

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