Skip to content
Longport WhaleLongport Whale
File Sending

Get Unsent Downstream Files Count

Query the number of unsent tenant clearing files within a given scope.

Request parameters

  • Required: ledger_date (ledger date), market (market)
  • Optional: file_codes (file type list)
  • See each field description for format, value range, and business meaning.

Business notes

Used as a pre-send preview: counts the clearing files not yet sent, scoped by ledger_date, market, and the optional file_codes.

Result

On success returns the count of pending files; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/ob_file/get_unsent_downstream_files

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_sending_list

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

Request body application/json

ledger_datenumberrequired

This field is required.

marketstringrequired

This field is required.

file_codesarray<string>

Submit File Codes as a JSON array.

Responses

HTTP 200The request was processed successfully. The business result is in data.
Standard response envelopecodemessagedata
dataobjectdata structure
countinteger

Number of unsent clearing files.

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