foliolib.folio.api.finance.FinanceFundCodesExpenseClasses

class foliolib.folio.api.finance.FinanceFundCodesExpenseClasses(tenant: str)

Bases: foliolib.folio.FolioApi

API for retrieving combination of fund code and expense classes

Return collection of the pairs <fund code, expense classes>

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

get_fundCodesExpenseClasses(**kwargs)

Retrieve a list of fundCodesExpenseClass items.

get_fundCodesExpenseClasses(**kwargs)

Retrieve a list of fundCodesExpenseClass items.

GET /finance/fund-codes-expense-classes

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• 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

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "List of combinations of Fund Code and Expense class code.",
  "type": "object",
  "properties": {
    "delimiter": {
      "description": "Special character to separate Fund Code and Expense class code.",
      "type": "string"
    },
    "fundCodeVsExpClassesTypes": {
      "description": "Pairs of the fund code and expense classes.",
      "type": "array",
      "items": {
        "$ref": "fund_code_vs_expense_classes_type.json"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "delimiter",
    "fundCodeVsExpClassesTypes"
  ]
}