Source:

Module: mod-circulation-storage

Interface: /loan-storage/loans

Attributes:

Property Name Property Type Property Description
id string Unique ID (generated UUID) of the loan
userId string ID of the patron the item was lent to. Required for open loans, not required for closed loans (for anonymization).
proxyUserId string ID of the user representing a proxy for the patron
itemId string ID of the item lent to the patron
itemEffectiveLocationIdAtCheckOut 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/
status object Overall status of the loan
status/name string Name of the status (currently can be any value, values commonly used are Open and Closed)
forUseAtLocation object Status of loan/item that is to be used in the library, i.e. in a reading room
forUseAtLocation/status string Indicates if the item is currently used by or being held for the patron
forUseAtLocation/statusDate string Date and time the status was registered
forUseAtLocation/holdShelfExpirationDate string Date when a held item expires
loanDate string Date time when the loan began (typically represented according to rfc3339 section-5.6. Has not had the date-time format validation applied as was not supported at point of introduction and would now be a breaking change)
dueDate string Date time when the item is due to be returned
returnDate string Date time when the item is returned and the loan ends (typically represented according to rfc3339 section-5.6. Has not had the date-time format validation applied as was not supported at point of introduction and would now be a breaking change)
systemReturnDate string Date time when the returned item is actually processed
action string Last action performed on a loan (currently can be any value, values commonly used are checkedout and checkedin)
actionComment string Comment to last action performed on a loan
itemStatus string Last item status used in relation to this loan (currently can be any value, values commonly used are Checked out and Available)
renewalCount integer Count of how many times a loan has been renewed (incremented by the client)
loanPolicyId string ID of last policy used in relation to this loan
checkoutServicePointId string ID of the Service Point where the last checkout occured
checkinServicePointId string ID of the Service Point where the last checkin occured
patronGroupIdAtCheckout string Patron Group Id at checkout
dueDateChangedByRecall boolean Indicates whether or not this loan had its due date modified by a recall on the loaned item
isDcb boolean Indicates whether or not this loan is associated for DCB use case
declaredLostDate string Date and time the item was declared lost during this loan
claimedReturnedDate string Date and time the item was claimed returned for this loan
overdueFinePolicyId string ID of overdue fines policy at the time the item is check-in or renewed
lostItemPolicyId string ID of lost item policy which determines when the item ages to lost and the associated fees or the associated fees if the patron declares the item lost.
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)
agedToLostDelayedBilling object Aged to Lost Delayed Billing processing
agedToLostDelayedBilling/lostItemHasBeenBilled boolean Indicates if the aged to lost fee has been billed (for use where delayed billing is set up)
agedToLostDelayedBilling/dateLostItemShouldBeBilled string Indicates when the aged to lost fee should be billed (for use where delayed billing is set up)
agedToLostDelayedBilling/agedToLostDate string Date and time the item was aged to lost for this loan
reminders object Information about reminders for overdue loan
reminders/lastFeeBilled object Information about the most recent reminder fee billing
reminders/lastFeeBilled/number integer Last reminder fee billed, sequence number
reminders/lastFeeBilled/date string Last reminder fee billed, date