Fine Object

Click the links below to view the Fine Object properties and examples. The examples show returns that reflect three different creationMethod types: Automatic ("a"), Adjustment (also "a"), and Manual ("m").

id

string

(Always returned in the response.)

The ID of the fine, returned as an API endpoint.

Example: 

"id": "https://example-library.edu/iii/sierra-api/v6/patrons/checkouts/4519234"

patron

string

The patron record number associated with the fine, returned as an API endpoint.

Example: 

"patron": "https://example-library.edu/iii/sierra-api/v6/patrons/1042514"

item

string

The item record number associated with the fine, returned as an API endpoint.

Example: 

"item": "https://example-library.edu/iii/sierra-api/v6/items/1000012"

assessedDate

string

The date the fine was assessed, in ISO 8601 format (YYYY-MM-DD).

Example: 

"assessedDate": "2015-04-28"

description

string

The reason for the charge.

Example: 

"description": "Expired Hold Charge"

invoiceNumber

integer

(Returned only if requested.)

The fine's invoice number.

Example: 

"invoiceNumber": 793639

chargeType

object

The chargeType property contains a ChargeType object, which contains the charge type code and display name. See Fines Display in the Sierra WebHelp for more information on charge types.

Example: 

"chargeType": {
  "code": "1",
  "display": "Manual"
}

code

character

A code representing the type of charge assessed.

Example: 

"code": "1"

display

string

The display text that describes the type of charge.

Example: 

"display": "Manual"

itemCharge

number

A fine amount related to the item (the exact meaning depends on the charge code).

Example: 

"itemCharge": 3

processingFee

number

A processing fee amount (the exact meaning depends on the charge code).

Example: 

"processingFee": 0

billingFee

number

A billing fee amount (the exact meaning depends on the charge code).

Example: 

"billingFee": 0

paidAmount

number

The amount already paid for this fine.

Example: 

"paidAmount": 0

location

object

The location property contains a Location object, which contains the branch location (code and display name) assessing the charge.

Example: 

"location": {
  "code": "12",
  "name": "Edenvale"
}

code

string

The location code.

Example: 

"code": "12"

name

string

The location display name.

Example: 

"name": "Edenvale"

initials

string

Initials of the person collecting or adjusting the payment.

Example: 

"initials": "sj"

creationMethod

string

The method used to create the fine. This can be automatic ("a"), adjustment ("a"), or manual ("m").

Example: 

"creationMethod": "a"

datePaid

string

The date that the selected fine was paid or waved.

Example: 

"datePaid": "2015-05-19"

originalPatron

string

The original patron record number associated with the fine.

Example: 

"originalPatron": "https://<server-name>/iii/sierra-api/v6/patrons/1000312"

printBill

boolean

Indicates whether data is entered into an internal Sierra file.

Example: 

"printBill": false

terminalNumber

integer

The number of the terminal where the fine payment or adjustment was made.

Example: 

"terminalNumber": 0

transferDate

string

The date and time that the fine was transferred from the original patron to the current patron.

Example: 

"transferDate": "2013-02-16T14:22:57Z"

returnDate

string

The date that the item was returned.

Example: 

"returnDate": "2013-03-06T18:54:25Z"

agencyCode

string

The patron's agency code.

Example: 

"agencyCode": "0"

The preceding list order reflects the sequence in which the data returns.

Default Response Contents

Default query responses for the fine object do not include the following properties:

  • creationMethod
  • datePaid
  • initials
  • invoiceNumber
  • originalPatron
  • printBill
  • terminalNumber
  • transferDate

You must specify this additional property using filter parameters. For example:

https://example-library.edu/iii/sierra-api/v6/patrons/1042514/fines?fields=invoiceNumber

Returns the ID and invoiceNumber properties for any applicable Fine objects.

When you use the fields parameter, the API returns only the ID and specified properties. You can specify the value "default" to retrieve all default properties in addition to any explicitly specified properties, such as invoiceNumber. For example:

