Give patrons a receipt when they borrow or return material, on paper, on screen or sent by the library system.

1 of 2 supported 16 October 2026

2.12.1 View receipts

Not yet

Show the patron their earlier receipts.

2.12.2 Send receipts

Supported

Give the patron a receipt for what they have just borrowed or returned.

What you can build

A self-service machine or a staff desk can print or show a receipt straight after checkout or checkin. Where the library system sends receipts itself, the patron can get them by email or text message instead.

Typical flow

  1. The patron borrows or returns material (2.16.1, 2.16.2).
  2. A completed Checkout or Checkin returns what the receipt needs: the item, the publication, the date and time and, on a loan, the due date.
  3. The client prints or shows the receipt from that response.
  4. Where the provider offers the notification types checkout_receipt and checkin_receipt, the patron can choose a delivery method for them with UpdatePatronNotificationSettings (2.11.4), and the library system sends the receipt itself.

What the API provides

  • publicationId is there so the client can show or print a title. publicationMetadata is a fallback when the publication cannot be fetched on its own.
  • fees lists the fees the checkout or checkin created, for example an overdue fine. An empty list means none; a missing field means the provider cannot tell.
  • checkout_receipt and checkin_receipt are recommended notification types, not required ones. GetPatronNotificationSettings shows which types the provider has.