The Patron API - Fines

The Patron API contains methods for retrieving, adding, and paying fines for a patron. If you want to retrieve or pay fines for multiple patrons in bulk (for example, for a Bursar's office), see the Fines API.

Using these endpoints, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Get a fine record by fine ID

To use this endpoint, your key must be assigned the Patrons Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/patrons/fines/{fineId}

Returns a single Fine object.

Try it out!

Get the fines data for a single patron record

To use this endpoint, your key must be assigned the Patrons Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/patrons/{id}/fines

Returns all fines data for a specified patron record.

Try it out!

Add a manual fine to a patron

This endpoint is available in Sierra 4.3 and later. To use this endpoint, your key must be assigned the Patrons Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

POST /v6/patrons/{id}/fines/charge

Adds a manually-created fine to the specified patron record.

If the fine is successfully created, an HTTP 204 is returned. Otherwise, an error code is returned.

Try it out!

Pay a patron's fines

To use this endpoint, your key must be assigned the Patrons Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

PUT /v6/patrons/{id}/fines/payment

Pays a patron's fines partially, fully, or with a waiver. This creates a new fine paid record for the specific patron.

Try it out!