--- title: "List deposit transactions" method: GET path: "/accounting/v1.0/deposits/transactions" tags: ["Deposits"] --- # List deposit transactions `GET /accounting/v1.0/deposits/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. ## Query parameters - `pageToken` string - `pageSize` integer - `filter` object - `transactionStates` TransactionState[] — transaction states - `includeInactive` boolean — Include inactive transactions (voided, consumed, cancelled, deleted) - `sourceId` integer — Filter by source ID. Must be used with sourceKind. - `sourceKind` 'RESERVATION' | 'GROUP_PROFILE' — Filter by source kind. Must be used with sourceId. - `transactionDateFrom` string, date - `transactionDateTo` string, date - `checkinDateFrom` string, date - `checkinDateTo` string, date - `checkoutDateFrom` string, date - `checkoutDateTo` string, date - `reservationStatuses` ReservationStatus[] — Filter by one or more reservation statuses (OR logic). When provided, the deprecated reservationStatus field is ignored. - `userId` integer[] - `sortBy` 'CHECKOUT_DATE' | 'CHECKIN_DATE' | 'TRANSACTION_DATE' | 'AMOUNT' | 'RESERVATION_STATUS' — Sort field - `sortDirection` 'asc' | 'desc' — Direction for sort - asc or desc ## Headers - `X-Property-ID` integer, required ## Response `200` OK - ExtendedTransactionPaginated - `content` ExtendedTransactionResponse[] - `id` string — Id of the transaction. - `transactionDate` string, date-time — Date time of the transaction. - `amount` number — amount of the transaction. - `internalTransactionCode` string — Internal Transaction Code - `description` string — Description - `notes` string — Notes - `folioId` string — Folio ID - `state` 'VOIDED' | 'TRANSFERRED' | 'CANCELLED' | 'REFUNDED' | 'DELETED' - `transferredAmount` number — Total amount already transferred to guest ledger. Null for non-deposit or inactive transactions. - `refundedAmount` number — Total amount already refunded via payment service. Null for non-deposit or inactive transactions. - `availableAmount` number — Amount still available for transfer or refund. Null for non-deposit or inactive transactions. - `currency` string — Currency ISO code - `currencyScale` integer — Number of decimal places for the currency. - `source` DepositSource — Source entity details. Exactly one of the nested objects will be present. - `reservation` DepositSourceReservation - `id` string — Reservation ID. - `identifier` string — Reservation identifier. - `guestName` string — Guest name. - `status` 'checked_out' | 'checked_in' | 'confirmed' | 'canceled' | 'not_confirmed' | 'inquiry' | 'deleted' | 'no_show' — Current status of a reservation. The status affects which accounting operations are permitted (e.g., charges cannot be added to a checked-out reservation). - `checkinDate` string, date — Check-in date. - `checkoutDate` string, date — Checkout date. - `groupProfile` DepositSourceGroupProfile - `id` string — Group profile ID. - `identifier` string — Group profile code. - `name` string — Group profile name. - `status` string — Group profile status. - `posted` boolean — Flag to mark if transaction is posted - `user` UserModel - `id` string — The ID of the user. - `firstName` string — The name of the user. - `lastName` string — The last name of the user. - `email` string — User email - `type` 'REAL_USER' | 'SYSTEM_USER' | 'UNKNOWN_USER' — REAL_USER - user was found, UNKNOWN_USER - user was not found, SYSTEM_USER - user_id = 0 OR null - `actions` Action[] — Returns the list of actions available for the transaction - `type` 'CANCEL' | 'RECTIFY' | 'DOWNLOAD' | 'CREDIT_NOTE' | 'VOID_AND_CREDIT_NOTE' | 'VOID' | 'VOID_AND_REFUND' | 'ADD_PAYMENT' | 'APPLY_TO_INVOICE' | 'GENERATE_SETTLEMENT' — Action that can be performed on a fiscal document - `fields` FieldDefinition[] — Action-specific input fields the UI must collect before submitting. Uses the same FieldDefinition schema as /fiscalization/rules. - `path` string, required — Field path (e.g., "name", "tax_id.code", "addresses") - `label` string, required — Display label for the field - `type` 'text' | 'email' | 'password' | 'file' | 'select' | 'boolean' | 'array' | 'object', required — Field input type - `category` 'company' | 'tax' | 'address' | 'contact' | 'supplementary' | 'custom' — Field grouping category - `sectionKey` string — Key of the RulesSection that hosts this field. Defaults to "registration" when absent. Nested fields inside arrays/objects inherit the parent's section and should omit this attribute. - `required` boolean, required — Whether field is required - `primary` boolean — Indicates primary tax ID field - `validation` FieldValidation - `pattern` string — Regex pattern for validation - `min` integer — Minimum length or items - `max` integer — Maximum length - `checksum` boolean — Whether field has checksum validation - `format` string — Display format mask (e.g., XX.XXX.XXX/XXXX-XX) - `message` string — Human-readable description of the rule, suitable for FE error messages (e.g. "NFS-e series must be 1-5 alphanumeric characters"). - `example` string — A valid example value that can be shown as a placeholder hint (e.g. "ABC12" for NFS-e, "1" for NFC-e). - `data` FieldData - `placeholder` string — Input placeholder text - `help` string — Help text for the field - `alternatives` string[] — Alternative accepted formats (e.g., CPF for CNPJ fields) - `options` SelectOption[] - `value` string, required - `label` string, required - `item` ArrayItemDefinition - `type` 'object', required - `fields` FieldDefinition[], required - `properties` object — Object properties for object type fields - `default` union - string - boolean - number - `description` string — Field description - `paymentDetails` PaymentDetails — Payment-specific fields. Only present on transactions where internalCodeGroup=PAYMENT. Enriched via batch PaymentService lookup. - `paymentId` string — Payment ID from the payment service - `transactionType` 'Purchase' | 'Capture' | 'Refund' | 'Authorize' | 'Void' | 'Record' — Payment processing transaction type - `paymentMethod` string — Payment method code (e.g. "cash", "cards", "terminal", "ebanking", "pay_pal", "oxxo") - `gateway` string — Payment gateway identifier (e.g. "StripeConnectGateway", "AdyenGateway") - `creditCardType` string — Card brand code (e.g. "visa", "master", "amex") - `cardTrailingDigits` string — Last 4 digits of the card number - `amountPaid` number, double — Total captured/paid amount - `amountRefunded` number, double — Total refunded amount - `processingStatus` 'unconfirmed' | 'confirmed' — Payment processing status (for scheduled payments) - `nextPageToken` string — Token for fetching the next page of results ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)