APapaleo
FolioActions

Creates a new deposit item for the specified folio

<br>You must have at least one of these scopes: 'depositItems.manage, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.create_deposit_item'.

post/finance/v0-nsfw/folio-actions/{folioId}/deposit-items

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/folio-actions/{folioId}/deposit-items
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: depositItems.manage, folios.manage, admin

Path parameters

folioIdstring required

The folio ID

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

serviceDatestring date

The date the service is expected to be provided

nameobject required

Names of the deposit item in different languages.

vatType'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed'

The VAT type of the service to be provided

quantityinteger

The quantity of provided services

Example request

{
  "amount": {
    "amount": 10,
    "currency": "EUR"
  },
  "serviceDate": "2026-10-17",
  "name": {
    "en": "Parking slot",
    "de": "Parkplatz"
  },
  "vatType": "Normal",
  "quantity": 1
}

Response

Created

idstring required

The ID of the newly created deposit item.

Example response

{
  "id": "1234"
}

Changes

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