foliolib.folio.api.finance.GroupFiscalYearSummaries

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

Bases: foliolib.folio.FolioApi

Group Fiscal Year Summary API

This documents the API calls that can be made to manage group-fiscal-year-summaries

Parameters

  • tenant (str) – Tenant id

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

Methods

get_groupFiscalYearSummaries(**kwargs)

Retrieve groupFiscalYearSummary item with given {groupFiscalYearSummaryId}
get_groupFiscalYearSummaries(**kwargs)

Retrieve groupFiscalYearSummary item with given {groupFiscalYearSummaryId}

GET /finance/group-fiscal-year-summaries

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 fund.ledgerId

Example

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

  • [“fund.ledgerId”, “6e2fbba3-d557-4480-bca3-b6f5c645de04”, “=”]

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": "A collection of group fiscal year summaries",
  "type": "object",
  "properties": {
    "groupFiscalYearSummaries": {
      "description": "The list of group fiscal year summaries",
      "type": "array",
      "items": {
        "$ref": "group_fiscal_year_summary.json"
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "groupFiscalYearSummaries",
    "totalRecords"
  ]
}