foliolib.folio.api.financeStorage.LedgerRolloverProgress

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

Bases: foliolib.folio.FolioApi

mod-finance-storage (Ledger Rollover Progress)

CRUD APIs used to manage ledger rollover progress.

Parameters

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

Methods

`delete_ledgerRolloversProgress`(...)	Delete ledgerRolloversProgress item with given {ledgerRolloversProgressId}
`get_ledgerRolloversProgress`(...)	Retrieve ledgerRolloversProgress item with given {ledgerRolloversProgressId}
`get_ledgerRolloversProgresses`(**kwargs)	Get list of rollovers progresses
`modify_ledgerRolloversProgress`(...)	Update ledgerRolloversProgress item with given {ledgerRolloversProgressId}
`set_ledgerRolloversProgress`(...)	Create a new ledgerRolloversProgress item.

delete_ledgerRolloversProgress(ledgerRolloversProgressId: str)

Delete ledgerRolloversProgress item with given {ledgerRolloversProgressId}

DELETE /finance-storage/ledger-rollovers-progress/{ledgerRolloversProgressId}

Parameters

ledgerRolloversProgressId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

get_ledgerRolloversProgress(ledgerRolloversProgressId: str)

Retrieve ledgerRolloversProgress item with given {ledgerRolloversProgressId}

GET /finance-storage/ledger-rollovers-progress/{ledgerRolloversProgressId}

Parameters

ledgerRolloversProgressId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Ledger fiscal year rollover progress",
  "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"
    },
    "overallRolloverStatus": {
      "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "budgetsClosingRolloverStatus": {
      "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "financialRolloverStatus": {
      "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "ordersRolloverStatus": {
      "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "metadata": {
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true,
      "type": "object"
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerRolloverId"
  ]
}

get_ledgerRolloversProgresses(**kwargs)

Get list of rollovers progresses

GET /finance-storage/ledger-rollovers-progress

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

Schema

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

modify_ledgerRolloversProgress(ledgerRolloversProgressId: str, ledgerRolloversProgress: dict)

Update ledgerRolloversProgress item with given {ledgerRolloversProgressId}

PUT /finance-storage/ledger-rollovers-progress/{ledgerRolloversProgressId}

Parameters

ledgerRolloversProgressId (str) –
ledgerRolloversProgress (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#",
  "description": "Ledger fiscal year rollover progress",
  "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"
    },
    "overallRolloverStatus": {
      "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "budgetsClosingRolloverStatus": {
      "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "financialRolloverStatus": {
      "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "ordersRolloverStatus": {
      "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "metadata": {
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true,
      "type": "object"
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerRolloverId"
  ]
}

set_ledgerRolloversProgress(ledgerRolloversProgress: dict)

Create a new ledgerRolloversProgress item.

POST /finance-storage/ledger-rollovers-progress

Parameters

ledgerRolloversProgress (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error

Headers

Location - URI to the created ledgerRolloversProgress item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Ledger fiscal year rollover progress",
  "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"
    },
    "overallRolloverStatus": {
      "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "budgetsClosingRolloverStatus": {
      "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "financialRolloverStatus": {
      "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "ordersRolloverStatus": {
      "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$ref": "../../mod-finance/schemas/rollover_status.json"
    },
    "metadata": {
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true,
      "type": "object"
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerRolloverId"
  ]
}