API Docs

__METHOD= GET . __PATH= /almaws/v1/conf/utilities/fee-transactions .

Retrieve Fine Fee Report

This API returns a fine and fee report.

Resource URL

GET /almaws/v1/conf/utilities/fee-transactions

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
limitxs:intOptional. Default: 10Limits the number of fees not transactions. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
transaction_from_datexs:stringOptional. Default: todayFrom this Date (YYYY-MM-DD). Defaults to today.
transaction_to_datexs:stringOptional.To this Date (YYYY-MM-DD). Defaults to from date. Limit of 7 days period.
transaction_typexs:stringOptional. Default: BOTHAdd fine fee transaction type filter. This defaults to both payment and waived.
ownerxs:stringOptional.Add fine owner filter. This is a library or the institution code.
received_by_circ_libraryxs:stringOptional.Add circulation library filter. May be used in conjunction with received_by_circ_desk to filter results.
received_by_circ_deskxs:stringOptional.Add circulation desk filter. Must be used in conjunction with received_by_circ_library to filter results.

Body Parameters

None

Output

This method returns a Fees object. See doc

Possible Error Codes

CodeMessage
402119General error.
40166411An error has occurred in setting from and/or to dates.
40166419An error has occurred in setting transaction type.
40166410An error has occurred in setting circ library or circ desk.