APapaleo
FolioActions

Move multiple payments from one guest/booking folio to another.

Move payments from one guest/booking folio to another - moving between different bookings is not supported, and will lead to an error. If one of the folios is closed, this action cannot be performed.

The PSP reference, if present, will be removed when moving and only be persisted on the original payment.<br>You must have at least one of these scopes: 'charges.move, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.move_payment'.

put/finance/v1/folio-actions/{folioId}/move-payments

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

Path parameters

folioIdstring required

The ID of the source folio from where the payments should be moved away.

Request body

targetFolioIdstring required

ID of the target folio

reasonstring required

Description of why the move is performed

paymentIdsstring[] required

The IDs of the payments that should be moved

Example request

{
  "targetFolioId": "KFCSQUID-1",
  "reason": "Test",
  "paymentIds": [
    "KFCSQUID-1-C-1",
    "KFCSQUID-1-C-5"
  ]
}

Response

Success.

Changes

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