Account Details · Whale Docs

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

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.

objectstring

Filters results by Currency.

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

out_subject_codestring

Filters results by External Account Code.

subject_codestring

Filters results by Account Code (Level 3).

subject_namestring

Filters results by Account Name.

account_detail_idstring

Filters results by Accounting Entry ID.

tx_nostring

Filters results by Source Document No..

ledger_dateobject

Filters results by Transaction date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

account_dtobjectrequired

Filters results by Accounting Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

namestring

Filters results by Entry Summary.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Account Details 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.

subject_namestring

Returned value: Account Name (Level 3).

out_subject_codestring

Returned value: External Account Code.

subject_codestring

Returned value: Account Code (Level 3).

ledger_datestring

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

account_dtstring

Returned value: Accounting Date.

tx_nostring

Returned value: Source Document No..

namestring

Returned value: Entry Summary.

account_detail_idstring

Returned value: Accounting Entry ID.

objectstring

Returned value: Currency.

directstring

Returned value: Balance Side.

direct_valstring

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

debit_amountstring

Returned value: Debit Amount.

credit_amountstring

Returned value: Credit Amount.

created_atstring

Returned value: Created 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_changes_cash' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "string",
        "source_id": "string",
        "source_id_val": "string",
        "subject_name": "string",
        "out_subject_code": "string",
        "subject_code": "string",
        "ledger_date": "string",
        "account_dt": "string",
        "tx_no": "string",
        "name": "string",
        "account_detail_id": "string",
        "object": "string",
        "direct": "string",
        "direct_val": "string",
        "debit_amount": "string",
        "credit_amount": "string",
        "created_at": "string"
      }
    ],
    "total": 0
  }
}

Export

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

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

Export options Export records Download result