Exceptions · Whale Docs

GEThttps://b-api.longbridge.xyz/v1/datasets/booking_account_exceptions

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

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

Child attributes

source_idstring

Filters results by Entry Data Source.

Values are dynamic. Call GET /v1/datasets/refs/book_source to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

tx_nostring

Filters results by Source Document No..

statestring

Filters results by State.

Allowed values:

1 - Unprocessed
2 - Processed

1 · Unprocessed2 · Processed

account_atobject

Filters results by Accounting Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

object_codestring

Filters results by Currency.

Values are dynamic. Call GET /v1/datasets/refs/tenant_currencies_by_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

amountobject

Filters results by Amount Range.

Child attributes

gtenumber

Inclusive lower bound of the filter range.

ltenumber

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Exceptions 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

Returned value: Unique identifier of the current record.

source_idstring

Returned value: Entry Data Source.

source_id_valstring

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

account_atstring

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

tx_nostring

Returned value: Source Document No..

ref_nostring

Returned value: Business Transaction Number.

biz_codestring

Returned value: Business Type.

biz_code_valstring

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

object_codestring

Returned value: Currency.

amountstring

Returned value: Amount.

reasonstring

Returned value: Reason for Entry Not Generated.

reason_valstring

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

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.

updated_atstring

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

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/booking_account_exceptions' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "185938716",
        "source_id": "Bank Statement",
        "source_id_val": "2",
        "account_at": "1782921600",
        "tx_no": "682391",
        "ref_no": "",
        "biz_code": "用户加款",
        "biz_code_val": "用户加款",
        "object_code": "USD",
        "amount": "1,000",
        "reason": "Match Zero Rule",
        "reason_val": "MatchZeroRule",
        "state": "Unprocessed",
        "state_val": "1",
        "updated_at": "1782978890"
      }
    ],
    "total": 0
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

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

Export options Export records Download result