Source:

Module: mod-feesfines

Interface: /overdue-fines-policies

Attributes:

Property Name Property Type Property Description
name string Overdue fine policy name
description string Overdue fine policy description
overdueFine object Amount of times the interval repeats
overdueFine/quantity number Fine amount per interval
overdueFine/intervalId string Interval for the period, e.g. hour, day, week, month or year
countClosed boolean A flag to determine if a fine is count closed
maxOverdueFine number Maximum overdue fine
forgiveOverdueFine boolean A flag to determine forgive overdue fine if item renewed
overdueRecallFine object Amount of times the interval repeats
overdueRecallFine/quantity number Fine amount per interval
overdueRecallFine/intervalId string Interval for the period, e.g. hour, day, week, month or year
gracePeriodRecall boolean Grace period for recall
maxOverdueRecallFine number Maximum overdue recall fine
reminderFeesPolicy object Reminder fee policy as part of overdue fine policy
reminderFeesPolicy/countClosed boolean A flag to determine if a reminder fee should take closed days into account
reminderFeesPolicy/ignoreGracePeriodRecall boolean Ignore grace period for recall
reminderFeesPolicy/ignoreGracePeriodHolds boolean Ignore grace period for holds
reminderFeesPolicy/allowRenewalOfItemsWithReminderFees boolean Allow renewal of items with reminder fee(s)
reminderFeesPolicy/clearPatronBlockWhenPaid boolean Clear patron block when paid
reminderFeesPolicy/reminderSchedule array Ordered list of reminder notices
reminderFeesPolicy/reminderSchedule/interval integer Number of units of time before notice should be sent
reminderFeesPolicy/reminderSchedule/timeUnitId string Time unit of interval
reminderFeesPolicy/reminderSchedule/reminderFee number Fee amount accrued by reminder notice
reminderFeesPolicy/reminderSchedule/noticeFormat string Method of sending notice
reminderFeesPolicy/reminderSchedule/noticeTemplateId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
reminderFeesPolicy/reminderSchedule/blockTemplateId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
metadata object Metadata about creation and changes to records, provided by the server (client should not provide)
metadata/createdDate string Date and time when the record was created
metadata/createdByUserId string ID of the user who created the record (when available)
metadata/createdByUsername string Username of the user who created the record (when available)
metadata/updatedDate string Date and time when the record was last updated
metadata/updatedByUserId string ID of the user who last updated the record (when available)
metadata/updatedByUsername string Username of the user who last updated the record (when available)
id string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/