Ready to Learn?Ex Libris products all provide open APIs

Overview

Data Dictionary

Click here to download external_sys_bursar_fines_fees_list.xsd
xml-fragment
Description:
FieldTypeDescription
userExportedFineFeesuserExportedFineFees
userExportedFineFees
Description:
FieldTypeDescription
exportNumberstring Unique identifier of the export job. This number can be used to monitor the export job.
userExportedListuserExportedList 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.
FieldTypeDescription
userExportedFineFeesListuserExportedFineFeesList Specific user and his fines/fees, to export to bursar system.
userExportedFineFeesList
Description: Specific user and his fines/fees, to export to bursar system.
FieldTypeDescription
useruserIdentifier Information about the user's identifier. This is the identifier that is used as a match identifer, as defined on the external interface profile.
patronNamestring The user's name, in the format defined in the 'DisplayUserName' mapping table (user management configuration menu - user detailds - user name display).
finefeeListuserFineFeesList 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.
FieldTypeDescription
owneredEntityowneredEntity The institution number. Not relevant for userName identifier type.
typestring The identifier type, as defined on the external interface profile. Possible codes are 'userName' or the codes listed in 'User Identifier Type' code table.
valuestring 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.
FieldTypeDescription
userFineFeeuserFineFee Specific user's fine/fee.
userFineFee
Description: Specific user's fine/fee.
FieldTypeDescription
owneredEntityowneredEntity Information about the fine/fee's owning institution and library.
fineFeeTypefineFeeType 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:
CodeDescription
HFrUserFinesFees.fineFeeType
fineFeeCommentstring The fine/fee related comment.
compositeSumcompositeSum The amount of the fine/fee.
itemTitlestring Title of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemCallNumebrstring Call number of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemLibrarystring Library of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemLocationstring 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.
itemInternalLocationstring Internal location of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemDueDatestring Due date of the fine/fee's related item. This is relevant only for loan related fines/fees, for example: overdue fine.
lastTransactionDatestring 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.
itemBarcodestring Barode of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
bursarTransactionIdstring The unique sequence used for the fine/fee identification when communicating with the Bursar system.
owneredEntity
Description: Owning institution/library information.
FieldTypeDescription
InstitutionIdstring The number of the owning institution.
libraryIdstring The number of the owning library.
libraryCodestring The code of the owning library.
compositeSum
Description: The amount of the fine/fee.
FieldTypeDescription
sumdigitString The fine/fee's sum to pay. This is the final sum (after calculating the waived sum, restored sum etc.).
vatdigitString Currently not in use.
currencystring 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

__