foliolib.folio.api.finance.UnreleaseEncumbrance
- class foliolib.folio.api.finance.UnreleaseEncumbrance(tenant: str)
Bases:
foliolib.folio.FolioApiUnrelease encumbrance API
- This documents the API calls that unrelease any remaining money encumbered back to the budget’s available pool.
It should only be used by the UI, and only to unrelease a single encumbrance - <tt>batch-all-or-nothing</tt> should be used otherwise
Base class of the Folio API
- Parameters
tenant (str) – Tenant id
Methods
set_unreleaseEncumbrance(unreleaseEncumbranceId)Unrelease encumbrance (use only in UI for a single encumbrance - use <tt>batch-all-or-nothing</tt> otherwise)
- set_unreleaseEncumbrance(unreleaseEncumbranceId: str)
Unrelease encumbrance (use only in UI for a single encumbrance - use <tt>batch-all-or-nothing</tt> otherwise)
POST /finance/unrelease-encumbrance/{unreleaseEncumbranceId}- Parameters
unreleaseEncumbranceId (str) –
- Raises
OkapiRequestError – Bad Request
OkapiRequestNotFound – Not Found
OkapiRequestFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity