SORTRB: SO Release Unallocated Kit from Reserve
The SO Release Unallocated Kit from Reserve business object releases kit items from reserve into ship.
The business object has the following features:
The default process is to ship a parent line and all components using the reserved quantity from the parent sales order line.
Detail allocations must be supplied for each component line that requires lots, bins, serials or revision/release quantities. All quantities must be supplied in the same unit of measure.
If auto-depletion is set in SYSPRO, it may be ignored by use of a parameter, and the detailed allocations supplied in the XML.
See the Schema and sample XML instances in the Business Object Reference Library on the Support Zone for information about the XML parameters passed.
Properties
| Syspro Module | Sales Orders |
| Class | Transaction |
| Methods | Post |
| Functional Area | Sales Orders Primary Posting |
| Initial version released | Syspro 7 Update 1 |
Input XML
The .XML and .XSD input files indicate the parameters schema and an instance of an XML document for this business object.
SORTRB.XML
Copy
<?xml version="1.0" encoding="Windows-1252"?>
<!-- Copyright 1994-2016 SYSPRO Ltd.-->
<!--
This is an example XML instance to demonstrate
use of the Sales Order Release Unallocated Reserved Kit Quantities Business Object
-->
<PostSorKitAllocateReserved xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance" xsd:noNamespaceSchemaLocation="SORTRB.XSD">
<Parameters>
<IgnoreWarnings>N</IgnoreWarnings>
<ApplyIfEntireDocumentValid>N</ApplyIfEntireDocumentValid>
<ValidateOnly>N</ValidateOnly>
<IgnoreAutoDepletion>N</IgnoreAutoDepletion>
</Parameters>
</PostSorKitAllocateReserved>
Copy
<?xml version="1.0" encoding="Windows-1252"?>
<!-- Copyright 1994-2016 SYSPRO Ltd.-->
<!--
Schema for Parameters used by Sales Order Release Unallocated Reserved Kit Quantities Business Object
-->
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="ApplyIfEntireDocumentValid" default="Y">
<xsd:annotation>
<xsd:documentation>Specifies whether the entire document must be validated first before applying the function (N - apply function for each valid item, Y - all items must be valid before function is applied).</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:whiteSpace value="preserve"/>
<xsd:enumeration value="Y"/>
<xsd:enumeration value="N"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="IgnoreWarnings" default="N">
<xsd:annotation>
<xsd:documentation>Specifies if warnings are to be ignored (Y - if the warnings are to be ignored, N - warnings will be returned as errors in the XML returned, W - warnings will be returned as warnings in the XML returned).</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:whiteSpace value="preserve"/>
<xsd:enumeration value="Y"/>
<xsd:enumeration value="N"/>
<xsd:enumeration value="W"/>
<xsd:enumeration value=""/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="IgnoreAutoDepletion" default="N">
<xsd:annotation>
<xsd:documentation>This element is only relevant if the SYSPRO option to auto-deplete lots and bins for sales orders has been selected. If set to 'Y', then any processing will be carried out as if auto-depletion were not required, and the relevant lot and bin numbers must be supplied in the data XML. </xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:whiteSpace value="preserve"/>
<xsd:enumeration value="N"/>
<xsd:enumeration value="Y"/>
<xsd:enumeration value=""/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Parameters">
<xsd:annotation>
<xsd:documentation>This element contains the optional parameter elements.</xsd:documentation>
</xsd:annotation>
<xsd:complexType mixed="false">
<xsd:sequence>
<xsd:element ref="IgnoreWarnings" minOccurs="0"/>
<xsd:element ref="ApplyIfEntireDocumentValid" minOccurs="0"/>
<xsd:element ref="ValidateOnly" minOccurs="0"/>
<xsd:element ref="IgnoreAutoDepletion" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="PostSorKitAllocateReserved">
<xsd:annotation>
<xsd:documentation>This is the Root element.</xsd:documentation>
</xsd:annotation>
<xsd:complexType mixed="false">
<xsd:sequence>
<xsd:element ref="Parameters"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="ValidateOnly" default="Y">
<xsd:annotation>
<xsd:documentation>Specifies whether to only validate the contents of the document. (N - validate and apply function, Y - only validate the document).</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:whiteSpace value="preserve"/>
<xsd:enumeration value="Y"/>
<xsd:enumeration value="N"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:schema>
The DOC.XML and DOC.XSD files indicate the schema and an instance of an XML document for this business object.
SORTRBDOC.XML
Copy
<?xml version="1.0" encoding="Windows-1252"?>
<!-- Copyright 1994-2026 SYSPRO Ltd. -->
<!--
This is an example XML instance to demonstrate
use of the Sales Order Release Unallocated Reserved Kit Quantities Business Object
-->
<PostSorKitAllocateReserved xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance" xsd:noNamespaceSchemaLocation="SORTRBDOC.XSD">
<Item>
<SalesOrder>000889</SalesOrder>
<SalesOrderLine>0001</SalesOrderLine>
<Quantity>2.00</Quantity>
<eSignature />
<ComponentAllocations>
<ComponentLine>0002</ComponentLine>
<UnitOfMeasure />
<Lot />
<Serials>
<SerialNumber />
<SerialQuantity />
<SerialBin />
</Serials>
<Bins>
<BinLocation>A1</BinLocation>
<BinQuantity>4.000</BinQuantity>
</Bins>
</ComponentAllocations>
<ComponentAllocations>
<ComponentLine>0003</ComponentLine>
<UnitOfMeasure />
<Lot />
<Serials>
<SerialNumber />
<SerialQuantity />
<SerialBin />
</Serials>
<Bins>
<BinLocation>A</BinLocation>
<BinQuantity>3.000</BinQuantity>
</Bins>
</ComponentAllocations>
</Item>
</PostSorKitAllocateReserved>Copy
<?xml version="1.0" encoding="Windows-1252"?>
<!-- Copyright 1994-2026 SYSPRO Ltd. -->
<!--
This is an example schema to demonstrate
use of the Sales Order Release Unallocated Reserved Kit Quantities Business Object
-->
<xsd:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="PostSorKitAllocateReserved">
<xsd:annotation>
<xsd:documentation>This is the root element for Sales Order Release Reserved Kit Quantities</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="SalesOrder" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Must be supplied. The maximum length is controlled by the current version of SYSPRO. Must be a valid numeric value if sales order key for the company is numeric. Sales order must be on file. Sales order status may not be Cancelled, Complete, In process, a Forward order or in Suspense. If the order is Scheduled, then the parent line selected must be within the period for shipping.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SalesOrderLine" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Must be supplied. Must be a valid numeric value. Sales order line must exist on the sales order detail file and must be a stocked line containing a kit parent stock code of kit type K or S.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Quantity" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Must be supplied. Must be a valid numeric value. If the quantity to allocate is less than the original quantity reserved, the remaining unallocated quantity will be moved to backorder.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="eSignature" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>If required, this element must contain a GUID, for the eSignature system to accept the transaction as having been authenticated. The GUID format is in the format {36303032-3330-3031-3038-323434363433}, where the numbers can be replaced with any character. It is up to the developer to have requested a password to protect the transaction. An example is that a GUID associated with the act of entering a valid password could be obtained and presented.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ComponentAllocations" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="ComponentLine" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The component node only needs to be supplied if the component part is lot traceable, serialized, or requires bins. The node will be ignored for lines that do not require detailed allocations, and the component quantity calculated will be shipped automatically.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="UnitOfMeasure" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>This element is optional. If supplied, it indicates the unit of measure of the component-level quantities entered in this block. It must be either the Order Unit of Measure or the Stocking Unit of Measure for the component's stock code on the line. If not supplied, it defaults to the component parent's Order Unit of Measure and the quantities will be treated as such.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Lot" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>A lot must be supplied if the stock code is lot traceable. The maximum length is controlled by the current version of SYSPRO. If the key lot type for the company is numeric the lot supplied must be a valid numeric value. The lot supplied will be validated against the Lot traceable file for the stock code. Lots do not have to be supplied if Automatic depletion is in use - unless the stock item is both lot traceable and serialized.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Serials" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>The quantities supplied for all serial numbers must add up to the ship quantity calculated for the component line based on the parent quantity to ship.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="SerialNumber" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>At least one serial number must be supplied if Serial tracking is required and the stock item is a serialized item. The maximum length is controlled by the current version of SYSPRO. Must be valid numeric value if numeric key type. Serial number must exist on file and have stock for manual and batch serial numbers if stock code is flagged as 'capture serial numbers at receipt' or 'capture serial numbers during order entry'.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SerialQuantity" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>A serial quantity must be supplied for each serial number if the stock code does not make use of unit quantity processing. If the stock item makes use of unit processing - the quantity can either be supplied as a decimal value or else as Units and Pieces. Unit quantity processing will only apply to a batch serial item. The maximum length and number of decimals is controlled by the current version of SYSPRO and the characteristics of the stock code.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SerialUnits" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>This element is optional</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SerialPieces" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>This element is optional</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SerialBin" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Must contain the bin when associate bins with serial is on</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="Bins" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>This is the top element for the set of bins affected by this transaction, if multiple bins is installed. If the warehouse for the associated detail line does not make use of multiple bins, then any entries in the 'Bins' node will be ignored.
The quantities supplied for all bins must add up to the ship quantity calculated for the component line based on the parent quantity to ship.
Bins do not have to be supplied if Automatic depletion is in use - unless the stock item is both lot traceable and serialized.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="BinLocation" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>At least one bin must be supplied if the company makes use of multiple bins, and the warehouse on the detail line also uses multiple bins.The maximum length is controlled by the current version of SYSPRO. Will be validated against the inventory Bin file for the stock code. The quantities supplied for all bins must add up to the required component quantity.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="BinQuantity" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>A bin quantity must be supplied for every bin location supplied if the stock code does not make use of unit quantity processing. If the stock item makes use of unit processing - the quantity can either be supplied as a decimal value or else as Units and Pieces. The maximum length and number of decimals is controlled by the current version of SYSPRO and the characteristics of the stock code.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="BinUnits" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>This element is optional</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="BinPieces" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>This element is optional</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>Output XML
The OUT.XML indicates a sample of the XML returned by this business object.
SORTRBOUT.XML
Copy
<?xml version="1.0" encoding="Windows-1252"?>
<!-- Copyright 1994-2016 SYSPRO Ltd.-->
<!--
This is an example XMLOut instance to demonstrate
use of the Sales Order Release Unallocated Reserved Kit Quantities Business Object
-->
<PostSorKitAllocateReserved Language="05" CssStyle="" DecFormat="1" DateFormat="01" xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance" xsd:noNamespaceSchemaLocation="SORTRBOUT.XSD">
<Item>
<Key>
<SalesOrder>002102</SalesOrder>
<SalesOrderLine>0001</SalesOrderLine>
<StockCode>A101</StockCode>
</Key>
</Item>
<StatusOfItems>
<ItemsProcessed>1</ItemsProcessed>
<ItemsInvalid>0</ItemsInvalid>
</StatusOfItems>
</PostSorKitAllocateReserved>
Prerequisites
No prerequisites are required to use this business object.
Limitations
No limitations apply to this business object.
Copyright © 2026 Syspro PTY Ltd.