Skip to content
Longport WhaleLongport Whale
Statement Query

Get Statement Send Progress

Get the progress of the current statement-sending task.

Request parameters

  • This endpoint takes no required parameters.

Returns

On success returns the progress information of the statement-sending task. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/statement/get_statement_send_progress

Authorization

AuthorizationstringheaderRequired

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

Permission

b2b_statement.list

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

Responses

HTTP 200The request was processed successfully. The business result is in data.
Standard response envelopecodemessagedata
dataobjectdata structure
progressarray<object>

Statement sending progress list.

Child attributes
dtstring

Statement date: YYYYMMDD for a single day or YYYYMMDD-YYYYMMDD for a range.

statement_typeinteger

Statement type: 0 daily, 1 monthly, 2 ad hoc.

send_statusinteger

Sending status code (integer).

totalstring

Total number to send (string).

sent_countstring

Number sent (string).

progressstring

Progress text in sent/total format.

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