API Docs

External Sys Bursar Fines Fees List

Overview

Data Dictionary

Click here to download external_sys_bursar_fines_fees_list.xsd

userExportedFineFees

Description:

Field	Type	Description
exportNumber	string	Unique identifier of the export job. This number can be used to monitor the export job.
userExportedList	userExportedList	List of users and their fines/fees, to export to bursar system.

 

userExportedList

Description: List of users and their fines/fees, to export from to bursar system.

Field	Type	Description
userExportedFineFeesList	userExportedFineFeesList	Specific user and his fines/fees, to export to bursar system.

 

userExportedFineFeesList

Description: Specific user and his fines/fees, to export to bursar system.

Field	Type	Description
user	userIdentifier	Information about the user's identifier. This is the identifier that is used as a match identifer, as defined on the external interface profile.
patronName	string	The user's name, in the format defined in the 'DisplayUserName' mapping table (user management configuration menu - user detailds - user name display).
finefeeList	userFineFeesList	List of the user's fines/fees. The list includes only fines/fees that match the external interface profile.

 

userIdentifier

Description: Information about the user's identifier. This is the identifier that is used as a match identifer, as defined on the external interface profile.

Field	Type	Description
owneredEntity	owneredEntity	The institution number. Not relevant for userName identifier type.
type	string	The identifier type, as defined on the external interface profile. Possible codes are 'userName' or the codes listed in 'User Identifier Type' code table.
value	string	The identifier value. Note that the userName is case insensitive, while other identifier types are case sensitive.

 

userFineFeesList

Description: List of the user's fines/fees. The list includes only fines/fees that match the external interface profile.

Field	Type	Description
userFineFee	userFineFee	Specific user's fine/fee.

 

userFineFee

Description: Specific user's fine/fee.

Field	Type	Description
owneredEntity	owneredEntity	Information about the fine/fee's owning institution and library.
fineFeeType	fineFeeType	The type of fine/fee. Possible codes are listed in 'HFrUserFinesFees.fineFeeType' code table. The valid values for this parameter are controlled by the code-table: HFrUserFinesFees.fineFeeType. These are the currently defined values for your institution: Code Description
fineFeeComment	string	The fine/fee related comment.
compositeSum	compositeSum	The amount of the fine/fee.
itemTitle	string	Title of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemCallNumebr	string	Call number of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemLibrary	string	Library of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemLocation	string	External/Internal location of the fine/fee's related item. This field will hold the external location in case it was defined, otherwise it will hold the internal location. This is relevant only for item related fines/fees, for example: overdue fine.
itemInternalLocation	string	Internal location of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemDueDate	string	Due date of the fine/fee's related item. This is relevant only for loan related fines/fees, for example: overdue fine.
lastTransactionDate	string	The date of the last transaction that have been performed on the fine/fee. This might be the date part of the fine/fee was waived or restored etc.
itemBarcode	string	Barode of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
bursarTransactionId	string	The unique sequence used for the fine/fee identification when communicating with the Bursar system.

 

owneredEntity

Description: Owning institution/library information.

Field	Type	Description
InstitutionId	string	The number of the owning institution.
libraryId	string	The number of the owning library.
libraryCode	string	The code of the owning library.

 

compositeSum

Description: The amount of the fine/fee.

Field	Type	Description
sum	digitString	The fine/fee's sum to pay. This is the final sum (after calculating the waived sum, restored sum etc.).
vat	digitString	Currently not in use.
currency	string	This is the institution's default currency, as defined in the 'CurrencySubset' mapping table (Acquisition Configuration - General - Currency subset).

 

fineFeeType

fineFeeType is a xs:string with xs:restriction - see XSD for details.

digitString

digitString is a xs:string with xs:restriction - see XSD for details.

Samples

XML

JSON

__