foliolib.folio.api.feesfines.Feefineactions

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

Bases: foliolib.folio.FolioApi

Fee Fine Actions API

This documents the API calls that can be made to query and manage feefine of the system

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

delete_feefineaction(feefineactionId)	Delete feefineaction item with given {feefineactionId}
get_feefineaction(feefineactionId)	Get a single feefineaction
get_feefineactions(**kwargs)	Return a list of feefineactions
modify_feefineaction(feefineactionId, ...)	Update feefineaction item with given {feefineactionId}
set_feefineaction(feefineaction)	Create a feefineaction

delete_feefineaction(feefineactionId: str)

Delete feefineaction item with given {feefineactionId}

DELETE /feefineactions/{feefineactionId}

Parameters

feefineactionId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_feefineaction(feefineactionId: str)

Get a single feefineaction

GET /feefineactions/{feefineactionId}

Parameters

feefineactionId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Fee/fine actions schema",
  "description": "Transactions or activities associated with a user fee/fine account",
  "type": "object",
  "properties": {
    "dateAction": {
      "description": "Date and time the transaction of the fine/fee was created",
      "type": "string",
      "format": "date-time"
    },
    "typeAction": {
      "description": "Type of activity including the type of transaction",
      "type": "string"
    },
    "comments": {
      "description": "Additional information entered as part of the activity or on this screen as a 'Staff info only' activity",
      "type": "string"
    },
    "notify": {
      "description": "A flag to determine if a patron should be notified or not",
      "type": "boolean"
    },
    "amountAction": {
      "description": "Amount of activity",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "balance": {
      "description": "Calculated amount of remaining balance based on original fee/fine and what has been paid/waived/transferred/refunded",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "transactionInformation": {
      "description": "Number or other transaction id related to payment",
      "type": "string"
    },
    "createdAt": {
      "description": "ID of the service point where the action was created",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "originalCreatedAt": {
      "description": "Original invalid (non-UUID) value of 'createdAt' moved here when UUID-validation was enabled for 'createdAt'",
      "type": "string"
    },
    "source": {
      "description": "Person who processed activity (from login information)",
      "type": "string"
    },
    "paymentMethod": {
      "description": "Overall status of the action-setting",
      "type": "string"
    },
    "accountId": {
      "description": "ID of the accounts",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "userId": {
      "description": "ID of the user",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "id": {
      "description": "Fine/fee action id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountId",
    "userId"
  ]
}

get_feefineactions(**kwargs)

Return a list of feefineactions

GET /feefineactions

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• query (str) –

  A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

  with valid searchable fields

  Example

  • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

  • active=true

• orderBy (str) – Order by field: field A, field B

• order (str (desc|asc) – ): (default=desc) Order

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of feefineactions",
  "type": "object",
  "properties": {
    "feefineactions": {
      "description": "List of feefineaction items",
      "type": "array",
      "id": "feefineactionsData",
      "items": {
        "type": "object",
        "$ref": "feefineactiondata.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "feefineactions",
    "totalRecords"
  ]
}

modify_feefineaction(feefineactionId: str, feefineaction: dict)

Update feefineaction item with given {feefineactionId}

PUT /feefineactions/{feefineactionId}

Parameters

• feefineactionId (str) –

• feefineaction (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Fee/fine actions schema",
  "description": "Transactions or activities associated with a user fee/fine account",
  "type": "object",
  "properties": {
    "dateAction": {
      "description": "Date and time the transaction of the fine/fee was created",
      "type": "string",
      "format": "date-time"
    },
    "typeAction": {
      "description": "Type of activity including the type of transaction",
      "type": "string"
    },
    "comments": {
      "description": "Additional information entered as part of the activity or on this screen as a 'Staff info only' activity",
      "type": "string"
    },
    "notify": {
      "description": "A flag to determine if a patron should be notified or not",
      "type": "boolean"
    },
    "amountAction": {
      "description": "Amount of activity",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "balance": {
      "description": "Calculated amount of remaining balance based on original fee/fine and what has been paid/waived/transferred/refunded",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "transactionInformation": {
      "description": "Number or other transaction id related to payment",
      "type": "string"
    },
    "createdAt": {
      "description": "ID of the service point where the action was created",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "originalCreatedAt": {
      "description": "Original invalid (non-UUID) value of 'createdAt' moved here when UUID-validation was enabled for 'createdAt'",
      "type": "string"
    },
    "source": {
      "description": "Person who processed activity (from login information)",
      "type": "string"
    },
    "paymentMethod": {
      "description": "Overall status of the action-setting",
      "type": "string"
    },
    "accountId": {
      "description": "ID of the accounts",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "userId": {
      "description": "ID of the user",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "id": {
      "description": "Fine/fee action id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountId",
    "userId"
  ]
}

set_feefineaction(feefineaction: dict)

Create a feefineaction

POST /feefineactions

Parameters

feefineaction (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created feefineaction item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Fee/fine actions schema",
  "description": "Transactions or activities associated with a user fee/fine account",
  "type": "object",
  "properties": {
    "dateAction": {
      "description": "Date and time the transaction of the fine/fee was created",
      "type": "string",
      "format": "date-time"
    },
    "typeAction": {
      "description": "Type of activity including the type of transaction",
      "type": "string"
    },
    "comments": {
      "description": "Additional information entered as part of the activity or on this screen as a 'Staff info only' activity",
      "type": "string"
    },
    "notify": {
      "description": "A flag to determine if a patron should be notified or not",
      "type": "boolean"
    },
    "amountAction": {
      "description": "Amount of activity",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "balance": {
      "description": "Calculated amount of remaining balance based on original fee/fine and what has been paid/waived/transferred/refunded",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "transactionInformation": {
      "description": "Number or other transaction id related to payment",
      "type": "string"
    },
    "createdAt": {
      "description": "ID of the service point where the action was created",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "originalCreatedAt": {
      "description": "Original invalid (non-UUID) value of 'createdAt' moved here when UUID-validation was enabled for 'createdAt'",
      "type": "string"
    },
    "source": {
      "description": "Person who processed activity (from login information)",
      "type": "string"
    },
    "paymentMethod": {
      "description": "Overall status of the action-setting",
      "type": "string"
    },
    "accountId": {
      "description": "ID of the accounts",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "userId": {
      "description": "ID of the user",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "id": {
      "description": "Fine/fee action id, UUID",
      "$ref": "raml-util/schemas/uuid.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountId",
    "userId"
  ]
}