API Docs

External Sys Bursar Fines Fees List

Overview

Data Dictionary

Click here to download external_sys_bursar_fines_fees_list.xsd

userExportedFineFees

Description:

FieldTypeDescription
exportNumberstringUnique identifier of the export job. This number can be used to monitor the export job.
userExportedListuserExportedListList 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
userExportedFineFeesListuserExportedFineFeesListSpecific user and his fines/fees, to export to bursar system.

 

userExportedFineFeesList

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

FieldTypeDescription
useruserIdentifierInformation about the user's identifier. This is the identifier that is used as a match identifer, as defined on the external interface profile.
patronNamestringThe user's name, in the format defined in the 'DisplayUserName' mapping table (user management configuration menu - user detailds - user name display).
finefeeListuserFineFeesListList 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
owneredEntityowneredEntityThe institution number. Not relevant for userName identifier type.
typestringThe identifier type, as defined on the external interface profile. Possible codes are 'userName' or the codes listed in 'User Identifier Type' code table.
valuestringThe 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
userFineFeeuserFineFeeSpecific user's fine/fee.

 

userFineFee

Description: Specific user's fine/fee.

FieldTypeDescription
owneredEntityowneredEntityInformation about the fine/fee's owning institution and library.
fineFeeTypefineFeeTypeThe 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
fineFeeCommentstringThe fine/fee related comment.
compositeSumcompositeSumThe amount of the fine/fee.
itemTitlestringTitle of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemCallNumebrstringCall number of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemLibrarystringLibrary of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemLocationstringExternal/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.
itemInternalLocationstringInternal location of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
itemDueDatestringDue date of the fine/fee's related item. This is relevant only for loan related fines/fees, for example: overdue fine.
lastTransactionDatestringThe 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.
itemBarcodestringBarode of the fine/fee's related item. This is relevant only for item related fines/fees, for example: overdue fine.
bursarTransactionIdstringThe unique sequence used for the fine/fee identification when communicating with the Bursar system.

 

owneredEntity

Description: Owning institution/library information.

FieldTypeDescription
InstitutionIdstringThe number of the owning institution.
libraryIdstringThe number of the owning library.
libraryCodestringThe code of the owning library.

 

compositeSum

Description: The amount of the fine/fee.

FieldTypeDescription
sumdigitStringThe fine/fee's sum to pay. This is the final sum (after calculating the waived sum, restored sum etc.).
vatdigitStringCurrently not in use.
currencystringThis is the institution's default currency, as defined in the 'CurrencySubset' mapping table (Acquisition Configuration - General - Currency subset).

 

fineFeeType
fineFeeTypeis a xs:string with xs:restriction - see XSD for details.
digitString
digitStringis a xs:string with xs:restriction - see XSD for details.

Samples

XML
JSON
__