---
title: "Get folio balance summary"
method: GET
path: "/accounting/v1.0/folios/summary"
tags: ["Folios"]
---

# Get folio balance summary

`GET /accounting/v1.0/folios/summary`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/accounting/v1.0/folios/summary`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Implicit: `https://hotels.cloudbeds.com/api/v1.2/oauth`
    - Scopes: `read:payment`

Retrieve a summary of each folio for a given source (reservation or group profile). Returns a map keyed by folio ID, where each value contains the folio's balance due. The balance is computed from both posted and pending transactions assigned to each folio.

## Query parameters

- `filter` object, required
  - `sourceId` integer, required: Filter by source ID
  - `sourceKind` 'CONFIG' | 'RESERVATION' | 'GROUP_PROFILE', required: The type of source a folio belongs to. CONFIG indicates a folio configuration template, RESERVATION is an individual guest booking, and GROUP_PROFILE is a group booking profile.

## Headers

- `X-Property-ID` integer, required

## Response `200`

OK

- FolioSummary[]
  - `folioId` string: Folio ID
  - `balanceDue` number, double: Balance due for this folio
  - `upcomingPayments` number, double: Upcoming (pending) payments for this folio

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/cloudbeds/apis/accounting-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/accounting-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/accounting-api/revisions/0b58c698deef?raw)