foliolib.folio.api.ordersStorage.PoLineNumber

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

Bases: foliolib.folio.FolioApi

Purchase Order Line Numbers

API used to manage Purchase Order Line numbers. This API is intended for internal use only

Parameters

  • tenant (str) – Tenant id

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

Methods

get_poLineNumbers(**kwargs)

Get purchase order line numbers
get_poLineNumbers(**kwargs)

Get purchase order line numbers

GET /orders-storage/po-line-number

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

  • purchaseOrderId (uuid) –

    Purchase Order Id

    Example

    • 8ad4b87b-9b47-4199-b0c3-5480745c6b41

  • poLineNumbers (int) –

    (default=1) Quantity of the PO line numbers

    Example

    • 1

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of sequence numbers",
  "type": "object",
  "properties": {
    "sequenceNumbers": {
      "description": "The list of sequence numbers",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}