foliolib.folio.api.feesfines.LostItemFeePolicy

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

Bases: foliolib.folio.FolioApi

Lost Item Fee Policies API

Lost Item Fee Policies

Parameters

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

Methods

`delete_lostItemFeesPolicy`(lostItemFeePolicyId)	Delete Lost Item Fee Policy by id
`get_lostItemFeesPolicies`(**kwargs)	Get Lost Item Fee Policy list
`get_lostItemFeesPolicy`(lostItemFeePolicyId)	Get Lost Item Fee Policy by id
`modify_lostItemFeesPolicy`(...)	Update lostItemFeesPolicy item with given {lostItemFeesPolicyId}
`set_lostItemFeesPolicy`(lostItemFeesPolicy)	Create new Lost Item Fee Policy

delete_lostItemFeesPolicy(lostItemFeePolicyId: str)

Delete Lost Item Fee Policy by id

DELETE /lost-item-fees-policies/{lostItemFeePolicyId}

Parameters

lostItemFeePolicyId (str) –

Raises

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

get_lostItemFeesPolicies(**kwargs)

Get Lost Item Fee Policy list

GET /lost-item-fees-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 lost item fee policies",
  "type": "object",
  "properties": {
    "lostItemFeePolicies": {
      "description": "List of lost item fee policies",
      "id": "lostItemFeePolicies",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "lost-item-fee-policy.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "lostItemFeePolicies",
    "totalRecords"
  ]
}

get_lostItemFeesPolicy(lostItemFeePolicyId: str)

Get Lost Item Fee Policy by id

GET /lost-item-fees-policies/{lostItemFeePolicyId}

Parameters

lostItemFeePolicyId (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": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$ref": "charge.json"
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Lost item fee policy id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

modify_lostItemFeesPolicy(lostItemFeePolicyId: str, lostItemFeesPolicy: dict)

Update lostItemFeesPolicy item with given {lostItemFeesPolicyId}

PUT /lost-item-fees-policies/{lostItemFeePolicyId}

Parameters

lostItemFeePolicyId (str) –
lostItemFeesPolicy (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": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$ref": "charge.json"
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Lost item fee policy id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

set_lostItemFeesPolicy(lostItemFeesPolicy: dict)

Create new Lost Item Fee Policy

POST /lost-item-fees-policies

Parameters

lostItemFeesPolicy (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 lostItemFeesPolicy item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$ref": "charge.json"
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$ref": "period.json"
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee policy, provided by the server",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    },
    "id": {
      "description": "Lost item fee policy id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}