foliolib.folio.api.feesfines.OverdueFinePolicy

class foliolib.folio.api.feesfines.OverdueFinePolicy(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Overdue Fine Policies API

Overdue Fine Policies

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`delete_overdueFinesPolicy`(overdueFinePolicyId)	Delete Overdue Fine Policy by id
`get_overdueFinesPolicies`(**kwargs)	Get Overdue Fine Policy list
`get_overdueFinesPolicy`(overdueFinePolicyId)	Get Overdue Fine Policy by id
`modify_overdueFinesPolicy`(...)	Update overdueFinesPolicy item with given {overdueFinesPolicyId}
`set_overdueFinesPolicy`(overdueFinesPolicy)	Create new Overdue Fine Policy

delete_overdueFinesPolicy(overdueFinePolicyId: str)

Delete Overdue Fine Policy by id

DELETE /overdue-fines-policies/{overdueFinePolicyId}

Parameters

overdueFinePolicyId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

get_overdueFinesPolicies(**kwargs)

Get Overdue Fine Policy list

GET /overdue-fines-policies

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

searchable using CQL

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- name=”undergrad*”
orderBy (str) – Order by field: field A, field B
order (str (desc|asc) – ): (default=desc) Order
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of overdue fine policies",
  "type": "object",
  "properties": {
    "overdueFinePolicies": {
      "description": "List of overdue fine policies",
      "id": "overdueFinePolicies",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "overdue-fine-policy.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "overdueFinePolicies",
    "totalRecords"
  ]
}

get_overdueFinesPolicy(overdueFinePolicyId: str)

Get Overdue Fine Policy by id

GET /overdue-fines-policies/{overdueFinePolicyId}

Parameters

overdueFinePolicyId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$ref": "quantity.json"
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$ref": "quantity.json"
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$ref": "reminder-fees-policy.json"
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

modify_overdueFinesPolicy(overdueFinePolicyId: str, overdueFinesPolicy: dict)

Update overdueFinesPolicy item with given {overdueFinesPolicyId}

PUT /overdue-fines-policies/{overdueFinePolicyId}

Parameters

overdueFinePolicyId (str) –
overdueFinesPolicy (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiRequestConflict – Conflict
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$ref": "quantity.json"
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$ref": "quantity.json"
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$ref": "reminder-fees-policy.json"
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

set_overdueFinesPolicy(overdueFinesPolicy: dict)

Create new Overdue Fine Policy

POST /overdue-fines-policies

Parameters

overdueFinesPolicy (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created overdueFinesPolicy item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$ref": "quantity.json"
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$ref": "quantity.json"
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$ref": "reminder-fees-policy.json"
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}