APapaleo
FolioActions

Closes a folio.

Mark a folio as closed to prevent adding charges and payments. This action cannot be undone, and is only possible if the balance is 0.

Requires 'allowed action': Close.<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.close'.

put/finance/v0-nsfw/folio-actions/{folioId}/close

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}/close
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: folios.manage, admin

Path parameters

folioIdstring required

The folio ID.

Response

Success.

Changes

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