Accounts version v1

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

Accounts bulk actions API

This documents the API calls for bulk actions against accounts

/accounts-bulk

post

Checks if the requested action is allowed

post

Checks if an action is allowed

Checks if an action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount to be validated"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount"
  ]
}

HTTP status code 200

Action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

post

Checks if the requested action is allowed

post

Checks if an action is allowed

Checks if an action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount to be validated"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount"
  ]
}

HTTP status code 200

Action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

post

Checks if the requested action is allowed

post

Checks if an action is allowed

Checks if an action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount to be validated"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount"
  ]
}

HTTP status code 200

Action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

post

Checks if the requested action is allowed

post

Checks if an action is allowed

Checks if an action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount to be validated"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount"
  ]
}

HTTP status code 200

Action is allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Accounts check response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Amount that validation was requested for"
    },
    "allowed": {
      "type": "boolean",
      "description": "Flag which indicates if validation is successful"
    },
    "remainingAmount": {
      "type": "string",
      "description": "Amount of fee/fine that will remain if the action is performed"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message which describes why validation failed"
    }
  },
  "additionalProperties": false,
  "required": [
    "amounts",
    "allowed"
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

post

Performs an action on multiple accounts

post

Perform an action

Perform an action

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Default action request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "comments": {
      "type": "string",
      "description": "Additional info for staff or patron. Format: [STAFF : staff comment \n PATRON : patron comment]"
    },
    "transactionInfo": {
      "type": "string",
      "description": "Additional transaction information, e.g. check number"
    },
    "notifyPatron": {
      "type": "boolean",
      "description": "Should send patron notification or not"
    },
    "servicePointId": {
      "type": "string",
      "description": "Unique ID of the service point where the payment was made",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "userName": {
      "type": "string",
      "description": "Name of the user that was logged in when the action was performed"
    },
    "paymentMethod": {
      "type": "string",
      "description": "Name of the payment method, e.g. `Cash` or `Credit card`"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "notifyPatron",
    "servicePointId",
    "userName",
    "paymentMethod"
  ]
}

HTTP status code 201

Action was performed successfully

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "feefineactions": {
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Fee/fine actions schema",
        "description": "Transactions or activities associated with a user fee/fine account",
        "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",
            "x-fqm-values": [
              {
                "value": "Paid partially",
                "label": "Paid partially"
              },
              {
                "value": "Paid fully",
                "label": "Paid fully"
              },
              {
                "value": "Waived partially",
                "label": "Waived partially"
              },
              {
                "value": "Waived fully",
                "label": "Waived fully"
              },
              {
                "value": "Transferred partially",
                "label": "Transferred partially"
              },
              {
                "value": "Transferred fully",
                "label": "Transferred fully"
              },
              {
                "value": "Refunded partially",
                "label": "Refunded partially"
              },
              {
                "value": "Refunded fully",
                "label": "Refunded fully"
              },
              {
                "value": "Credited partially",
                "label": "Credited partially"
              },
              {
                "value": "Credited fully",
                "label": "Credited fully"
              },
              {
                "value": "Cancelled as error",
                "label": "Cancelled as error"
              }
            ]
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "userId": {
            "description": "ID of the user",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "id": {
            "description": "Fine/fee action id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "accountId",
          "userId"
        ]
      },
      "description": "Fee/fine actions created during a bulk action"
    },
    "amount": {
      "type": "string",
      "description": "Action total amount"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "feefineactions",
    "amount"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "errorMessage": {
      "type": "string",
      "description": "Additional info about request processing failure"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "errorMessage"
  ]
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, please contact administrator

post

Performs an action on multiple accounts

post

Perform an action

Perform an action

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Default action request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "comments": {
      "type": "string",
      "description": "Additional info for staff or patron. Format: [STAFF : staff comment \n PATRON : patron comment]"
    },
    "transactionInfo": {
      "type": "string",
      "description": "Additional transaction information, e.g. check number"
    },
    "notifyPatron": {
      "type": "boolean",
      "description": "Should send patron notification or not"
    },
    "servicePointId": {
      "type": "string",
      "description": "Unique ID of the service point where the payment was made",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "userName": {
      "type": "string",
      "description": "Name of the user that was logged in when the action was performed"
    },
    "paymentMethod": {
      "type": "string",
      "description": "Name of the payment method, e.g. `Cash` or `Credit card`"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "notifyPatron",
    "servicePointId",
    "userName",
    "paymentMethod"
  ]
}

HTTP status code 201

Action was performed successfully

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "feefineactions": {
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Fee/fine actions schema",
        "description": "Transactions or activities associated with a user fee/fine account",
        "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",
            "x-fqm-values": [
              {
                "value": "Paid partially",
                "label": "Paid partially"
              },
              {
                "value": "Paid fully",
                "label": "Paid fully"
              },
              {
                "value": "Waived partially",
                "label": "Waived partially"
              },
              {
                "value": "Waived fully",
                "label": "Waived fully"
              },
              {
                "value": "Transferred partially",
                "label": "Transferred partially"
              },
              {
                "value": "Transferred fully",
                "label": "Transferred fully"
              },
              {
                "value": "Refunded partially",
                "label": "Refunded partially"
              },
              {
                "value": "Refunded fully",
                "label": "Refunded fully"
              },
              {
                "value": "Credited partially",
                "label": "Credited partially"
              },
              {
                "value": "Credited fully",
                "label": "Credited fully"
              },
              {
                "value": "Cancelled as error",
                "label": "Cancelled as error"
              }
            ]
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "userId": {
            "description": "ID of the user",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "id": {
            "description": "Fine/fee action id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "accountId",
          "userId"
        ]
      },
      "description": "Fee/fine actions created during a bulk action"
    },
    "amount": {
      "type": "string",
      "description": "Action total amount"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "feefineactions",
    "amount"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "errorMessage": {
      "type": "string",
      "description": "Additional info about request processing failure"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "errorMessage"
  ]
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, please contact administrator

post

Performs an action on multiple accounts

post

Perform an action

Perform an action

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Default action request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "comments": {
      "type": "string",
      "description": "Additional info for staff or patron. Format: [STAFF : staff comment \n PATRON : patron comment]"
    },
    "transactionInfo": {
      "type": "string",
      "description": "Additional transaction information, e.g. check number"
    },
    "notifyPatron": {
      "type": "boolean",
      "description": "Should send patron notification or not"
    },
    "servicePointId": {
      "type": "string",
      "description": "Unique ID of the service point where the payment was made",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "userName": {
      "type": "string",
      "description": "Name of the user that was logged in when the action was performed"
    },
    "paymentMethod": {
      "type": "string",
      "description": "Name of the payment method, e.g. `Cash` or `Credit card`"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "notifyPatron",
    "servicePointId",
    "userName",
    "paymentMethod"
  ]
}

HTTP status code 201

Action was performed successfully

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "feefineactions": {
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Fee/fine actions schema",
        "description": "Transactions or activities associated with a user fee/fine account",
        "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",
            "x-fqm-values": [
              {
                "value": "Paid partially",
                "label": "Paid partially"
              },
              {
                "value": "Paid fully",
                "label": "Paid fully"
              },
              {
                "value": "Waived partially",
                "label": "Waived partially"
              },
              {
                "value": "Waived fully",
                "label": "Waived fully"
              },
              {
                "value": "Transferred partially",
                "label": "Transferred partially"
              },
              {
                "value": "Transferred fully",
                "label": "Transferred fully"
              },
              {
                "value": "Refunded partially",
                "label": "Refunded partially"
              },
              {
                "value": "Refunded fully",
                "label": "Refunded fully"
              },
              {
                "value": "Credited partially",
                "label": "Credited partially"
              },
              {
                "value": "Credited fully",
                "label": "Credited fully"
              },
              {
                "value": "Cancelled as error",
                "label": "Cancelled as error"
              }
            ]
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "userId": {
            "description": "ID of the user",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "id": {
            "description": "Fine/fee action id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "accountId",
          "userId"
        ]
      },
      "description": "Fee/fine actions created during a bulk action"
    },
    "amount": {
      "type": "string",
      "description": "Action total amount"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "feefineactions",
    "amount"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "errorMessage": {
      "type": "string",
      "description": "Additional info about request processing failure"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "errorMessage"
  ]
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, please contact administrator

post

Performs an action on multiple accounts

post

Perform an action

Perform an action

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Default action request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "comments": {
      "type": "string",
      "description": "Additional info for staff or patron. Format: [STAFF : staff comment \n PATRON : patron comment]"
    },
    "transactionInfo": {
      "type": "string",
      "description": "Additional transaction information, e.g. check number"
    },
    "notifyPatron": {
      "type": "boolean",
      "description": "Should send patron notification or not"
    },
    "servicePointId": {
      "type": "string",
      "description": "Unique ID of the service point where the payment was made",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "userName": {
      "type": "string",
      "description": "Name of the user that was logged in when the action was performed"
    },
    "paymentMethod": {
      "type": "string",
      "description": "Name of the payment method, e.g. `Cash` or `Credit card`"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "notifyPatron",
    "servicePointId",
    "userName",
    "paymentMethod"
  ]
}

HTTP status code 201

Action was performed successfully

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "feefineactions": {
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Fee/fine actions schema",
        "description": "Transactions or activities associated with a user fee/fine account",
        "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",
            "x-fqm-values": [
              {
                "value": "Paid partially",
                "label": "Paid partially"
              },
              {
                "value": "Paid fully",
                "label": "Paid fully"
              },
              {
                "value": "Waived partially",
                "label": "Waived partially"
              },
              {
                "value": "Waived fully",
                "label": "Waived fully"
              },
              {
                "value": "Transferred partially",
                "label": "Transferred partially"
              },
              {
                "value": "Transferred fully",
                "label": "Transferred fully"
              },
              {
                "value": "Refunded partially",
                "label": "Refunded partially"
              },
              {
                "value": "Refunded fully",
                "label": "Refunded fully"
              },
              {
                "value": "Credited partially",
                "label": "Credited partially"
              },
              {
                "value": "Credited fully",
                "label": "Credited fully"
              },
              {
                "value": "Cancelled as error",
                "label": "Cancelled as error"
              }
            ]
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "userId": {
            "description": "ID of the user",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "id": {
            "description": "Fine/fee action id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "accountId",
          "userId"
        ]
      },
      "description": "Fee/fine actions created during a bulk action"
    },
    "amount": {
      "type": "string",
      "description": "Action total amount"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "feefineactions",
    "amount"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "errorMessage": {
      "type": "string",
      "description": "Additional info about request processing failure"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "errorMessage"
  ]
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, please contact administrator

post

Performs an action on multiple accounts

post

Perform an action

Perform an action

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Bulk cancel action request",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "comments": {
      "type": "string",
      "description": "Additional info for staff or patron. Format: [STAFF : staff comment \n PATRON : patron comment]"
    },
    "notifyPatron": {
      "type": "boolean",
      "description": "Should send patron notification or not"
    },
    "servicePointId": {
      "type": "string",
      "description": "Unique ID of the service point where the payment was made",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "userName": {
      "type": "string",
      "description": "Name of the user that was logged in when the action was performed"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "notifyPatron",
    "servicePointId",
    "userName",
    "comments"
  ]
}

HTTP status code 201

Action was performed successfully

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "feefineactions": {
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Fee/fine actions schema",
        "description": "Transactions or activities associated with a user fee/fine account",
        "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",
            "x-fqm-values": [
              {
                "value": "Paid partially",
                "label": "Paid partially"
              },
              {
                "value": "Paid fully",
                "label": "Paid fully"
              },
              {
                "value": "Waived partially",
                "label": "Waived partially"
              },
              {
                "value": "Waived fully",
                "label": "Waived fully"
              },
              {
                "value": "Transferred partially",
                "label": "Transferred partially"
              },
              {
                "value": "Transferred fully",
                "label": "Transferred fully"
              },
              {
                "value": "Refunded partially",
                "label": "Refunded partially"
              },
              {
                "value": "Refunded fully",
                "label": "Refunded fully"
              },
              {
                "value": "Credited partially",
                "label": "Credited partially"
              },
              {
                "value": "Credited fully",
                "label": "Credited fully"
              },
              {
                "value": "Cancelled as error",
                "label": "Cancelled as error"
              }
            ]
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "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",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "userId": {
            "description": "ID of the user",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "id": {
            "description": "Fine/fee action id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "accountId",
          "userId"
        ]
      },
      "description": "Fee/fine actions created during a bulk action"
    },
    "amount": {
      "type": "string",
      "description": "Action total amount"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "feefineactions",
    "amount"
  ]
}

HTTP status code 404

Fee/fine was not found

Body

Media type: text/plain

Type: any

Example:

Fee/fine was not found

HTTP status code 422

Action is not allowed

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Action response",
  "type": "object",
  "properties": {
    "accountIds": {
      "type": "array",
      "items": {
        "type": "string",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "uuid.schema",
        "description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
        "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      },
      "description": "IDs of multiple accounts"
    },
    "amount": {
      "type": "string",
      "description": "Action amount"
    },
    "errorMessage": {
      "type": "string",
      "description": "Additional info about request processing failure"
    }
  },
  "additionalProperties": false,
  "required": [
    "accountIds",
    "amount",
    "errorMessage"
  ]
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, please contact administrator