foliolib.folio.api.invoiceStorage.VoucherNumber

class foliolib.folio.api.invoiceStorage.VoucherNumber(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Voucher Number

API used to manage voucher number.

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`get_starts`()	Get voucher number start
`get_voucherNumbers`()	Get generated voucher number
`set_start`(value)	(Re)set the start value of the voucher number sequence

get_starts()

Get voucher number start

GET /voucher-storage/voucher-number/start

Returns: See Schema below
Return type: dict
Raises: OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Sequence number object",
  "type": "object",
  "properties": {
    "sequenceNumber": {
      "description": "Sequence number",
      "type": "string"
    }
  },
  "required": [
    "sequenceNumber"
  ],
  "additionalProperties": false
}

get_voucherNumbers()

Get generated voucher number

GET /voucher-storage/voucher-number

Returns: See Schema below
Return type: dict
Raises: OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Sequence number object",
  "type": "object",
  "properties": {
    "sequenceNumber": {
      "description": "Sequence number",
      "type": "string"
    }
  },
  "required": [
    "sequenceNumber"
  ],
  "additionalProperties": false
}

set_start(value: str)

(Re)set the start value of the voucher number sequence

POST /voucher-storage/voucher-number/start/{value}

Parameters

value (str) –

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error