The Fine API

The Fine API contains methods for retrieving fine information and paying fines in batch. If you want to retrieve, add, or pay a fine for a specific patron, see The Patron API - Fines.

With the Fine API, 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 List of Fines

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

GET /v6/fines

Returns fines data. For a description of the fields returned, see the Fine Object description.

By default, the first 50 results are returned. You can limit the number of results to a value from 1 to 2000 and specify the beginning record to return. See Pagination Parameters for more information on using these limiters.

Additionally, you can limit the fines data that is returned using the filter parameters below. In most cases, you can enter a single value or a comma-delimited list of values. See Filter Parameters for more information.

Parameter Name Data Type Description
id fine ID Returns fines data for the specified fine IDs.
fields fields from the fine record Returns data for the specified fine fields only. See the Fine Object description for information on the fine fields you can specify with this parameter.
agencyCodes agency codes Returns fines data for the specified agencies.
assessedDate single date or a date range Returns data for fines with the specified assessed date. The assessed date is the date that the fine was initially added to the patron’s record. This value can be a single date or a date range.
invoiceNumber invoice number of the fine Returns fines data for the specified invoice numbers.
patronId patron record number Returns data for all fines associated with the specified patron records.

Try it out!

Pay Multiple Patron Fines

This endpoint is available in Sierra 4.2 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.

PUT /v6/fines/payment

Pays multiple patrons' fines in batch. This endpoint is useful for institutions where fine payments are collected by a different system (for example, a bursar's office at a university) and you want to record the fine payments in the Sierra system.

If the payment request is passed successfully to Sierra, an HTTP 200 is returned. Sierra API also returns details of any payments that could not be processed (for example, because the fine's invoice number was invalid). The following example shows two payments that failed. 

{
   "failedPayments": [
      {
         "error": "Payment refused due to invalid invoice",
         "bulkPayment": {
            "patron": 1005244,
            "payments": [
               {
                 "amount": 1000,
                 "paymentType": 1,
                 "invoiceNumber": "471039",
                 "initials": "bcw"
               }
            ]
         }
      },
      {
         "error": "Patron Record Is Busy",
         "bulkPayment": {
            "patron": 1001492,
            "payments": [
               {
                 "amount": 25,
                 "paymentType": 1,
                 "invoiceNumber": "470995",
                 "initials": "bcw"
               }
            ]
         }
      }
   ]
}

Try it out!