Skip to content
Longport WhaleLongport Whale
Rate Setups Email

Billing Emails

Query billing-configuration change notification emails, used during day-end OB billing to review and send clients notifications of their billing configuration changes.

Request parameters

  • Combine business filters through filters (see the filter field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Each record is a billing-config change notice for one client account on a given message date, carrying the securities account number, client account subtype, client name, language, and flags for changes to the charging scenario, global customer group, common customer group, and client billing, along with the config update time, mail send time, and current state.

  • ledger_date filters by message date, Aaid filters by client, and state filters by state (multi-select, comma-separated).

Use it to confirm what billing-config changes a client had and the send/processing status of the notification email.

Returns

On success, returns the matching record list with pagination. See the response schema for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/booking_mails

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
ledger_dateobject

Filters results by Message Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

Aaidstring

Filters results by Client.

statestring

Filters results by State.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 0 Pending Send, 1 Sent Successfully, 2 Send Failed, 3 Sending

Values
0
Pending Send
1
Sent Successfully
2
Send Failed
3
Sending
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Billing Email records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

ledger_datestring

Returned value: Message Date. The date or time format follows the value returned by the API.

origin_idstring

Returned value: A/C No..

client_detail_typestring

Returned value: Client Detail Type.

real_namestring

Returned value: Client Name.

langstring

Returned value: Language.

lang_valstring

Raw value of lang. The lang field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

billing_item_modifystring

Returned value: Fee Logic Update.

billing_item_modify_valstring

Raw value of billing_item_modify. The billing_item_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

dft_package_modifystring

Returned value: Global Client Group Update.

dft_package_modify_valstring

Raw value of dft_package_modify. The dft_package_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

common_package_modifystring

Returned value: General Client Group Update.

common_package_modify_valstring

Raw value of common_package_modify. The common_package_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

personal_package_modifystring

Returned value: Client charge Configure Update.

personal_package_modify_valstring

Raw value of personal_package_modify. The personal_package_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

config_updated_atstring

Returned value: Configuration Update Time. The date or time format follows the value returned by the API.

mail_send_atstring

Returned value: Email Send Time. The date or time format follows the value returned by the API.

statestring

Returned value: State.

state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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