Skip to content
Longport Whale
Entry Rules

Rules Export

Export the Rules list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/booking_account_entries/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of booking_account_entries.yaml (the query capability).

Child attributes
filters.idstring

Entry Rule ID

filters.source_idstring

Entry Data Source. Values are dynamically queried from pg_book_account_entries_source (not fixed); fetch them live via GET /v1/datasets/refs/book_entry_data_source.

filters.payment_account_type_idstring

Payment Account Type. Values are dynamically queried from pg_book_account_type (not fixed); fetch them live via GET /v1/datasets/refs/book_account_type.

filters.payment_booking_type_idstring

Payment business type. Values are dynamically queried from pg_book_types (not fixed); fetch them live via GET /v1/datasets/refs/book_business_type.

filters.payee_account_type_idstring

Collecting Account Type. Values are dynamically queried from pg_book_account_type (not fixed); fetch them live via GET /v1/datasets/refs/book_account_type.

filters.payee_booking_type_idstring

Payee business type. Values are dynamically queried from pg_book_types (not fixed); fetch them live via GET /v1/datasets/refs/book_business_type.

filters.name_typesstring

Entry Summary

filters.currencystring

Currency. Values are dynamically queried from global_currency_filter_by_account_channel (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies_by_channel.

filters.items_debit_querystring

Items Debit Query. Values are dynamically queried from book_account_entries_items_debit (not fixed); fetch them live via GET /v1/datasets/refs/book_entry_debit_items.

filters.items_credit_querystring

Items Credit Query. Values are dynamically queried from book_account_entries_items_credit (not fixed); fetch them live via GET /v1/datasets/refs/book_entry_credit_items.

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.
Standard response envelopecodemessagedata
dataobjectdata structure
urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Whale Docs