RequisitionCatalogues

Methods

Closed

Driver Type: SASI

Use this method to change the status of a Category to Closed.

Create

Driver Type: SASI

Use this method to create a Category and any Child Category Items. If the Category already exists, then an error is displayed.

CreateAsDraft

Driver Type: SASI

Use this method to create a Category with Draft status.

CreateOrAmend

Driver Type: SASI

Use this method to create or amend one or more Categories and any associated Items.

Delete

Driver Type: SASI

Use this method to delete Categories.

DeleteChildData

Driver Type: SASI

Use this method to delete Categories.

Hidden

Driver Type: SASI

Use this method to change the status of a Category to Hidden.

Open

Driver Type: SASI

Use this method to change the status of a Category to Open.

Query

Driver Type: Export

Use this method to extract Category data from SunSystems.

Suspended/Held

Driver Type: SASI

Use this method to change the status of a Category to Suspended/Held.

Mandatory fields

General

• The payload is a ‘flattened’ structure containing 10 occurrences of categories as a maximum of 10 levels are permitted in the SunSystems function.
• When creating, amending or deleting a Category, a value must be supplied for Level 1 Name (<Level1Name>). Also, where there is data for Level N name, a value must have been supplied for all preceding level names.
• When deleting child data, values must be supplied for item code and supplier code: RequisitionCatalogue.Item.ItemCode and RequisitionCatalogue.Item.SupplierCode.
• Note that for the status change methods, the status will only be changed at the lowest level specified. E.g. if the payload contains values for Level1Name, Level2Name and Level3Name, only the status of the level 3 Category will be updated. Similarly, Delete will remove data, including sub-categories and items, for the lowest category level specified.

Other notes

The payload contains Id and status fields for export information only.

If we have this record in the import payload:

<RequisitionCatalogue>
<Level1Description>level 1 description</Level1Description>
<Level1Name>Level 1</Level1Name>
<Level2Description>level 2 description</Level2Description>
<Level2Name>Level 2</Level2Name>
<Level3Description>Level 3 description</Level3Description>
<Level3Name>Level 3</Level3Name>
<Item>
<CurrencyCode>GBP</CurrencyCode>
<DeliveryDays>4</DeliveryDays>
<Description>GB2001-81001</Description>
<ItemCode>GB2001</ItemCode>
<Price>45.00000</Price>
<SupplierCode>81001</SupplierCode>
<SuppliersItemCode>ITEM1</SuppliersItemCode>
<UnitOfPurchase>EACH</UnitOfPurchase>
</Item>
<Item>
<CurrencyCode>EUR</CurrencyCode>
<DeliveryDays>5</DeliveryDays>
<Description>GB2002-81001</Description>
<ItemCode>GB2002</ItemCode>
<Price>4.00000</Price>
<SupplierCode>81001</SupplierCode>
<SuppliersItemCode>TEST2</SuppliersItemCode>
<UnitOfPurchase>BOX</UnitOfPurchase>
</Item>
</RequisitionCatalogue>

This record would create or amend parent category Level 1 which has a child category Level 2 which itself has a child category Level 3. The 2 items are associated with category Level 3. When this payload record is used for a status change method, the status of category Level 3 would change, the Delete method would delete Level 3 and the 2 category items, DeleteChildData would delete only the 2 items under category Level 3.

Each distinct category ‘path’ to be updated should be represented by a <RequisitionCatalogue> record.

The SunSystems function allows a user to change a category name or change the parent category of a particular category. These actions are not directly supported via SSC. To achieve the same end result in SSC, a user would have to use Delete to remove the existing structure and then CreateOrAmend to produce the required new Catalogue structure.

Related data

Category Items.