CLcloudbeds
Deposits

List deposit transactions

Retrieve a paginated list of deposit transactions for a property. You can filter by transaction state, reservation, date ranges (transaction date, check-in, check-out), reservation status, and user. Use this endpoint to review deposit activity including payments received, transfers, and refunds.

get/accounting/v1.0/deposits/transactions

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/accounting/v1.0/deposits/transactions
  • Auth
    • HTTP bearer
    • or OAuth 2
      Implicit: https://hotels.cloudbeds.com/api/v1.2/oauth
      Scopes: read:payment

Query parameters

pageTokenstring

Opaque token for cursor-based pagination. Pass the nextPageToken value from a previous response to retrieve the next page. Omit this parameter (or pass null) for the first page.

pageSizeinteger

Number of results to return per page. If not specified, the server uses a default page size.

transactionStatesTransactionState[]

transaction states

includeInactiveboolean

Include inactive transactions (voided, consumed, cancelled, deleted)

sourceIdinteger

Filter by source ID. Must be used with sourceKind.

sourceKind'RESERVATION' | 'GROUP_PROFILE'

Filter by source kind. Must be used with sourceId.

transactionDateFromstring date
transactionDateTostring date
checkinDateFromstring date
checkinDateTostring date
checkoutDateFromstring date
checkoutDateTostring date
reservationStatusesReservationStatus[]

Filter by one or more reservation statuses (OR logic). When provided, the deprecated reservationStatus field is ignored.

userIdinteger[]
sortBy'CHECKOUT_DATE' | 'CHECKIN_DATE' | 'TRANSACTION_DATE' | 'AMOUNT' | 'RESERVATION_STATUS'

Sort field

sortDirection'asc' | 'desc'

Direction for sort - asc or desc

Headers

X-Property-IDinteger required

Unique identifier of the property. Required for all requests to scope data to a specific property.

Response

OK

nextPageTokenstring

Token for fetching the next page of results

Changes

No recorded changes to this operation across all 1 revision of this API.