foliolib.folio.api.finance.ReleaseEncumbrance

class foliolib.folio.api.finance.ReleaseEncumbrance(tenant: str)

Bases: foliolib.folio.FolioApi

Release encumbrance API

This documents the API calls that release any remaining money encumbered back to the budget’s available pool.

It should only be used by the UI, and only to release 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_releaseEncumbrance(releaseEncumbranceId)

Release encumbrance (use only in UI for a single encumbrance - use <tt>batch-all-or-nothing</tt> otherwise)

set_releaseEncumbrance(releaseEncumbranceId: str)

Release encumbrance (use only in UI for a single encumbrance - use <tt>batch-all-or-nothing</tt> otherwise)

POST /finance/release-encumbrance/{releaseEncumbranceId}

Parameters

releaseEncumbranceId (str) –

Raises
  • OkapiRequestError – Bad Request

  • OkapiRequestNotFound – Not Found

  • OkapiRequestFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity