foliolib.folio.api.feesfines.FeefineReports

class foliolib.folio.api.feesfines.FeefineReports(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Fee/fine reports API

This documents the API calls for loading fee/fine reports

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`set_cashDrawerReconciliation`(...)	Return data for a refund cash drawer reconciliation report
`set_financialTransactionsDetail`(...)	Return data for a financial transactions detail report
`set_refund`(refund)	Return data for a refund report
`set_source`(source)	Return list of sources for a refund cash drawer reconciliation report

set_cashDrawerReconciliation(cashDrawerReconciliation: dict)

Return data for a refund cash drawer reconciliation report

POST /feefine-reports/cash-drawer-reconciliation

Parameters

cashDrawerReconciliation (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Cash drawer reconciliation report request",
  "description": "Represents a request for cash drawer reconciliation report",
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "description": "Start date for a refund report"
    },
    "endDate": {
      "type": "string",
      "description": "End date for a refund report"
    },
    "createdAt": {
      "type": "string",
      "description": "A globally unique (UUID) identifier for the service point",
      "$ref": "../raml-util/schemas/uuid.schema"
    },
    "sources": {
      "description": "List of sources (users that performed an activity)",
      "type": "array",
      "items": {
        "type": "string",
        "description": "Name of the source (user that performed an activity)"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "startDate",
    "createdAt"
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Cash drawer reconciliation report",
  "description": "Outputs data required for a cash drawer reconciliation report",
  "type": "object",
  "properties": {
    "reportData": {
      "description": "List of report entries",
      "type": "array",
      "id": "cashDrawerReconciliationReportData",
      "items": {
        "type": "object",
        "$ref": "cashDrawerReconciliationReportEntry.json"
      }
    },
    "reportStats": {
      "type": "object",
      "javaType": "org.folio.rest.jaxrs.model.CashDrawerReconciliationReportStats",
      "description": "Report statistics",
      "properties": {
        "bySource": {
          "description": "Totals by source",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byPaymentMethod": {
          "description": "Totals by payment method",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byFeeFineType": {
          "description": "Totals by fee/fine type",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byFeeFineOwner": {
          "description": "Totals by fee/fine owner",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        }
      }
    }
  }
}

set_financialTransactionsDetail(financialTransactionsDetail: dict)

Return data for a financial transactions detail report

POST /feefine-reports/financial-transactions-detail

Parameters

financialTransactionsDetail (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Financial transactions detail report request",
  "description": "Represents a request for financial transactions detail report",
  "type": "object",
  "properties": {
    "feeFineOwner": {
      "type": "string",
      "description": "A globally unique (UUID) identifier of fee/fine owner",
      "$ref": "../raml-util/schemas/uuid.schema"
    },
    "createdAt": {
      "description": "List of service point IDs",
      "type": "array",
      "items": {
        "type": "string",
        "description": "A globally unique (UUID) identifier for the service point",
        "$ref": "../raml-util/schemas/uuid.schema"
      }
    },
    "startDate": {
      "type": "string",
      "description": "Start date for filtering report entries"
    },
    "endDate": {
      "type": "string",
      "description": "End date for filtering report entries"
    }
  },
  "additionalProperties": false,
  "required": [
    "startDate",
    "feeFineOwner"
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Financial transactions detail report",
  "description": "Outputs data required for a financial transactions detail report",
  "type": "object",
  "properties": {
    "reportData": {
      "description": "List of report entries",
      "type": "array",
      "id": "FinancialTransactionsDetailReportData",
      "items": {
        "type": "object",
        "$ref": "financialTransactionsDetailReportEntry.json"
      }
    },
    "reportStats": {
      "type": "object",
      "javaType": "org.folio.rest.jaxrs.model.FinancialTransactionsDetailReportStats",
      "description": "Report statistics",
      "properties": {
        "byFeeFineOwner": {
          "description": "Totals by fee/fine owner",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byFeeFineType": {
          "description": "Totals by fee/fine type",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byAction": {
          "description": "Totals by action",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byPaymentMethod": {
          "description": "Totals by payment method",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byWaiveReason": {
          "description": "Totals by waive reason",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byRefundReason": {
          "description": "Totals by refund reason",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        },
        "byTransferAccount": {
          "description": "Totals by transfer account",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "reportTotalsEntry.json"
          }
        }
      }
    }
  }
}

set_refund(refund: dict)

Return data for a refund report

POST /feefine-reports/refund

Parameters

refund (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Refund report request",
  "description": "Represents a request of refund report",
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "description": "Start date for a refund report"
    },
    "endDate": {
      "type": "string",
      "description": "End date for a refund report"
    },
    "feeFineOwners": {
      "description": "List of fee/fine owners ids",
      "type": "array",
      "items": {
        "type": "string",
        "description": "A globally unique (UUID) identifier for the owner",
        "$ref": "../raml-util/schemas/uuid.schema"
      }
    }
  },
  "additionalProperties": false
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Refund report",
  "description": "Outputs data required for a refund report",
  "type": "object",
  "properties": {
    "reportData": {
      "description": "List of report entries",
      "type": "array",
      "id": "refundReportData",
      "items": {
        "type": "object",
        "$ref": "refundReportEntry.json"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "reportData"
  ]
}

set_source(source: dict)

Return list of sources for a refund cash drawer reconciliation report

POST /feefine-reports/cash-drawer-reconciliation/sources

Parameters

source (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Cash drawer reconciliation report sources request",
  "description": "Represents a request for fetching sources (users that performed activities) required for cash drawer reconciliation report",
  "type": "object",
  "properties": {
    "createdAt": {
      "type": "string",
      "description": "A globally unique (UUID) identifier for the service point",
      "$ref": "../raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "createdAt"
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Cash drawer reconciliation report sources",
  "description": "Outputs sources (users that performed activities) required for a cash drawer reconciliation report",
  "type": "object",
  "properties": {
    "sources": {
      "description": "List of sources (users that performed activities)",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}