foliolib.folio.api.invoice.BatchGroup

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

Bases: foliolib.folio.FolioApi

Batch group API

This documents the API calls that can be made to manage batch groups

Parameters

• tenant (str) – Tenant id

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

Methods

delete_batchGroup(batchGroupsId)	Delete a batch-group with given {id}
get_batchGroup(batchGroupsId)	Return a batch-group with given {id}
get_batchGroups(**kwargs)	Retrieve a list of batchGroup items.
modify_batchGroup(batchGroupsId, batchGroup)	Update batch-group.
set_batchGroup(batchGroup)	Post a batch group.

delete_batchGroup(batchGroupsId: str)

Delete a batch-group with given {id}

DELETE /batch-groups/{batchGroupsId}

Parameters

batchGroupsId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_batchGroup(batchGroupsId: str)

Return a batch-group with given {id}

GET /batch-groups/{batchGroupsId}

Parameters

batchGroupsId (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": "Simple controlled vocabulary for batch groups",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of batch group",
      "$ref": "../../common/schemas/uuid.json"
    },
    "name": {
      "description": "Name of batch group",
      "type": "string"
    },
    "description": {
      "description": "Free-form description for this batch group",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

get_batchGroups(**kwargs)

Retrieve a list of batchGroup items.

GET /batch-groups

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

• 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.

  using CQL (indexes for batch group)

  Example

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

  • name==”FOLIO”

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of batch groups",
  "type": "object",
  "properties": {
    "batchGroups": {
      "description": "an array of batch group records",
      "id": "batchGroups",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "batch_group.json"
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "batchGroups",
    "totalRecords"
  ]
}

modify_batchGroup(batchGroupsId: str, batchGroup: dict)

Update batch-group.

PUT /batch-groups/{batchGroupsId}

Parameters

• batchGroupsId (str) –

• batchGroup (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Simple controlled vocabulary for batch groups",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of batch group",
      "$ref": "../../common/schemas/uuid.json"
    },
    "name": {
      "description": "Name of batch group",
      "type": "string"
    },
    "description": {
      "description": "Free-form description for this batch group",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

set_batchGroup(batchGroup: dict)

Post a batch group.

POST /batch-groups

Parameters

batchGroup (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created batchGroup item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Simple controlled vocabulary for batch groups",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of batch group",
      "$ref": "../../common/schemas/uuid.json"
    },
    "name": {
      "description": "Name of batch group",
      "type": "string"
    },
    "description": {
      "description": "Free-form description for this batch group",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}