Payment Receipt Data Library
The payment receipt data library defines the elements you can use to create custom print templates for Fine Payment. These templates are created in a third-party application (such as Jaspersoft Studio) for use when printing payment receipts in Sierra Circulation. See Creating Customized Print Templates for more information.
Header and Footer Elements
The following table describes each element in the data library that can be added only to the header or footer of the receipt, as well as the data source for each element.
| Element Name | Description | Data Source |
|---|---|---|
| Bill_Payment_Type_C | The payment type the patron used to pay the fine. | The payment type selected from the Payment Types table when the fine was paid or waived within the Sierra system, if the Fine Payment Data feature is enabled. |
| Bill_Service_Charge_C | This element is no longer used. | n/a |
| Bill_Total_Org_C | On bill and fine notices for organization records, the total amount of charges the organization currently owes, including charges not listed on the current bill. | The MONEY OWED field in the organizational patron record. |
| Bill_Total_Patron_Fines_C | The total amount of charges the patron currently owes, including charges not listed on the current bill. | The MONEY OWED field in the organizational patron record. |
| Bill_Waived_Amount_C | The total amount of fines waived during the current transaction. | The Sierra system. |
| Credit_Card_Info_C | This element is no longer used. | n/a |
| Library_Address_Line1_C | The first line of your library's address. | The first line of the Address element in the Branch Addresses table entry that corresponds to your login's locations served. If your login does not have a locations served value, this element is blank. |
| Library_Address_Line2_C | The second line of your library's address. | The second line of the Address element in the Branch Addresses table entry that corresponds to your login's locations served. If your login does not have a locations served value, this element is blank. |
| Library_Address_Line3_C | The third line of your library's address. | The third line of the Address element in the Branch Addresses table entry that corresponds to your login's locations served. If your login does not have a locations served value, this element is blank. |
| Library_Address_Line4_C | The fourth line of your library's address. | The fourth line of the Address element in the Branch Addresses table entry that corresponds to your login's locations served. If your login does not have a locations served value, this element is blank. |
| Library_Name_C | The library name. | The Library Name file. |
| Patron_Alias_C | The patron's alias (if present in patron record). | The patron alias variable-length field in the patron record, as established by your library. Note that your library must have the Patron Alias feature enabled. |
| Patron_Email_C | The patron's email address. | The EMAIL ADDR variable-length field in the patron record. |
| Patron_Mobile_Number_C | The patron's mobile phone number. | The MOBILE PH variable-length field in the patron record. |
| Patron_Notice_Pref_C | The notification preference indicated by the patron. | The NOTICE PREF fixed-length field in the patron record. |
| Statistic_Group_C | The statistics group associated with the user who checked the item out. | The statistics group element of the login used to check out the item. |
| Statistic_Group_Desc_C | The name associated with the statistics group from the Statistic_Group_C element. | The Statistic Group Name element in the Statistical Group Maintenance table entry that corresponds to your login's statistics group. |
| Transaction_Reference_C | This element is no longer used. | n/a |
Text Elements
The following table describes each element in the data library that can be added to the body of the receipt, as well as the data source for each element.
| Element Name | Description | Data Source |
|---|---|---|
| Bill_Adjustment_Charge | On adjustment bills, the amount of the adjustment charge. | The patron's outstanding fines. |
| Bill_Amount | The total amount of the bill for a lost or unreturned item, including the item charge, processing fee, and billing fee. | The patron's outstanding fines. |
| Bill_Amount_Due | The amount remaining to be paid toward this fine, if partial payment has been collected. | The patron's outstanding fines. |
| Bill_Amount_Paid | The amount already paid toward this fine. | The patron's outstanding fines. |
| Bill_Billing_Fee | On bills for lost or unreturned items, the portion of the bill that comprises the billing fee. | The patron's outstanding fines. |
| Bill_Creation_Method | The fine creation method. | The patron's outstanding fines. |
| Bill_Charge_Type | The charge type. | The patron's outstanding fines. |
| Bill_Desc | On notices for manual charges, a description of the reason the fine was assessed. | The patron's outstanding fines. |
| Bill_GST_Charge | On bill and manual charge notices, the portion of the charge that comprises the General Sales Tax. | The patron's outstanding fines. |
| Bill_Invoice | The invoice number. | The patron's outstanding fines. |
| Bill_Item_Charge | On bills for unreturned items, the portion of the bill that comprises the item charge. | The patron's outstanding fines. |
| Bill_Item_Checked_Out_Date | The date and time the item was checked out. | The patron's outstanding fines. |
| Bill_Item_Date_Due | The item's due date. | The patron's outstanding fines. |
| Bill_Item_Loan | The number of the loan rule under which the fined item was checked out. | The patron's outstanding fines. |
| Bill_Item_Returned_Date | The date the item was returned. | The patron's outstanding fines. |
| Bill_Item_Title | The title or description of the fine. | The patron's outstanding fines. |
| Bill_Location | The charge location. | The patron's outstanding fines. |
| Bill_Lost_Charge | On bills for lost items, the portion of the bill that comprises the item charge. | The patron's outstanding fines. |
| Bill_Original_Patron_Name | For charges transferred from a patron to an organization, the name of the patron for whom the fine was originally assessed. | The PATRN NAME variable-length field in the fined patron's record. |
| Bill_Overdue_Charge | On fine notices for overdue items, the overdue amount. | The patron's outstanding fines. |
| Bill_Processing_Fee | On bills for lost or unreturned items, the portion of the bill that comprises the processing fee. | The patron's outstanding fines. |
| Bill_Rental_Charge | On fine notices for rental items, the rental charge. | The patron's outstanding fines. |
| Bill_Replacement_Charge | On bills for unreturned items, the portion of the bill that comprises the item charge. | The patron's outstanding fines. |
| Bill_Total_Amount1 | The sum of the bills and fines listed on the current notice. | The Sierra system. |
| Item_Agency | The agency that owns the item. | The AGENCY fixed-length field in the item record. |
| Item_Author | The title's author. | The AUTHOR variable-length field in the bibliographic record. |
| Item_Barcode | The item's barcode. | The BARCODE variable-length field in the item record. |
| Item_Bib_Record_Id | The title's record number. | The record number fixed-length field in the bibliographic record. |
| Item_Call_Number | The item's call number. | The CALL # variable-length field in the item record. |
| Item_Checked_Out_Date | The date and time the item was checked out. | The OUT DATE fixed-length field in the item record. |
| Item_Checked_Out_Location | The statistics group of the login used to check out the item. | The OUT LOC fixed-length field in the item record. |
| Item_Code1 | An item code, defined by your library. | The ICODE1 fixed-length field in the item record. |
| Item_Code2 | An item code, defined by your library. | The ICODE2 fixed-length field in the item record. |
| Item_Due_Date | The item's due date. | The DUE DATE fixed-length field in the item record. |
| Item_Edition | The edition information. | The MARC 250 field in the bibliographic record. |
| Item_ID | The ordinal number of this item in the list of items on this receipt. | The Sierra system. |
| Item_In_Location | The statistics group of the login at which the item was last checked in. | The IN LOC fixed-length field in the item record. |
| Item_Last_Checkin | The date the item was last checked in. | The LCHKIN fixed-length field in the item record. |
| Item_Location1 | The branch location code for the item. | The LOCATION fixed-length field in the item record. |
| Item_Material_Type | The title's material type. | The MAT TYPE fixed-length field in the bibliographic record. |
| Item_Message | A code corresponding to a library-defined item message. | The IMESSAGE fixed-length field in the item record. |
| Item_Note | The first note (the note most recently added) in the item record. | The INT NOTE variable-length field in the item record. |
| Item_OPAC_Message | A message defined by your library. | The OPACMSG fixed-length field in the item record. |
| Item_Publish_Date | The date the title was published. | The MARC 260 field in the bibliographic record. |
| Item_Publisher | Information about the publisher. | The MARC 260 field in the bibliographic record. |
| Item_Record_Id | The item record number. | The record number fixed-length field in the item record. |
| Item_Title | The item's title. | The TITLE variable-length field in the bibliographic record. |
| Item_Total_Checkout | The total number of times this item has been checked out. | The TOT CHKOUT fixed-length field in the item record. |
| Item_Type | The type of item, as defined by your library. | The I TYPE fixed-length field in the item record. |
| Item_Volume | The item's volume number. | The VOLUME variable-length field in the item record. |
| Patron_Address_Line11 | The first line of the patron's address. | The ADDRESS variable-length field in the patron record (the data before the first $ delimiter). |
| Patron_Address_Line21 | The second line of the patron's address. | The ADDRESS variable-length field in the patron record (the data after the first $ delimiter). |
| Patron_Address_Line31 | The third line of the patron's address. | The ADDRESS variable-length field in the patron record (the data after the second $ delimiter). |
| Patron_Address_Line41 | The fourth line of the patron's address. | The ADDRESS variable-length field in the patron record (the data after the third $ delimiter). |
| Patron_Agency1 | The agency to which the patron belongs. | The PAT AGENCY fixed-length field in the patron record. |
| Patron_Barcode1 | The patron's barcode. | The P BARCODE variable-length field in the patron record. |
| Patron_Checked_Out_Number1 | The total number of items the patron currently has checked out. | The CUR CHKOUT fixed-length field in the patron record. |
| Patron_Code11 | A fixed-length field in the patron record that your library can define. | The PCODE1 fixed-length field in the patron record. |
| Patron_Code21 | A fixed-length field in the patron record that your library can define. | The PCODE2 fixed-length field in the patron record. |
| Patron_Code31 | A fixed-length field in the patron record that your library can define. | The PCODE3 fixed-length field in the patron record. |
| Patron_Code41 | A fixed-length field in the patron record that your library can define. | The PCODE4 fixed-length field in the patron record. |
| Patron_Home_Library1 | The patron's home library. | The HOME LIBR fixed-length field in the patron record. |
| Patron_Message1 | A message for the patron. | The first MESSAGE variable-length field in the patron record. |
| Patron_Name1 | The patron's name, printed as last name, first name. | The PATRN NAME variable-length field in the patron record. |
| Patron_Phone_Number1 | The patron's primary telephone number. | The TELEPHONE variable-length field in the patron record. |
| Patron_Phone2_Number1 | An alternate telephone number for the patron. | The TELEPHONE2 variable-length field in the patron record. |
| Patron_Record_ID1 | The patron's record number. | The record number fixed-length field in the patron record. |
| Patron_Type1 | The Patron Type code associated with the patron. | The P TYPE fixed-length field in the patron record. |
1You can use this element as is in the body of the receipt, or you can use the corresponding header/footer element (appended with a "_C") in the receipt header or footer. Following is the complete list of elements that can be used in the body, header, and footer:
| Body Element Name | Corresponding Header or Footer Element Name |
|---|---|
| Bill_Total_Amount | Bill_Total_Amount_C |
| Item_Location | Item_Location_C |
| Patron_Address_Line1 | Patron_Address_Line1_C |
| Patron_Address_Line2 | Patron_Address_Line2_C |
| Patron_Address_Line3 | Patron_Address_Line3_C |
| Patron_Address_Line4 | Patron_Address_Line4_C |
| Patron_Agency | Patron_Agency_C |
| Patron_Barcode | Patron_Barcode_C |
| Patron_Checked_Out_Number | Patron_Checked_Out_Number_C |
| Patron_Code1 | Patron_Code1_C |
| Patron_Code2 | Patron_Code2_C |
| Patron_Code3 | Patron_Code3_C |
| Patron_Code4 | Patron_Code4_C |
| Patron_Home_Library | Patron_Home_Library_C |
| Patron_Message | Patron_Message_C |
| Patron_Name | Patron_Name_C |
| Patron_Phone_Number | Patron_Phone_Number_C |
| Patron_Phone2_Number | Patron_Phone2_Number_C |
| Patron_Record_ID | Patron_Record_ID_C |
| Patron_Type | Patron_Type_C |