foliolib.folio.api.orders.PoNumber

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

Bases: foliolib.folio.FolioApi

Orders Business Logic API

API for managing PO numbers

Parameters

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

Methods

`get_poNumbers`()	Get generated PO number
`set_validate`(validate)	validate if the PO Number is unique and matches the pattern specified

get_poNumbers()

Get generated PO number

GET /orders/po-number

Returns: See Schema below
Return type: dict
Raises: OkapiRequestUnprocessableEntity – Unprocessable Entity

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_validate(validate: dict)

validate if the PO Number is unique and matches the pattern specified

POST /orders/po-number/validate

Parameters

validate (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Generated PO number object",
  "type": "object",
  "properties": {
    "poNumber": {
      "description": "A human readable generated or manually entered ID assigned to the purchase order",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{1,16}$"
    }
  },
  "required": [
    "poNumber"
  ],
  "additionalProperties": false
}