foliolib.folio.api.financeStorage.BudgetExpenseClass

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

Bases: foliolib.folio.FolioApi

mod-finance-storage (Budget expense classes)

CRUD APIs used to manage budget-expense-class records.

Parameters

• tenant (str) – Tenant id

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

Methods

delete_budgetExpenseClass(budgetExpenseClassesId)	Delete budgetExpenseClass item with given {budgetExpenseClassId}
get_budgetExpenseClass(budgetExpenseClassesId)	Retrieve budgetExpenseClass item with given {budgetExpenseClassId}
get_budgetExpenseClasses(**kwargs)	Get list of budget-expense-classes
modify_budgetExpenseClass(...)	Update budgetExpenseClass item with given {budgetExpenseClassId}
set_budgetExpenseClass(budgetExpenseClass)	Create a new budgetExpenseClass item.

delete_budgetExpenseClass(budgetExpenseClassesId: str)

Delete budgetExpenseClass item with given {budgetExpenseClassId}

DELETE /finance-storage/budget-expense-classes/{budgetExpenseClassesId}

Parameters

budgetExpenseClassesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_budgetExpenseClass(budgetExpenseClassesId: str)

Retrieve budgetExpenseClass item with given {budgetExpenseClassId}

GET /finance-storage/budget-expense-classes/{budgetExpenseClassesId}

Parameters

budgetExpenseClassesId (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": "Budget expense class mapping schema",
  "type": "object",
  "extends": {
    "$ref": "../../common/schemas/entity.json"
  },
  "properties": {
    "id": {
      "description": "UUID of the expense class record",
      "type": "string",
      "$ref": "../../common/schemas/uuid.json"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "budgetId": {
      "description": "UUID of the budget record",
      "$ref": "../../common/schemas/uuid.json"
    },
    "expenseClassId": {
      "description": "UUID of the expense class record",
      "$ref": "../../common/schemas/uuid.json"
    },
    "status": {
      "description": "Status for expense class within the budget ",
      "type": "string",
      "enum": [
        "Active",
        "Inactive"
      ],
      "default": "Active"
    }
  },
  "additionalProperties": false,
  "required": [
    "budgetId",
    "expenseClassId"
  ]
}

get_budgetExpenseClasses(**kwargs)

Get list of budget-expense-classes

GET /finance-storage/budget-expense-classes

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: e.g.

  Example

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

  • [“name”, “Electronic”, “=”]

• 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 budget expense class records",
  "type": "object",
  "properties": {
    "budgetExpenseClasses": {
      "description": "The list of budget expense class objects contained in this collection",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "budget_expense_class.json"
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "budgetExpenseClasses",
    "totalRecords"
  ]
}

modify_budgetExpenseClass(budgetExpenseClassesId: str, budgetExpenseClass: dict)

Update budgetExpenseClass item with given {budgetExpenseClassId}

PUT /finance-storage/budget-expense-classes/{budgetExpenseClassesId}

Parameters

• budgetExpenseClassesId (str) –

• budgetExpenseClass (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": "Budget expense class mapping schema",
  "type": "object",
  "extends": {
    "$ref": "../../common/schemas/entity.json"
  },
  "properties": {
    "id": {
      "description": "UUID of the expense class record",
      "type": "string",
      "$ref": "../../common/schemas/uuid.json"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "budgetId": {
      "description": "UUID of the budget record",
      "$ref": "../../common/schemas/uuid.json"
    },
    "expenseClassId": {
      "description": "UUID of the expense class record",
      "$ref": "../../common/schemas/uuid.json"
    },
    "status": {
      "description": "Status for expense class within the budget ",
      "type": "string",
      "enum": [
        "Active",
        "Inactive"
      ],
      "default": "Active"
    }
  },
  "additionalProperties": false,
  "required": [
    "budgetId",
    "expenseClassId"
  ]
}

set_budgetExpenseClass(budgetExpenseClass: dict)

Create a new budgetExpenseClass item.

POST /finance-storage/budget-expense-classes

Parameters

budgetExpenseClass (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Headers

• Location - URI to the created budgetExpenseClass item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Budget expense class mapping schema",
  "type": "object",
  "extends": {
    "$ref": "../../common/schemas/entity.json"
  },
  "properties": {
    "id": {
      "description": "UUID of the expense class record",
      "type": "string",
      "$ref": "../../common/schemas/uuid.json"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "budgetId": {
      "description": "UUID of the budget record",
      "$ref": "../../common/schemas/uuid.json"
    },
    "expenseClassId": {
      "description": "UUID of the expense class record",
      "$ref": "../../common/schemas/uuid.json"
    },
    "status": {
      "description": "Status for expense class within the budget ",
      "type": "string",
      "enum": [
        "Active",
        "Inactive"
      ],
      "default": "Active"
    }
  },
  "additionalProperties": false,
  "required": [
    "budgetId",
    "expenseClassId"
  ]
}