---
title: "Returns number of folios."
method: GET
path: "/finance/v1/folios/$count"
tags: ["Folio"]
---

# Returns number of folios.

`GET /finance/v1/folios/$count`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/finance/v1/folios/$count`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `folios.read`, `folios.manage`, `admin`

Returns number of folios matching the filter criteria.<br>You must have at least one of these scopes: 'folios.read, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.read'.

## Query parameters

- `propertyIds` string[]
- `companyIds` string[]
- `reservationIds` string[]
- `bookingIds` string[]
- `isEmpty` boolean
- `excludeClosed` boolean
- `hasInvoices` boolean
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `updatedFrom` string, date-time
- `updatedTo` string, date-time
- `onlyMain` boolean
- `type` 'House' | 'Guest' | 'External' | 'Booking'
- `status` 'Open' | 'Closed'
- `externalFolioCode` string
- `textSearch` string
- `balanceFilter` string[]

## Response `200`

Success.

- CountModel
  - `count` integer, required

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-finance-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api/revisions/345020399e9a?raw)
