APapaleo
DepositContainer

Get a deposit container by ID.

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'.

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

Path parameters

idstring required

The id of the deposit container.

Response

Success.

idstring required

The id of the deposit container.

reservationIdstring required

The id of the reservation this container belongs to.

propertyIdstring required

The id of the property.

currencystring required

The currency of the container remaining amount.

Example response

{
  "id": "DEPC-MUC-ABCDEF",
  "reservationId": "ABCDEF",
  "propertyId": "MUC",
  "currency": "EUR",
  "remaining": {
    "amount": 0,
    "currency": "EUR"
  },
  "entries": []
}

Changes

No recorded changes to this operation across all 4 revisions of this API.