API Docs

NAVIGATE CONTENT
Ex Libris Developer Network Alma Documentation REST APIs API Docs

Rest Fee

Overview


Fine/fee is a charge made for a user, for receiving library services.
Fine/fee might have related transactions, which indicate activities made on the fine/fee (such as payment, waiving etc.).

Data Dictionary

Click here to download rest_fee.xsd

fee

Description: Fee object

FieldTypeDescription
idstring
Identifier of the fee in Alma.
Should be used in subsequent queries regarding the fee.
Output parameter.
typestring with attr.
The fine / fee type. Mandatory.

The valid values for this parameter are controlled by the code-table: HFrUserFinesFees.fineFeeType. These are the currently defined values for your institution:
CodeDescription
statusstring with attr. The fine / fee status.
The valid values for this parameter are controlled by the code-table: HFrUserFinesFees.fineFeeStatus. These are the currently defined values for your institution:
CodeDescription
user_primary_idstring with attr. Primary ID of the charged user. Output parameter.
balancefloat
The fine / fee balance.
Output parameter.
remaining_vat_amountfloat
The fine / fee remaining vat amount.
Output parameter.
original_amountfloat
The fine / fee original amount. Mandatory for POST.
For type CREDIT it is retrieved as a negative number, but for POST the number should be positive.
original_vat_amountfloat
The fine / fee original vat amount.
Output parameter.
creation_timedateTimeDate the fine / fee was created.
status_timedateTimeDate the fine / fee was last changed.
commentstringFine / fee comment.
ownerstring with attr. The fine / fee owner. Mandatory for POST.
The valid values for this parameter are the library codes. These are the currently defined values for your institution:
CodeDescription
titlestringThe item title.
barcodestring with attr. The item barcode.
transactionstransactions
bursar_transaction_idstringThe unique sequence used for the fine/fee identification when communicating with the Bursar system.

 

transactions

Description: A list of transactions.

FieldTypeDescription
transactiontransactionTransaction Object.

 

transaction

Description: Transaction object

FieldTypeDescription
transaction_idstring
Identifier of the transaction in Alma.
typestring with attr. The fine / fee transaction type.
The valid values for this parameter are controlled by the code-table: FineFeeTransactionType. These are the currently defined values for your institution:
CodeDescription
amountfloatThe transaction amount.
vat_amountfloatThe transaction vat amount.
reasonstringThe reason for the transaction.
commentstringA note attached to the transaction.
created_bystringThe operator who last updated the transaction.
external_transaction_idstringThe transaction external ID.
transaction_timedateTimeDate and time of the transaction.
received_bystring with attr. The circulation desk in which the transaction was received.
Output parameter. If no circulation desk indicated in this field, it is indicated as Not at desk.
The valid values for this parameter are the circ_desk codes. These are the currently defined values for your institution:
CodeDescription
payment_methodstring with attr. The payment method of the transaction.
Output parameter.
The valid values for this parameter are controlled by the code-table: WorkbenchPaymentMethod. These are the currently defined values for your institution:
CodeDescription

 

Samples

XML
JSON
__