FolioPayments

Classifies a payment as a deposit.

Changed on

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

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)
  • Auth
    OAuth 2
    Implicithttps://identity.apaleo.com/connect/authorize
    Scopespayments.create, folios.manage, admin

Path parameters

folioIdstring required

The folio ID

paymentIdstring required

The ID of the payment

Response

The id of the created deposit entry.

depositEntryIdstring required

Id of the deposit entry created for the payment.

Example response

{
  "depositEntryId": "CONT1-1"
}

Changes