https://example-library.edu/iii/sierra-api/v6/patrons/1042514/fines?fields=default,invoiceNumber

Returns the default properties plus the invoiceNumber property for any applicable Fine objects.

https://example-library.edu:443/iii/sierra-api/v6/fines/?fields=id%2Cpatron%2Citem%2CassessedDate%2Cdescription%2CinvoiceNumber%2CchargeType%2CitemCharge%2CprocessingFee%2CbillingFee%2CpaidAmount%2Clocation%2Cinitials%2CcreationMethod%2CdatePaid%2CoriginalPatron%2CprintBill%2CterminalNumber%2CtransferDate%2CreturnDate%2CagencyCode
{
  "total": 3,
  "entries": [
    {
      "id": "2184",
      "patron": "https://example-library.edu/iii/sierra-api/v6/
                 patrons/1000320",
      "item": "https://example-library.edu/iii/sierra-api/v6/
               items/1072026",
      "assessedDate": "2001-03-12T17:53:27Z",
      "invoiceNumber": 28800,
      "chargeType": {
        "code": "2",
        "display": "Overdue"
    },
      "itemCharge": 3.6,
      "processingFee": 0,
      "billingFee": 0,
      "paidAmount": 0,
      "location": {
        "code": "main",
        "name": "main"
    },
      "creationMethod": "a",
      "printBill": false,
      "terminalNumber": 0,
      "returnDate": "2001-03-12T17:53:27Z",
      "agencyCode": 0
    }
  ]
}

https://example-library.edu:443/iii/sierra-api/v6/fines/?fields=id%2Cpatron%2Citem%2CassessedDate%2Cdescription%2CinvoiceNumber%2CchargeType%2CitemCharge%2CprocessingFee%2CbillingFee%2CpaidAmount%2Clocation%2Cinitials%2CcreationMethod%2CdatePaid%2CoriginalPatron%2CprintBill%2CterminalNumber%2CtransferDate%2CreturnDate%2CagencyCode
{
  "total": 3,
  "entries": [
    {
      "id": "2183",
      "patron": "https://example-library.edu/iii/sierra-api/v6/
                 patrons/1000304",
      "item": "https://example-library.edu/iii/sierra-api/v6/
               items/1023654",
      "assessedDate": "1998-01-12T14:01:37Z",
      "invoiceNumber": 11762,
      "chargeType": {
        "code": "4",
        "display": "Adjustment"
    },
      "itemCharge": 0,
      "processingFee": 0,
      "billingFee": 10,
      "paidAmount": 0,
      "location": {
        "code": "main",
        "name": "main"
    },
      "creationMethod": "a",
      "printBill": false,
      "terminalNumber": 0,
      "returnDate": "1998-02-04T19:28:47Z",
      "agencyCode": 0
    }
  ]
}
		
https://example-library.edu:443/iii/sierra-api/v6/fines/?fields=id%2Cpatron%2Citem%2CassessedDate%2Cdescription%2CinvoiceNumber%2CchargeType%2CitemCharge%2CprocessingFee%2CbillingFee%2CpaidAmount%2Clocation%2Cinitials%2CcreationMethod%2CdatePaid%2CoriginalPatron%2CprintBill%2CterminalNumber%2CtransferDate%2CreturnDate%2CagencyCode
{
  "total": 3,
  "entries": [
    {
      "id": "2182",
      "patron": "https://example-library.edu/iii/sierra-api/v6/
                 patrons/1000266,
      "assessedDate": "1995-07-25T14:07:18Z",
      "description": "unpaid fine 6/20/94",
      "invoiceNumber": 135,
      "chargeType": {
        "code": "1",
        "display": "Manual"
    },
      "itemCharge": 30,
      "processingFee": 0,
      "billingFee": 0,
      "paidAmount": 0,
      "location": {
        "code": "",
        "name": ""
    },
      "creationMethod": "m",
      "printBill": true,
      "terminalNumber": "0"
      "agencyCode": "0"
    }
  ]
}