API Docs
Retrieve Fine Fee Report
Contents
This API returns a fine and fee report.
Resource URL
GET /almaws/v1/conf/utilities/fee-transactions
API Description
URL Parameters
None
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
limit | xs:int | Optional. Default: 10 | Limits the number of fees not transactions. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
transaction_from_date | xs:string | Optional. Default: today | From this Date (YYYY-MM-DD). Defaults to today. |
transaction_to_date | xs:string | Optional. | To this Date (YYYY-MM-DD). Defaults to from date. Limit of 7 days period. |
transaction_type | xs:string | Optional. Default: BOTH | Add fine fee transaction type filter. This defaults to both payment and waived. |
owner | xs:string | Optional. | Add fine owner filter. This is a library or the institution code. |
received_by_circ_library | xs:string | Optional. | Add circulation library filter. May be used in conjunction with received_by_circ_desk to filter results. |
received_by_circ_desk | xs:string | Optional. | 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
Code | Message |
---|---|
402119 | General error. |
40166411 | An error has occurred in setting from and/or to dates. |
40166419 | An error has occurred in setting transaction type. |
40166410 | An error has occurred in setting circ library or circ desk. |