foliolib.folio.api.organizationsStorage.BankingAccounType

class foliolib.folio.api.organizationsStorage.BankingAccounType(tenant: str)

Bases: foliolib.folio.FolioApi

Banking account types

CRUD APIs used to manage banking account types.

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_bankingAccountType(bankingAccountTypesId)	Delete a banking account type by id
get_bankingAccountType(bankingAccountTypesId)	Retrieve bankingAccountType item with given {bankingAccountTypeId}
get_bankingAccountTypes(**kwargs)	Get a list of banking account types
modify_bankingAccountType(...)	Update a banking account type by id
set_bankingAccountType(bankingAccountType)	Create a banking account type

delete_bankingAccountType(bankingAccountTypesId: str)

Delete a banking account type by id

DELETE /organizations-storage/banking-account-types/{bankingAccountTypesId}

Parameters

bankingAccountTypesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

get_bankingAccountType(bankingAccountTypesId: str)

Retrieve bankingAccountType item with given {bankingAccountTypeId}

GET /organizations-storage/banking-account-types/{bankingAccountTypesId}

Parameters

bankingAccountTypesId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A banking account type",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this banking account type",
      "$ref": "../../common/schemas/uuid.json"
    },
    "name": {
      "description": "The name of this banking account type",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

get_bankingAccountTypes(**kwargs)

Get a list of banking account types

GET /organizations-storage/banking-account-types

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.

  CQL query

  Example

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

  • name=Personal

• 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

• OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of banking account type records",
  "type": "object",
  "properties": {
    "bankingAccountTypes": {
      "description": "The list of banking account types in this collection",
      "type": "array",
      "id": "bankingAccountTypes",
      "items": {
        "type": "object",
        "$ref": "banking_account_type.json"
      }
    },
    "totalRecords": {
      "description": "The number of banking account type records returned in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "bankingAccountTypes",
    "totalRecords"
  ]
}

modify_bankingAccountType(bankingAccountTypesId: str, bankingAccountType: dict)

Update a banking account type by id

PUT /organizations-storage/banking-account-types/{bankingAccountTypesId}

Parameters

• bankingAccountTypesId (str) –

• bankingAccountType (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A banking account type",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this banking account type",
      "$ref": "../../common/schemas/uuid.json"
    },
    "name": {
      "description": "The name of this banking account type",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

set_bankingAccountType(bankingAccountType: dict)

Create a banking account type

POST /organizations-storage/banking-account-types

Parameters

bankingAccountType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created bankingAccountType item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A banking account type",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this banking account type",
      "$ref": "../../common/schemas/uuid.json"
    },
    "name": {
      "description": "The name of this banking account type",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}