Wrapper Pieces version v4
https://github.com/folio-org/mod-orders-storage
Wrapper Pieces
Read API to manage Wrapper Pieces.
/orders-storage/wrapper-pieces
Entity representing a wrapper-piece
get
Get list of Wrapper Pieces
get /orders-storage/wrapper-pieces
Get list of Wrapper Pieces
Query Parameters
- query: (string)
A query expressed as a CQL string (see 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.
with valid searchable fields: for example code
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode ["code", "MEDGRANT", "="] - totalRecords: (string - default: auto - pattern: exact|estimated|none|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: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
10
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of Wrapper Piece records",
"type": "object",
"properties": {
"wrapperPieces": {
"description": "Collection of Wrapper Piece records",
"type": "array",
"id": "wrapperPieces",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wrapper Piece details",
"javaName": "WrapperPiece",
"properties": {
"vendorId": {
"description": "UUID of the vendor id this record is associated with",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"piece": {
"description": "Piece details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaName": "Piece",
"properties": {
"id": {
"description": "UUID of this piece record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"displaySummary": {
"description": "Display summary information",
"type": "string"
},
"comment": {
"description": "Free form commentary",
"type": "string"
},
"format": {
"description": "The format of the piece",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Physical",
"Electronic",
"Other"
]
},
"itemId": {
"description": "UUID of the associated item record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"bindItemId": {
"description": "UUID of the associated bind item record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"bindItemTenantId": {
"description": "Bind item tenant for ECS-enabled clusters",
"type": "string"
},
"locationId": {
"description": "UUID of the (inventory) location record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"poLineId": {
"description": "UUID of the purchase order line this record is associated with",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"titleId": {
"description": "UUID of the title record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingId": {
"description": "UUID of the holding record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"receivingTenantId": {
"description": "Receiving tenant for ECS-enabled clusters",
"type": "string"
},
"displayOnHolding": {
"description": "Whether or not receiving history should be displayed in holding record view",
"type": "boolean",
"default": false
},
"displayToPublic": {
"description": "Whether or not the piece data should display to patrons at point of receipt",
"type": "boolean",
"default": false
},
"enumeration": {
"type": "string",
"description": "Enumeration is the descriptive information for the numbering scheme of a serial. Synchronized with inventory item."
},
"chronology": {
"type": "string",
"description": "Chronology is the descriptive information for the dating scheme of a serial. Synchronized with inventory item."
},
"barcode": {
"type": "string",
"description": "Barcode is the descriptive information for the barcode of a serial. Synchronized with inventory item."
},
"accessionNumber": {
"type": "string",
"description": "AccessionNumber is the descriptive information for the accession number of a serial. Synchronized with inventory item."
},
"callNumber": {
"type": "string",
"description": "CallNumber is the descriptive information for the call number of a serial. Synchronized with inventory item."
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"copyNumber": {
"type": "string",
"description": "Copy number of the piece"
},
"receivingStatus": {
"description": "The status of this piece",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaName": "ReceivingStatus",
"type": "string",
"enum": [
"Received",
"Expected",
"Late",
"Claim delayed",
"Claim sent",
"Unreceivable"
],
"default": "Expected"
},
"supplement": {
"description": "Whether or not this is supplementary material",
"type": "boolean"
},
"isBound": {
"description": "Whether or not piece has already been bound",
"type": "boolean",
"default": false
},
"receiptDate": {
"description": "Date that associated item is expected to arrive",
"type": "string",
"format": "date-time"
},
"receivedDate": {
"description": "The date associated item is actually received",
"type": "string",
"format": "date-time"
},
"statusUpdatedDate": {
"description": "Date when the status of this piece was last updated",
"type": "string",
"format": "date-time"
},
"claimingInterval": {
"description": "Time interval (in days) for processing claims related to this piece",
"type": "integer"
},
"internalNote": {
"description": "Internal note for Send Claim action",
"type": "string"
},
"externalNote": {
"description": "External note for Send Claim action to share with Vendor",
"type": "string"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"format",
"poLineId",
"titleId",
"receivingStatus"
]
},
"poLine": {
"description": "PoLine details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaName": "PoLine",
"properties": {
"id": {
"description": "UUID identifying this purchase order line",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"edition": {
"description": "edition of the material",
"type": "string"
},
"checkinItems": {
"description": "if true this will toggle the Check-in workflow for details associated with this PO line",
"type": "boolean",
"default": false
},
"agreementId": {
"description": "UUID of the agreement this purchase order line is related to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"acquisitionMethod": {
"description": "UUID of the acquisition method for this purchase order line",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"automaticExport": {
"description": "if true then line will be marked as available to export in the EDIFACT format or other format",
"type": "boolean",
"default": false
},
"cancellationRestriction": {
"description": "whether or not there are cancellation restrictions for this purchase order line",
"type": "boolean"
},
"cancellationRestrictionNote": {
"description": "free-form notes related to cancellation restrictions",
"type": "string"
},
"claims": {
"description": "claims associated with this purchase order line",
"id": "claims",
"type": "array",
"items": {
"description": "a claim record",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"claimed": {
"description": "whether or not this purchase order line has been claimed",
"type": "boolean",
"default": false
},
"sent": {
"description": "date a claim was sent",
"type": "string",
"format": "date-time"
},
"grace": {
"description": "the number of days after the expected receipt date during which claims should not be processed",
"type": "integer"
}
},
"additionalProperties": false
}
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"collection": {
"description": "whether or not this purchase order line is for a collection",
"type": "boolean",
"default": false
},
"contributors": {
"description": "list of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"cost": {
"description": "cost details associated with this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"listUnitPrice": {
"description": "The per-item list price for physical or resources of 'Other' order format",
"type": "number"
},
"listUnitPriceElectronic": {
"description": "The e-resource per-item list price",
"type": "number"
},
"currency": {
"description": "An ISO currency code",
"type": "string"
},
"additionalCost": {
"description": "Lump sum that is added to the total estimated price - not affected by discount",
"type": "number"
},
"discount": {
"description": "Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost",
"type": "number"
},
"discountType": {
"description": "Percentage or amount discount type",
"type": "string",
"enum": [
"amount",
"percentage"
],
"default": "percentage"
},
"exchangeRate": {
"description": "Exchange rate",
"type": "number"
},
"quantityPhysical": {
"description": "Quantity of physical items or resources of 'Other' order format in this purchase order line",
"type": "integer"
},
"quantityElectronic": {
"description": "Quantity of electronic items in this purchase order line",
"type": "integer"
},
"poLineEstimatedPrice": {
"description": "The calculated total estimated price for this purchase order line: list price time quantities minus discount amount plus additional cost",
"type": "number"
},
"fyroAdjustmentAmount": {
"description": "Adjustment amount if rollover was happen",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"currency"
]
},
"description": {
"description": "description of the material",
"type": "string"
},
"details": {
"description": "details about this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"receivingNote": {
"description": "notes regarding receiving instructions",
"type": "string"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"isBinderyActive": {
"description": "Indicates that this POL is designated as required binding",
"type": "boolean",
"default": false
},
"productIds": {
"description": "a list of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"subscriptionFrom": {
"description": "the start date of the subscription",
"type": [
"string",
"null"
],
"format": "date-time"
},
"subscriptionInterval": {
"description": "the subscription interval in days",
"type": "integer"
},
"subscriptionTo": {
"description": "the end date of the subscription",
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": false
},
"donor": {
"description": "the donor contributing to this purchase order line",
"type": "string"
},
"donorOrganizationIds": {
"description": "donor organization ids associated with this fund",
"type": "array",
"items": {
"description": "UUID of an donor organization record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"eresource": {
"description": "eresource-related details of this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"activated": {
"description": "whether or not this resource is activated",
"type": "boolean",
"default": false
},
"activationDue": {
"description": "number of days until activation, from date of order placement",
"type": "integer"
},
"createInventory": {
"description": "Shows what inventory objects need to be created for electronic resource",
"type": "string",
"enum": [
"Instance, Holding, Item",
"Instance, Holding",
"Instance",
"None"
]
},
"trial": {
"description": "whether or not this is a trial",
"type": "boolean",
"default": false
},
"expectedActivation": {
"description": "expected date the resource will be activated",
"type": "string",
"format": "date-time"
},
"userLimit": {
"description": "the concurrent user-limit",
"type": "string"
},
"accessProvider": {
"description": "UUID of the access provider",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"license": {
"description": "License record",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"code": {
"description": "license code",
"type": "string"
},
"description": {
"description": "license description",
"type": "string"
},
"reference": {
"description": "license reference",
"type": "string"
}
},
"additionalProperties": false
},
"materialType": {
"description": "UUID of the material Type",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"resourceUrl": {
"description": "Electronic resource can be access via this URL",
"type": "string",
"pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
}
},
"additionalProperties": false
},
"fundDistribution": {
"description": "Fund distribution records for this purchase order line",
"id": "fundDistribution",
"type": "array",
"items": {
"description": "a fund distribution record",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"code": {
"description": "the fund code",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[^:]+$"
},
"encumbrance": {
"description": "UUID of encumbrance record associated with this fund distribution",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"fundId": {
"description": "UUID of the fund associated with this fund distribution",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"expenseClassId": {
"description": "UUID of the expense class associated with this fund distribution",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"distributionType": {
"description": "Percentage or amount type of the value property",
"type": "string",
"enum": [
"amount",
"percentage"
],
"default": "percentage"
},
"value": {
"description": "The value of the cost to be applied to this fund",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"fundId",
"distributionType",
"value"
]
}
},
"instanceId": {
"description": "UUID of the instance record this purchase order line is related to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"isPackage": {
"description": "Indicates that this POL is for a package",
"type": "boolean",
"default": false
},
"locations": {
"description": "Location records for this purchase order line",
"id": "locations",
"type": "array",
"items": {
"description": "The location details",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"locationId": {
"description": "UUID of the (inventory) location record",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingId": {
"description": "Holding UUID associated with order line",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"quantity": {
"description": "Combined/total quanitity of physical and electronic items",
"type": "integer"
},
"quantityElectronic": {
"description": "Quantity of electronic items",
"type": "integer"
},
"quantityPhysical": {
"description": "Quantity of physical items",
"type": "integer"
},
"tenantId": {
"description": "Associated tenant for ECS-enabled clusters",
"type": "string"
}
},
"additionalProperties": false
}
},
"searchLocationIds": {
"description": "location ids used for search",
"type": "array",
"items": {
"description": "UUID of location record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"lastEDIExportDate": {
"description": "The last date when line was exported in the EDIFACT file",
"type": "string",
"format": "date-time"
},
"orderFormat": {
"description": "The purchase order line format",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Electronic Resource",
"P/E Mix",
"Physical Resource",
"Other"
]
},
"packagePoLineId": {
"description": "UUID referencing the poLine that represents the package that this POLs title belongs to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"paymentStatus": {
"description": "The purchase order line payment status",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Awaiting Payment",
"Cancelled",
"Fully Paid",
"Partially Paid",
"Payment Not Required",
"Pending",
"Ongoing"
],
"default": "Pending"
},
"physical": {
"description": "details of this purchase order line relating to physical materials",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"createInventory": {
"description": "Shows what inventory objects need to be created for physical resource",
"type": "string",
"enum": [
"Instance, Holding, Item",
"Instance, Holding",
"Instance",
"None"
]
},
"materialType": {
"description": "UUID of the material Type",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"materialSupplier": {
"description": "UUID of the material supplier record",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"expectedReceiptDate": {
"description": "vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": [
"string",
"null"
],
"format": "date-time"
},
"receiptDue": {
"description": "date item should be received by",
"type": [
"string",
"null"
],
"format": "date-time"
},
"volumes": {
"description": "list of volumes included to the physical material",
"type": "array",
"items": {
"description": "the identifier of volume",
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"volumes"
]
},
"poLineDescription": {
"description": "purchase order line description",
"type": "string"
},
"poLineNumber": {
"description": "A human readable number assigned to this PO line (assigned automatically)",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$"
},
"publicationDate": {
"description": "date (year) of the material's publication",
"type": "string"
},
"publisher": {
"description": "publisher of the material",
"type": "string"
},
"purchaseOrderId": {
"description": "UUID of the purchase order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"receiptDate": {
"description": "date the purchase order line was received",
"type": [
"null",
"string"
],
"format": "date-time"
},
"receiptStatus": {
"description": "The purchase order line receipt status",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Awaiting Receipt",
"Cancelled",
"Fully Received",
"Partially Received",
"Pending",
"Receipt Not Required",
"Ongoing"
],
"default": "Pending"
},
"renewalNote": {
"description": "Renewal note for this purchase order line",
"type": "string"
},
"requester": {
"description": "who requested this purchase order line",
"type": "string"
},
"rush": {
"description": "whether or not this is a rush order",
"type": "boolean",
"default": false
},
"selector": {
"description": "who selected this material",
"type": "string"
},
"source": {
"description": "the source of this purchase order line",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"User",
"API",
"EDI",
"MARC",
"EBSCONET"
]
},
"tags": {
"description": "arbitrary tags associated with this purchase order line",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"titleOrPackage": {
"description": "title of the material",
"type": "string"
},
"vendorDetail": {
"description": "Details related to the vendor of this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"instructions": {
"description": "special instructions for the vendor",
"type": "string"
},
"noteFromVendor": {
"description": "free-form notes from the vendor",
"type": "string"
},
"vendorAccount": {
"description": "the accound number on the vendor's end associated with this purchase order line",
"type": "string"
},
"referenceNumbers": {
"description": "Collection of reference number items",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Reference number item",
"type": "object",
"properties": {
"refNumber": {
"description": "a reference number for this purchase order line",
"type": "string"
},
"refNumberType": {
"description": "the reference number type",
"type": "string",
"enum": [
"Vendor continuation reference number",
"Vendor order reference number",
"Vendor subscription reference number",
"Vendor internal number",
"Vendor title number"
],
"javaEnums": [
"CONTINUATION_REF_NUMBER",
"ORDER_REF_NUMBER",
"SUBSCRIPTION_REF_NUMBER",
"INTERNAL_NUMBER",
"TITLE_NUMBER"
]
},
"vendorDetailsSource": {
"description": "the reference number type",
"type": "string",
"enum": [
"OrderLine",
"InvoiceLine"
],
"javaEnums": [
"ORDER_LINE",
"INVOICE_LINE"
]
}
},
"additionalProperties": false
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"suppressInstanceFromDiscovery": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system",
"default": false
},
"customFields": {
"description": "Object that contains custom field",
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"javaName": "CustomFields",
"additionalProperties": true
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"acquisitionMethod",
"cost",
"orderFormat",
"source",
"titleOrPackage"
]
},
"title": {
"description": "Title details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"description": "UUID of this title",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"expectedReceiptDate": {
"description": "Vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": "string",
"format": "date-time"
},
"title": {
"description": "The title name",
"type": "string"
},
"poLineId": {
"description": "UUID of the purchase order line this Title is associated with",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"instanceId": {
"description": "UUID of the instance associated with this Title",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"productIds": {
"description": "List of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"contributors": {
"description": "List of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"publisher": {
"description": "Publisher of the material",
"type": "string"
},
"edition": {
"description": "Edition of the material",
"type": "string"
},
"packageName": {
"description": "The name of the package",
"type": "string"
},
"poLineNumber": {
"description": "The number of the POL identified by poLineId",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,16}-[0-9]{1,3}$"
},
"publishedDate": {
"description": "Year of the material's publication",
"type": "string"
},
"receivingNote": {
"description": "Receiving note of the POL identified by poLineId",
"type": "string"
},
"subscriptionFrom": {
"description": "The start date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionTo": {
"description": "The end date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionInterval": {
"description": "The subscription interval in days",
"type": "integer"
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"bindItemIds": {
"description": "Item ids which bound to this title for independent receiving workflow",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this title",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"title",
"poLineId"
]
},
"purchaseOrder": {
"description": "PurchaseOrder details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaName": "PurchaseOrder",
"properties": {
"id": {
"description": "UUID of this purchase order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"approved": {
"description": "whether or not the purchase order has been approved",
"type": "boolean",
"default": false
},
"approvedById": {
"description": "UUID of the user approving the order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"approvalDate": {
"description": "Date and time when purchase order was approved",
"type": "string",
"format": "date-time"
},
"assignedTo": {
"description": "UUID of the user this purchase order his assigned to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"billTo": {
"description": "UUID of the billing address",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"closeReason": {
"description": "Close reason for purchase order",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"reason": {
"description": "close reason description",
"type": "string"
},
"note": {
"description": "free-form notes related to closing reason",
"type": "string"
}
},
"additionalProperties": false
},
"openedById": {
"description": "UUID of the user opening the Order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"dateOrdered": {
"description": "Date and time when purchase order was opened",
"type": "string",
"format": "date-time"
},
"manualPo": {
"description": "if true, order cannot be sent automatically, e.g. via EDI",
"type": "boolean"
},
"notes": {
"description": "free-form notes associated with this purchase order",
"id": "notes",
"type": "array",
"items": {
"type": "string"
}
},
"poNumber": {
"description": "A human readable ID assigned to this purchase order",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,22}$"
},
"poNumberPrefix": {
"description": "Purchase order number prefix",
"type": "string"
},
"poNumberSuffix": {
"description": "Purchase order number suffix",
"type": "string"
},
"orderType": {
"description": "the purchase order type",
"type": "string",
"enum": [
"One-Time",
"Ongoing"
]
},
"reEncumber": {
"description": "indicates this purchase order should be re-encumbered each fiscal year. Only applies to ongoing orders",
"type": "boolean",
"default": false
},
"ongoing": {
"description": "Ongoing information associated with this order",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"interval": {
"description": "Renewal interval (in days)",
"type": "integer"
},
"isSubscription": {
"description": "Whether or not this is a subscription",
"type": "boolean",
"default": false
},
"manualRenewal": {
"description": "Whether or not this is a manual renewal",
"type": "boolean",
"default": false
},
"notes": {
"description": "Notes associated with the Ongoing order",
"type": "string"
},
"reviewPeriod": {
"description": "Time prior to renewal where changes can be made to subscription",
"type": "integer"
},
"renewalDate": {
"description": "The date this Ongoing PO's order lines were renewed",
"type": "string",
"format": "date-time"
},
"reviewDate": {
"description": "Date when Order has to be reviewed",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"shipTo": {
"description": "UUID of the shipping address",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"template": {
"description": "The ID of the order template used for this order. Applies to both PO and POL",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"vendor": {
"description": "UUID of the vendor record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"workflowStatus": {
"description": "the workflow status for this purchase order",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Pending",
"Open",
"Closed"
],
"default": "Pending"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this purchase order",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"nextPolNumber": {
"description": "Number that will be used next time a purchase order line is created",
"type": "integer",
"readonly": true
},
"tags": {
"type": "object",
"description": "arbitrary tags associated with this purchase order",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"customFields": {
"description": "Object that contains custom field",
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"javaName": "CustomFields",
"additionalProperties": true
},
"fiscalYearId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": true,
"required": [
"vendorId",
"piece",
"poLine",
"title",
"purchaseOrder"
]
}
},
"totalRecords": {
"description": "The number of objects contained in this collection",
"type": "integer"
}
},
"additionalProperties": true
}Example:
{
"wrapperPieces": [
{
"vendorId": "0b5e9284-fe9f-419d-b14e-319c7659165f",
"piece": {
"id": "29c88d1a-e098-4f49-8074-917f5f5965d5",
"format": "Physical",
"itemId": "db335665-5359-41ab-b530-f36c0967852f",
"poLineId": "d27efda0-0b01-4bc5-bf96-018598dc9a61",
"titleId": "07618e59-d9d9-4be0-b05b-7e471bca870e",
"holdingId": "4ae98814-da19-4f38-8483-6571970707d7",
"displayOnHolding": false,
"displayToPublic": false,
"receivingStatus": "Expected",
"isBound": false,
"statusUpdatedDate": "2025-01-21T08:08:52.883+00:00",
"metadata": {
"createdDate": "2025-01-21T08:08:52.877+00:00",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedDate": "2025-01-21T08:08:52.877+00:00",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
}
},
"purchaseOrder": {
"id": "347aba4a-cdab-411d-880b-a63f8b696ec3",
"tags": {
"tagList": [
"amazon"
]
},
"notes": [
"Check credit card statement to make sure payment shows up"
],
"billTo": "5f8a321e-6b38-4d90-92d4-bf08f91a2242",
"shipTo": "f7c36792-05f7-4c8c-969d-103ac6763187",
"vendor": "0b5e9284-fe9f-419d-b14e-319c7659165f",
"approved": true,
"manualPo": false,
"metadata": {
"createdDate": "2025-01-21T08:06:30.998Z",
"updatedDate": "2025-01-21T08:08:53.155Z",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
},
"poNumber": "10000",
"template": "4dee318b-f5b3-40dc-be93-cc89b8c45b6f",
"orderType": "One-Time",
"acqUnitIds": [],
"reEncumber": false,
"dateOrdered": "2025-01-21T08:08:50.849+00:00",
"approvalDate": "2025-01-21T08:08:50.848+00:00",
"approvedById": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"workflowStatus": "Open"
},
"title": {
"id": "07618e59-d9d9-4be0-b05b-7e471bca870e",
"title": "Test 1",
"metadata": {
"createdDate": "2025-01-21T08:06:50.677Z",
"updatedDate": "2025-01-21T08:08:53.122Z",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
},
"poLineId": "d27efda0-0b01-4bc5-bf96-018598dc9a61",
"acqUnitIds": [],
"instanceId": "7068d630-3809-423f-9f6a-6742812dddfb",
"productIds": [],
"bindItemIds": [],
"contributors": [],
"poLineNumber": "10000-1",
"claimingActive": false,
"isAcknowledged": false
},
"poLine": {
"id": "d27efda0-0b01-4bc5-bf96-018598dc9a61",
"cost": {
"currency": "USD",
"discountType": "percentage",
"listUnitPrice": 100.0,
"quantityPhysical": 1,
"poLineEstimatedPrice": 100.0
},
"rush": false,
"claims": [],
"source": "User",
"details": {
"productIds": [],
"isAcknowledged": false,
"isBinderyActive": false
},
"metadata": {
"createdDate": "2025-01-21T08:06:50.595Z",
"updatedDate": "2025-01-21T08:08:53.096Z",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
},
"physical": {
"volumes": [],
"materialType": "1a54b431-2e4f-452d-9cae-9cee66c9a892",
"createInventory": "Instance, Holding, Item",
"materialSupplier": "e0fb5df2-cdf1-11e8-a8d5-f2801f1b9fd1"
},
"isPackage": false,
"locations": [
{
"quantity": 1,
"holdingId": "4ae98814-da19-4f38-8483-6571970707d7",
"quantityPhysical": 1
}
],
"collection": false,
"instanceId": "7068d630-3809-423f-9f6a-6742812dddfb",
"orderFormat": "Physical Resource",
"checkinItems": false,
"contributors": [],
"poLineNumber": "10000-1",
"vendorDetail": {
"instructions": "",
"vendorAccount": "1",
"referenceNumbers": []
},
"paymentStatus": "Awaiting Payment",
"receiptStatus": "Awaiting Receipt",
"claimingActive": false,
"titleOrPackage": "Test 1",
"automaticExport": false,
"purchaseOrderId": "347aba4a-cdab-411d-880b-a63f8b696ec3",
"fundDistribution": [],
"acquisitionMethod": "306489dd-0053-49ee-a068-c316444a8f55",
"searchLocationIds": [
"fcd64ce1-6995-48f0-840e-89ffa2288371"
],
"donorOrganizationIds": [],
"cancellationRestriction": true
}
}
],
"totalRecords": 1
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to list wrapper-pieces -- malformed parameter 'query', syntax error at column 6"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
"unable to list wrapper-pieces -- unauthorized"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"wrapper-piece not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorEntity representing a wrapper-piece
get
Retrieve wrapper-piece item with given {wrapper-pieceId}
get /orders-storage/wrapper-pieces/{id}
Retrieve wrapper-piece item with given {wrapper-pieceId}
URI Parameters
- id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
The UUID of a Wrapper Piece
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wrapper Piece details",
"type": "object",
"javaName": "WrapperPiece",
"properties": {
"vendorId": {
"description": "UUID of the vendor id this record is associated with",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"piece": {
"description": "Piece details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaName": "Piece",
"properties": {
"id": {
"description": "UUID of this piece record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"displaySummary": {
"description": "Display summary information",
"type": "string"
},
"comment": {
"description": "Free form commentary",
"type": "string"
},
"format": {
"description": "The format of the piece",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Physical",
"Electronic",
"Other"
]
},
"itemId": {
"description": "UUID of the associated item record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"bindItemId": {
"description": "UUID of the associated bind item record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"bindItemTenantId": {
"description": "Bind item tenant for ECS-enabled clusters",
"type": "string"
},
"locationId": {
"description": "UUID of the (inventory) location record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"poLineId": {
"description": "UUID of the purchase order line this record is associated with",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"titleId": {
"description": "UUID of the title record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingId": {
"description": "UUID of the holding record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"receivingTenantId": {
"description": "Receiving tenant for ECS-enabled clusters",
"type": "string"
},
"displayOnHolding": {
"description": "Whether or not receiving history should be displayed in holding record view",
"type": "boolean",
"default": false
},
"displayToPublic": {
"description": "Whether or not the piece data should display to patrons at point of receipt",
"type": "boolean",
"default": false
},
"enumeration": {
"type": "string",
"description": "Enumeration is the descriptive information for the numbering scheme of a serial. Synchronized with inventory item."
},
"chronology": {
"type": "string",
"description": "Chronology is the descriptive information for the dating scheme of a serial. Synchronized with inventory item."
},
"barcode": {
"type": "string",
"description": "Barcode is the descriptive information for the barcode of a serial. Synchronized with inventory item."
},
"accessionNumber": {
"type": "string",
"description": "AccessionNumber is the descriptive information for the accession number of a serial. Synchronized with inventory item."
},
"callNumber": {
"type": "string",
"description": "CallNumber is the descriptive information for the call number of a serial. Synchronized with inventory item."
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"copyNumber": {
"type": "string",
"description": "Copy number of the piece"
},
"receivingStatus": {
"description": "The status of this piece",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaName": "ReceivingStatus",
"type": "string",
"enum": [
"Received",
"Expected",
"Late",
"Claim delayed",
"Claim sent",
"Unreceivable"
],
"default": "Expected"
},
"supplement": {
"description": "Whether or not this is supplementary material",
"type": "boolean"
},
"isBound": {
"description": "Whether or not piece has already been bound",
"type": "boolean",
"default": false
},
"receiptDate": {
"description": "Date that associated item is expected to arrive",
"type": "string",
"format": "date-time"
},
"receivedDate": {
"description": "The date associated item is actually received",
"type": "string",
"format": "date-time"
},
"statusUpdatedDate": {
"description": "Date when the status of this piece was last updated",
"type": "string",
"format": "date-time"
},
"claimingInterval": {
"description": "Time interval (in days) for processing claims related to this piece",
"type": "integer"
},
"internalNote": {
"description": "Internal note for Send Claim action",
"type": "string"
},
"externalNote": {
"description": "External note for Send Claim action to share with Vendor",
"type": "string"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"format",
"poLineId",
"titleId",
"receivingStatus"
]
},
"poLine": {
"description": "PoLine details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaName": "PoLine",
"properties": {
"id": {
"description": "UUID identifying this purchase order line",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"edition": {
"description": "edition of the material",
"type": "string"
},
"checkinItems": {
"description": "if true this will toggle the Check-in workflow for details associated with this PO line",
"type": "boolean",
"default": false
},
"agreementId": {
"description": "UUID of the agreement this purchase order line is related to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"acquisitionMethod": {
"description": "UUID of the acquisition method for this purchase order line",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"automaticExport": {
"description": "if true then line will be marked as available to export in the EDIFACT format or other format",
"type": "boolean",
"default": false
},
"cancellationRestriction": {
"description": "whether or not there are cancellation restrictions for this purchase order line",
"type": "boolean"
},
"cancellationRestrictionNote": {
"description": "free-form notes related to cancellation restrictions",
"type": "string"
},
"claims": {
"description": "claims associated with this purchase order line",
"id": "claims",
"type": "array",
"items": {
"description": "a claim record",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"claimed": {
"description": "whether or not this purchase order line has been claimed",
"type": "boolean",
"default": false
},
"sent": {
"description": "date a claim was sent",
"type": "string",
"format": "date-time"
},
"grace": {
"description": "the number of days after the expected receipt date during which claims should not be processed",
"type": "integer"
}
},
"additionalProperties": false
}
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"collection": {
"description": "whether or not this purchase order line is for a collection",
"type": "boolean",
"default": false
},
"contributors": {
"description": "list of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"cost": {
"description": "cost details associated with this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"listUnitPrice": {
"description": "The per-item list price for physical or resources of 'Other' order format",
"type": "number"
},
"listUnitPriceElectronic": {
"description": "The e-resource per-item list price",
"type": "number"
},
"currency": {
"description": "An ISO currency code",
"type": "string"
},
"additionalCost": {
"description": "Lump sum that is added to the total estimated price - not affected by discount",
"type": "number"
},
"discount": {
"description": "Percentage (0 to 100) or amount (positive number) that is subtracted from the list price time quantities calculation before additional cost",
"type": "number"
},
"discountType": {
"description": "Percentage or amount discount type",
"type": "string",
"enum": [
"amount",
"percentage"
],
"default": "percentage"
},
"exchangeRate": {
"description": "Exchange rate",
"type": "number"
},
"quantityPhysical": {
"description": "Quantity of physical items or resources of 'Other' order format in this purchase order line",
"type": "integer"
},
"quantityElectronic": {
"description": "Quantity of electronic items in this purchase order line",
"type": "integer"
},
"poLineEstimatedPrice": {
"description": "The calculated total estimated price for this purchase order line: list price time quantities minus discount amount plus additional cost",
"type": "number"
},
"fyroAdjustmentAmount": {
"description": "Adjustment amount if rollover was happen",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"currency"
]
},
"description": {
"description": "description of the material",
"type": "string"
},
"details": {
"description": "details about this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"receivingNote": {
"description": "notes regarding receiving instructions",
"type": "string"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"isBinderyActive": {
"description": "Indicates that this POL is designated as required binding",
"type": "boolean",
"default": false
},
"productIds": {
"description": "a list of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"subscriptionFrom": {
"description": "the start date of the subscription",
"type": [
"string",
"null"
],
"format": "date-time"
},
"subscriptionInterval": {
"description": "the subscription interval in days",
"type": "integer"
},
"subscriptionTo": {
"description": "the end date of the subscription",
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": false
},
"donor": {
"description": "the donor contributing to this purchase order line",
"type": "string"
},
"donorOrganizationIds": {
"description": "donor organization ids associated with this fund",
"type": "array",
"items": {
"description": "UUID of an donor organization record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"eresource": {
"description": "eresource-related details of this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"activated": {
"description": "whether or not this resource is activated",
"type": "boolean",
"default": false
},
"activationDue": {
"description": "number of days until activation, from date of order placement",
"type": "integer"
},
"createInventory": {
"description": "Shows what inventory objects need to be created for electronic resource",
"type": "string",
"enum": [
"Instance, Holding, Item",
"Instance, Holding",
"Instance",
"None"
]
},
"trial": {
"description": "whether or not this is a trial",
"type": "boolean",
"default": false
},
"expectedActivation": {
"description": "expected date the resource will be activated",
"type": "string",
"format": "date-time"
},
"userLimit": {
"description": "the concurrent user-limit",
"type": "string"
},
"accessProvider": {
"description": "UUID of the access provider",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"license": {
"description": "License record",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"code": {
"description": "license code",
"type": "string"
},
"description": {
"description": "license description",
"type": "string"
},
"reference": {
"description": "license reference",
"type": "string"
}
},
"additionalProperties": false
},
"materialType": {
"description": "UUID of the material Type",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"resourceUrl": {
"description": "Electronic resource can be access via this URL",
"type": "string",
"pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
}
},
"additionalProperties": false
},
"fundDistribution": {
"description": "Fund distribution records for this purchase order line",
"id": "fundDistribution",
"type": "array",
"items": {
"description": "a fund distribution record",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"code": {
"description": "the fund code",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[^:]+$"
},
"encumbrance": {
"description": "UUID of encumbrance record associated with this fund distribution",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"fundId": {
"description": "UUID of the fund associated with this fund distribution",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"expenseClassId": {
"description": "UUID of the expense class associated with this fund distribution",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"distributionType": {
"description": "Percentage or amount type of the value property",
"type": "string",
"enum": [
"amount",
"percentage"
],
"default": "percentage"
},
"value": {
"description": "The value of the cost to be applied to this fund",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"fundId",
"distributionType",
"value"
]
}
},
"instanceId": {
"description": "UUID of the instance record this purchase order line is related to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"isPackage": {
"description": "Indicates that this POL is for a package",
"type": "boolean",
"default": false
},
"locations": {
"description": "Location records for this purchase order line",
"id": "locations",
"type": "array",
"items": {
"description": "The location details",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"locationId": {
"description": "UUID of the (inventory) location record",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"holdingId": {
"description": "Holding UUID associated with order line",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"quantity": {
"description": "Combined/total quanitity of physical and electronic items",
"type": "integer"
},
"quantityElectronic": {
"description": "Quantity of electronic items",
"type": "integer"
},
"quantityPhysical": {
"description": "Quantity of physical items",
"type": "integer"
},
"tenantId": {
"description": "Associated tenant for ECS-enabled clusters",
"type": "string"
}
},
"additionalProperties": false
}
},
"searchLocationIds": {
"description": "location ids used for search",
"type": "array",
"items": {
"description": "UUID of location record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"lastEDIExportDate": {
"description": "The last date when line was exported in the EDIFACT file",
"type": "string",
"format": "date-time"
},
"orderFormat": {
"description": "The purchase order line format",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Electronic Resource",
"P/E Mix",
"Physical Resource",
"Other"
]
},
"packagePoLineId": {
"description": "UUID referencing the poLine that represents the package that this POLs title belongs to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"paymentStatus": {
"description": "The purchase order line payment status",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Awaiting Payment",
"Cancelled",
"Fully Paid",
"Partially Paid",
"Payment Not Required",
"Pending",
"Ongoing"
],
"default": "Pending"
},
"physical": {
"description": "details of this purchase order line relating to physical materials",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"createInventory": {
"description": "Shows what inventory objects need to be created for physical resource",
"type": "string",
"enum": [
"Instance, Holding, Item",
"Instance, Holding",
"Instance",
"None"
]
},
"materialType": {
"description": "UUID of the material Type",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"materialSupplier": {
"description": "UUID of the material supplier record",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"expectedReceiptDate": {
"description": "vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": [
"string",
"null"
],
"format": "date-time"
},
"receiptDue": {
"description": "date item should be received by",
"type": [
"string",
"null"
],
"format": "date-time"
},
"volumes": {
"description": "list of volumes included to the physical material",
"type": "array",
"items": {
"description": "the identifier of volume",
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"volumes"
]
},
"poLineDescription": {
"description": "purchase order line description",
"type": "string"
},
"poLineNumber": {
"description": "A human readable number assigned to this PO line (assigned automatically)",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,22}-[0-9]{1,3}$"
},
"publicationDate": {
"description": "date (year) of the material's publication",
"type": "string"
},
"publisher": {
"description": "publisher of the material",
"type": "string"
},
"purchaseOrderId": {
"description": "UUID of the purchase order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"receiptDate": {
"description": "date the purchase order line was received",
"type": [
"null",
"string"
],
"format": "date-time"
},
"receiptStatus": {
"description": "The purchase order line receipt status",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Awaiting Receipt",
"Cancelled",
"Fully Received",
"Partially Received",
"Pending",
"Receipt Not Required",
"Ongoing"
],
"default": "Pending"
},
"renewalNote": {
"description": "Renewal note for this purchase order line",
"type": "string"
},
"requester": {
"description": "who requested this purchase order line",
"type": "string"
},
"rush": {
"description": "whether or not this is a rush order",
"type": "boolean",
"default": false
},
"selector": {
"description": "who selected this material",
"type": "string"
},
"source": {
"description": "the source of this purchase order line",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"User",
"API",
"EDI",
"MARC",
"EBSCONET"
]
},
"tags": {
"description": "arbitrary tags associated with this purchase order line",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"titleOrPackage": {
"description": "title of the material",
"type": "string"
},
"vendorDetail": {
"description": "Details related to the vendor of this purchase order line",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"instructions": {
"description": "special instructions for the vendor",
"type": "string"
},
"noteFromVendor": {
"description": "free-form notes from the vendor",
"type": "string"
},
"vendorAccount": {
"description": "the accound number on the vendor's end associated with this purchase order line",
"type": "string"
},
"referenceNumbers": {
"description": "Collection of reference number items",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Reference number item",
"type": "object",
"properties": {
"refNumber": {
"description": "a reference number for this purchase order line",
"type": "string"
},
"refNumberType": {
"description": "the reference number type",
"type": "string",
"enum": [
"Vendor continuation reference number",
"Vendor order reference number",
"Vendor subscription reference number",
"Vendor internal number",
"Vendor title number"
],
"javaEnums": [
"CONTINUATION_REF_NUMBER",
"ORDER_REF_NUMBER",
"SUBSCRIPTION_REF_NUMBER",
"INTERNAL_NUMBER",
"TITLE_NUMBER"
]
},
"vendorDetailsSource": {
"description": "the reference number type",
"type": "string",
"enum": [
"OrderLine",
"InvoiceLine"
],
"javaEnums": [
"ORDER_LINE",
"INVOICE_LINE"
]
}
},
"additionalProperties": false
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"suppressInstanceFromDiscovery": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system",
"default": false
},
"customFields": {
"description": "Object that contains custom field",
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"javaName": "CustomFields",
"additionalProperties": true
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"acquisitionMethod",
"cost",
"orderFormat",
"source",
"titleOrPackage"
]
},
"title": {
"description": "Title details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"description": "UUID of this title",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"expectedReceiptDate": {
"description": "Vendor agreed date prior to the Receipt Due date item is expected to be received by",
"type": "string",
"format": "date-time"
},
"title": {
"description": "The title name",
"type": "string"
},
"poLineId": {
"description": "UUID of the purchase order line this Title is associated with",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"instanceId": {
"description": "UUID of the instance associated with this Title",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"productIds": {
"description": "List of product identifiers",
"id": "productIds",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Product identifier",
"type": "object",
"properties": {
"productId": {
"description": "The actual product identifier",
"type": "string"
},
"productIdType": {
"description": "The type of product identifier",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"qualifier": {
"description": "Information about the binding, format, volume numbers, part of a set, publisher, distributor, etc. which might be enclosed in parenthesis",
"type": "string"
}
},
"additionalProperties": false
}
},
"contributors": {
"description": "List of contributors to the material",
"id": "contributors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "contributor to the material",
"properties": {
"contributor": {
"description": "the name of a contributor to the material",
"type": "string"
},
"contributorNameTypeId": {
"description": "UUID of the contributor type",
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"additionalProperties": false,
"required": [
"contributorNameTypeId"
]
}
},
"publisher": {
"description": "Publisher of the material",
"type": "string"
},
"edition": {
"description": "Edition of the material",
"type": "string"
},
"packageName": {
"description": "The name of the package",
"type": "string"
},
"poLineNumber": {
"description": "The number of the POL identified by poLineId",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,16}-[0-9]{1,3}$"
},
"publishedDate": {
"description": "Year of the material's publication",
"type": "string"
},
"receivingNote": {
"description": "Receiving note of the POL identified by poLineId",
"type": "string"
},
"subscriptionFrom": {
"description": "The start date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionTo": {
"description": "The end date of the subscription",
"type": "string",
"format": "date-time"
},
"subscriptionInterval": {
"description": "The subscription interval in days",
"type": "integer"
},
"claimingActive": {
"description": "Indicates if there is an active claim or dispute",
"type": "boolean",
"default": false
},
"claimingInterval": {
"description": "Specifies the time interval, in days, within which claims or disputes must be initiated",
"type": "integer"
},
"isAcknowledged": {
"description": "Flag for acknowledge receiving note",
"type": "boolean",
"default": false
},
"bindItemIds": {
"description": "Item ids which bound to this title for independent receiving workflow",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this title",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"title",
"poLineId"
]
},
"purchaseOrder": {
"description": "PurchaseOrder details",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"javaName": "PurchaseOrder",
"properties": {
"id": {
"description": "UUID of this purchase order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"approved": {
"description": "whether or not the purchase order has been approved",
"type": "boolean",
"default": false
},
"approvedById": {
"description": "UUID of the user approving the order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"approvalDate": {
"description": "Date and time when purchase order was approved",
"type": "string",
"format": "date-time"
},
"assignedTo": {
"description": "UUID of the user this purchase order his assigned to",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"billTo": {
"description": "UUID of the billing address",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"closeReason": {
"description": "Close reason for purchase order",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"reason": {
"description": "close reason description",
"type": "string"
},
"note": {
"description": "free-form notes related to closing reason",
"type": "string"
}
},
"additionalProperties": false
},
"openedById": {
"description": "UUID of the user opening the Order",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"dateOrdered": {
"description": "Date and time when purchase order was opened",
"type": "string",
"format": "date-time"
},
"manualPo": {
"description": "if true, order cannot be sent automatically, e.g. via EDI",
"type": "boolean"
},
"notes": {
"description": "free-form notes associated with this purchase order",
"id": "notes",
"type": "array",
"items": {
"type": "string"
}
},
"poNumber": {
"description": "A human readable ID assigned to this purchase order",
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,22}$"
},
"poNumberPrefix": {
"description": "Purchase order number prefix",
"type": "string"
},
"poNumberSuffix": {
"description": "Purchase order number suffix",
"type": "string"
},
"orderType": {
"description": "the purchase order type",
"type": "string",
"enum": [
"One-Time",
"Ongoing"
]
},
"reEncumber": {
"description": "indicates this purchase order should be re-encumbered each fiscal year. Only applies to ongoing orders",
"type": "boolean",
"default": false
},
"ongoing": {
"description": "Ongoing information associated with this order",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"interval": {
"description": "Renewal interval (in days)",
"type": "integer"
},
"isSubscription": {
"description": "Whether or not this is a subscription",
"type": "boolean",
"default": false
},
"manualRenewal": {
"description": "Whether or not this is a manual renewal",
"type": "boolean",
"default": false
},
"notes": {
"description": "Notes associated with the Ongoing order",
"type": "string"
},
"reviewPeriod": {
"description": "Time prior to renewal where changes can be made to subscription",
"type": "integer"
},
"renewalDate": {
"description": "The date this Ongoing PO's order lines were renewed",
"type": "string",
"format": "date-time"
},
"reviewDate": {
"description": "Date when Order has to be reviewed",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"shipTo": {
"description": "UUID of the shipping address",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"template": {
"description": "The ID of the order template used for this order. Applies to both PO and POL",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"vendor": {
"description": "UUID of the vendor record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"workflowStatus": {
"description": "the workflow status for this purchase order",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"enum": [
"Pending",
"Open",
"Closed"
],
"default": "Pending"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this purchase order",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"nextPolNumber": {
"description": "Number that will be used next time a purchase order line is created",
"type": "integer",
"readonly": true
},
"tags": {
"type": "object",
"description": "arbitrary tags associated with this purchase order",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"customFields": {
"description": "Object that contains custom field",
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"javaName": "CustomFields",
"additionalProperties": true
},
"fiscalYearId": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The UUID format string",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": true,
"required": [
"vendorId",
"piece",
"poLine",
"title",
"purchaseOrder"
]
}Example:
{
"vendorId": "0b5e9284-fe9f-419d-b14e-319c7659165f",
"piece": {
"id": "29c88d1a-e098-4f49-8074-917f5f5965d5",
"format": "Physical",
"itemId": "db335665-5359-41ab-b530-f36c0967852f",
"poLineId": "d27efda0-0b01-4bc5-bf96-018598dc9a61",
"titleId": "07618e59-d9d9-4be0-b05b-7e471bca870e",
"holdingId": "4ae98814-da19-4f38-8483-6571970707d7",
"displayOnHolding": false,
"displayToPublic": false,
"receivingStatus": "Expected",
"isBound": false,
"statusUpdatedDate": "2025-01-21T08:08:52.883+00:00",
"metadata": {
"createdDate": "2025-01-21T08:08:52.877+00:00",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedDate": "2025-01-21T08:08:52.877+00:00",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
}
},
"purchaseOrder": {
"id": "347aba4a-cdab-411d-880b-a63f8b696ec3",
"tags": {
"tagList": [
"amazon"
]
},
"notes": [
"Check credit card statement to make sure payment shows up"
],
"billTo": "5f8a321e-6b38-4d90-92d4-bf08f91a2242",
"shipTo": "f7c36792-05f7-4c8c-969d-103ac6763187",
"vendor": "0b5e9284-fe9f-419d-b14e-319c7659165f",
"approved": true,
"manualPo": false,
"metadata": {
"createdDate": "2025-01-21T08:06:30.998Z",
"updatedDate": "2025-01-21T08:08:53.155Z",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
},
"poNumber": "10000",
"template": "4dee318b-f5b3-40dc-be93-cc89b8c45b6f",
"orderType": "One-Time",
"acqUnitIds": [],
"reEncumber": false,
"dateOrdered": "2025-01-21T08:08:50.849+00:00",
"approvalDate": "2025-01-21T08:08:50.848+00:00",
"approvedById": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"workflowStatus": "Open"
},
"title": {
"id": "07618e59-d9d9-4be0-b05b-7e471bca870e",
"title": "Test 1",
"metadata": {
"createdDate": "2025-01-21T08:06:50.677Z",
"updatedDate": "2025-01-21T08:08:53.122Z",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
},
"poLineId": "d27efda0-0b01-4bc5-bf96-018598dc9a61",
"acqUnitIds": [],
"instanceId": "7068d630-3809-423f-9f6a-6742812dddfb",
"productIds": [],
"bindItemIds": [],
"contributors": [],
"poLineNumber": "10000-1",
"claimingActive": false,
"isAcknowledged": false
},
"poLine": {
"id": "d27efda0-0b01-4bc5-bf96-018598dc9a61",
"cost": {
"currency": "USD",
"discountType": "percentage",
"listUnitPrice": 100.0,
"quantityPhysical": 1,
"poLineEstimatedPrice": 100.0
},
"rush": false,
"claims": [],
"source": "User",
"details": {
"productIds": [],
"isAcknowledged": false,
"isBinderyActive": false
},
"metadata": {
"createdDate": "2025-01-21T08:06:50.595Z",
"updatedDate": "2025-01-21T08:08:53.096Z",
"createdByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10",
"updatedByUserId": "13cf3da2-e87b-4719-aa19-9e751dee6c10"
},
"physical": {
"volumes": [],
"materialType": "1a54b431-2e4f-452d-9cae-9cee66c9a892",
"createInventory": "Instance, Holding, Item",
"materialSupplier": "e0fb5df2-cdf1-11e8-a8d5-f2801f1b9fd1"
},
"isPackage": false,
"locations": [
{
"quantity": 1,
"holdingId": "4ae98814-da19-4f38-8483-6571970707d7",
"quantityPhysical": 1
}
],
"collection": false,
"instanceId": "7068d630-3809-423f-9f6a-6742812dddfb",
"orderFormat": "Physical Resource",
"checkinItems": false,
"contributors": [],
"poLineNumber": "10000-1",
"vendorDetail": {
"instructions": "",
"vendorAccount": "1",
"referenceNumbers": []
},
"paymentStatus": "Awaiting Payment",
"receiptStatus": "Awaiting Receipt",
"claimingActive": false,
"titleOrPackage": "Test 1",
"automaticExport": false,
"purchaseOrderId": "347aba4a-cdab-411d-880b-a63f8b696ec3",
"fundDistribution": [],
"acquisitionMethod": "306489dd-0053-49ee-a068-c316444a8f55",
"searchLocationIds": [
"fcd64ce1-6995-48f0-840e-89ffa2288371"
],
"donorOrganizationIds": [],
"cancellationRestriction": true
}
}
HTTP status code 401
Not authorized to perform requested action
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
unable to get retrieve wrapper-piece -- unauthorizedHTTP status code 404
Item with a given ID not found
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"wrapper-piece not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
internal server error, contact administrator