foliolib.folio.api.finance.LedgerRolloverErrors

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

Bases: foliolib.folio.FolioApi

Rollover errors business API

API is used to manage rollover errors.

Parameters

• tenant (str) – Tenant id

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

Methods

delete_ledgerRolloversError(...)	Delete a ledger rollover error
get_ledgerRolloversErrors(**kwargs)	Get list of rollovers errors
set_ledgerRolloversError(ledgerRolloversError)	Create a new ledgerRolloversError item.

delete_ledgerRolloversError(ledgerRolloversErrorsId: str)

Delete a ledger rollover error

DELETE /finance/ledger-rollovers-errors/{ledgerRolloversErrorsId}

Parameters

ledgerRolloversErrorsId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

get_ledgerRolloversErrors(**kwargs)

Get list of rollovers errors

GET /finance/ledger-rollovers-errors

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: for example code

  Example

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

  • [“code”, “MEDGRANT”, “=”]

• totalRecords (str) –

  (default=auto) How to calculate the totalRecords property. “exact” for the correct number, “estimated” for an estimation, “auto” to automatically select “exact” or “estimated”, “none” for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

  Example

  • none

• 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

• OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of ledger fiscal year rollover errors",
  "type": "object",
  "properties": {
    "ledgerFiscalYearRolloverErrors": {
      "description": "The list of fiscal year rollover errors",
      "type": "array",
      "items": {
        "$ref": "ledger_fiscal_year_rollover_error.json"
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerFiscalYearRolloverErrors",
    "totalRecords"
  ]
}

set_ledgerRolloversError(ledgerRolloversError: dict)

Create a new ledgerRolloversError item.

POST /finance/ledger-rollovers-errors

Parameters

ledgerRolloversError (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Headers

• Location - URI to the created ledgerRolloversError item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Ledger fiscal year rollover error",
  "type": "object",
  "properties": {
    "id": {
      "description": "Id of ledger fiscal year rollover progress",
      "$ref": "../../common/schemas/uuid.json"
    },
    "ledgerRolloverId": {
      "description": "Ledger fiscal year rollover UUID",
      "$ref": "../../common/schemas/uuid.json"
    },
    "errorType": {
      "description": "Type of rollover error",
      "type": "string",
      "enum": [
        "Fund",
        "Order",
        "Order rollover",
        "Financial rollover",
        "Other"
      ]
    },
    "failedAction": {
      "description": "An action that failed during rollover",
      "type": "string"
    },
    "errorMessage": {
      "description": "Rollover error message",
      "type": "string"
    },
    "details": {
      "description": "Additional details about the rollover error",
      "existingJavaType": "java.util.Map<String, Object>",
      "type": "object"
    },
    "metadata": {
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true,
      "type": "object"
    }
  },
  "additionalProperties": false,
  "required": [
    "errorType",
    "errorMessage",
    "failedAction",
    "ledgerRolloverId"
  ]
}