Fee/fine reports (v1.0)

http://github.com/org/folio/mod-feesfines

Table of contents

Fee/fine reports API

This documents the API calls for loading fee/fine reports

/feefine-reports

GET /feefine-reports/refund

Return data for a refund report

GET /feefine-reports/refund
Query Parameters
  • startDate: required (string)

    Start date for a refund report

    Example:

    2020-01-01
  • endDate: required (string)

    End date for a refund report

    Example:

    2020-12-31

Response 200

Body

Media type: application/json

Example:

{
  "reportData": [
    {
      "patronName": "Last, First Middle",
      "patronBarcode": "236964750970123",
      "patronId": "2a424823-588a-45ee-9441-a6384b6614b2",
      "patronGroup": "undergrad",
      "feeFineType": "test-ff-type",
      "billedAmount": "100.00",
      "dateBilled": "12/7/2020 0:13 PM",
      "paidAmount": "70.00",
      "paymentMethod": "test-payment-method",
      "transactionInfo": "test-transaction-info",
      "transferredAmount": "0.00",
      "transferAccount": "",
      "feeFineId": "4f7a5802-fc0d-4122-a3b8-4d9d6f91c922",
      "refundDate": "12/7/2020 0:14 PM",
      "refundAmount": "30.00",
      "refundAction": "Refunded partially",
      "refundReason": "test-refund-reason",
      "staffInfo": "Partial refund - info for staff",
      "itemBarcode": "90000",
      "instance": "A semantic web primer",
      "actionCompletionDate": "",
      "staffMemberName": "",
      "actionTaken": ""
    }
  ]
}

Response 400

Invalid query parameters

Body

Media type: text/plain

Type: any

Example:

Invalid startDate or endDate parameter

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error