---
title: "Classifies a payment as a deposit."
method: PUT
path: "/finance/v0-nsfw/folios/{folioId}/payments/{paymentId}/classify-as-deposit"
tags: ["FolioPayments"]
---

# Classifies a payment as a deposit.

`PUT /finance/v0-nsfw/folios/{folioId}/payments/{paymentId}/classify-as-deposit`

## 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/folios/{folioId}/payments/{paymentId}/classify-as-deposit`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `payments.create`, `folios.manage`, `admin`

Creates the deposit entry and its VAT snapshot for a payment that was eligible when it succeeded.
A charge posted after the payment does not prevent classification.<br>You must have at least one of these scopes: 'payments.create, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_payments.classify_as_deposit'.

## Path parameters

- `folioId` string, required
- `paymentId` string, required

## Response `200`

The id of the created deposit entry.

- ClassifyPaymentAsDepositModel
  - `depositEntryId` string, required: Id of the deposit entry created for the payment.

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

## Changes

- **2026-11-10** `9b6aaae9769f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/changes/finance/v0-nsfw/folios/:folioId/payments/:paymentId/classify-as-deposit/put.md)

---

[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/e5cb21fcadb5?raw)
