---
title: "Get allocations summary"
method: GET
path: "/fiscal-document/v1/fiscal-documents/allocations/summary"
tags: ["Fiscal Documents"]
---

# Get allocations summary

`GET /fiscal-document/v1/fiscal-documents/allocations/summary`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/allocations/summary`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize`
    - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `read:reservation`

Retrieves allocations summary.

## Query parameters

- `sourceId` integer, required
- `sourceKind` 'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER', required: Kind of the source entity
- `folioIds` integer[]
- `documentIds` integer[]

## Headers

- `X-Property-ID` integer, required

## Response `200`

OK

- AllocationsSummary
  - `totalAmount` number
  - `totalAllocated` number

---

[API](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api/revisions/9c2a47775e5e?raw)
