---
title: "Get a deposit container by ID."
method: GET
path: "/finance/v0-nsfw/deposit-containers/{id}"
tags: ["DepositContainer"]
---

# Get a deposit container by ID.

`GET /finance/v0-nsfw/deposit-containers/{id}`

## 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/v0-nsfw/deposit-containers/{id}`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `folios.read`, `folios.manage`, `admin`

Returns the reservation-level deposit container including entries, VAT allocations, and remaining amount.
Remaining is computed on read and is zero when the container has no entries.<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.deposit_container.read'.

## Path parameters

- `id` string, required

## Response `200`

Success.

- DepositContainerModel
  - `id` string, required: The id of the deposit container.
  - `reservationId` string, required: The id of the reservation this container belongs to.
  - `propertyId` string, required: The id of the property.
  - `currency` string, required: The currency of the container remaining amount.
  - `remaining` MonetaryValueModel, required
    - `amount` number, double, required
    - `currency` string, required
  - `entries` DepositEntryModel[], nullable: The deposit entries of this container.
    - `id` string, required: The id of the deposit entry.
    - `sourcePaymentId` string, required: The id of the payment that created this entry.
    - `sourceFolioId` string, required: The id of the folio the source payment was posted to.
    - `amount` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `remaining` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `vatAllocation` DepositEntryVatAllocationModel[], required: The VAT snapshot stored with the entry.
      - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required: The VAT type of this allocation.
      - `vatPercent` number, double, required: The VAT percent of this allocation.
      - `grossAmount` number, double, required: The gross amount of this allocation.
      - `netAmount` number, double, required: The net amount of this allocation.
      - `name` string, required: The name of the allocation, localized using the Accept-Language header.
    - `invoiceIds` string[], nullable: The ids of issued deposit invoices for this entry. Not set until an invoice has been issued.
    - `created` string, date-time, required: Date and time of creation.<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The deposit container was not 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-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/revisions/72cbd31f02f4?raw)