foliolib.folio.api.finance.LedgerRolloverLogs

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

Bases: foliolib.folio.FolioApi

mod-finance (Ledger Rollover Logs)

APIs used to manage ledger rollover logs.

Parameters

• tenant (str) – Tenant id

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

Methods

get_ledgerRolloversLog(ledgerRolloversLogsId)	Retrieve ledgerRolloversLog item with given {ledgerRolloversLogId}
get_ledgerRolloversLogs(**kwargs)	Get list of rollovers logs

get_ledgerRolloversLog(ledgerRolloversLogsId: str)

Retrieve ledgerRolloversLog item with given {ledgerRolloversLogId}

GET /finance/ledger-rollovers-logs/{ledgerRolloversLogsId}

Parameters

ledgerRolloversLogsId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Rollover log",
  "type": "object",
  "properties": {
    "ledgerRolloverId": {
      "description": "Ledger fiscal year rollover UUID",
      "$ref": "../../common/schemas/uuid.json",
      "readonly": true
    },
    "ledgerId": {
      "description": "Ledger UUID",
      "$ref": "../../common/schemas/uuid.json",
      "readonly": true
    },
    "startDate": {
      "description": "This is \"createdDate\" from rollover metadata. ",
      "type": "string",
      "format": "date-time",
      "readonly": true
    },
    "endDate": {
      "description": "This is \"updatedDate\" from rollover metadata. Should be provided only when \"status\" is \"Success\" or \"Error\".  ",
      "type": "string",
      "format": "date-time",
      "readonly": true
    },
    "rolloverStatus": {
      "description": "Final status of the rollover",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "ledgerRolloverType": {
      "description": "Type of rollover. Action Commit means run real rollover",
      "type": "object",
      "$ref": "../../mod-finance/schemas/ledger_rollover_type.json",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerRolloverId",
    "startDate",
    "rolloverStatus",
    "ledgerRolloverType"
  ]
}

get_ledgerRolloversLogs(**kwargs)

Get list of rollovers logs

GET /finance/ledger-rollovers-logs

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 ‘ledgerRolloverType’

  Example

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

  • [“ledgerRolloverType”, “Commit”, “=”]

• 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

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Contains a list of rollover runs",
  "type": "object",
  "properties": {
    "ledgerFiscalYearRolloverLogs": {
      "description": "The list of  rollover runs",
      "type": "array",
      "items": {
        "$ref": "ledger_fiscal_year_rollover_log.json"
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "logs",
    "totalRecords"
  ]
}