Search posted transactions
Search and retrieve posted transactions for a property. This endpoint uses POST (instead of GET) to support complex filter criteria in the request body. You can combine multiple filters with AND/OR logic, paginate results, and sort by various fields.
Supported filter fields:
- account_category
- chart_of_account_type
- created_at (alias for transaction_datetime)
- customer_id
- custom_code
- external_relation_id
- external_relation_kind
- folio_id
- id
- internal_code
- origin_id
- parent_id
- routed_from
- source_id
- source_identifier
- source_kind
- transaction_datetime
- trial_balance_id
- service_date
- business_date
Supported sort fields:
- created_at (alias for transaction_datetime)
- id
- internal_code
- source_id
- transaction_datetime
- service_date
- business_date
Required filter constraints: The API has certain constraints for filters so that the system is able to efficiently query the data. Every request must include at least one of the following base filters:
- id with operator equals or in
- source_id together with source_kind
- source_identifier together with source_kind
- external_relation_id together with external_relation_kind
- transaction_datetime
- service_date
- business_date
- trial_balance_id
Additional filter rules:
- Filters cannot be empty.
- source_id requires source_kind to be present in the same request.
- source_identifier requires source_kind to be present in the same request.
- external_relation_id and external_relation_kind must always be used together.
- trial_balance_id only supports the equals operator and cannot appear more than once.
- When using a single filter condition (without and/or), only id, transaction_datetime, service_date are allowed, and the operator must be equals or in.
Example — single filter condition (no AND/OR needed):
{
"filters": {
"field": "id",
"operator": "in",
"value": [101, 102, 103]
}
}
{
"filters": {
"field": "service_date",
"operator": "equals",
"value": "2024-01-01"
}
}
Example — composite filter condition:
{
"filters": {
"and": [
{
"field": "transaction_datetime",
"operator": "greater_than_or_equal",
"value": "2024-01-01T00:00:00Z"
},
{
"field": "transaction_datetime",
"operator": "less_than",
"value": "2024-02-01T00:00:00Z"
}
]
}
}
Example — composite filter condition with sorting and pagination:
{
"filters": {
"and": [
{
"operator": "greater_than_or_equal",
"value": "2019-01-11T08:59:00Z",
"field": "transaction_datetime"
},
{
"operator": "equals",
"value": "123",
"field": "source_id"
},
{
"operator": "equals",
"value": "RESERVATION",
"field": "source_kind"
},
{
"or": [
{
"operator": "in",
"value": ["1", "2", "3"],
"field": "customer_id"
},
{
"operator": "equals",
"value": "9000",
"field": "internal_code"
}
]
}
]
},
"pageToken": null,
"limit": 10,
"sort": [
{
"field": "transaction_datetime",
"direction": "asc"
}
]
}
Request
- Base URLhttps://api.cloudbeds.com
- URLhttps://api.cloudbeds.com/accounting/v1.0/transactions
- Auth
- HTTP bearer
- or OAuth 2Implicit: https://hotels.cloudbeds.com/api/v1.2/oauthScopes: read:payment
Headers
Unique identifier of the property. Required for all requests to scope data to a specific property.
Request body
Response
OK
Example response
{
"transactions": [
{
"sourceDatetime": "2017-07-21T17:32:28Z",
"transactionDatetime": "2017-07-21T17:32:28Z",
"serviceDate": "2017-07-21",
"businessDate": "2026-06-21",
"createdAt": "2017-07-21T17:32:28Z",
"sourceIdentifier": "38883261663",
"subSourceIdentifier": "38883261663-2"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.