InventoryRevalProfile

This component runs the Inventory Revaluation Profile (IRPS) function.

Methods

Closed
Driver Type: SASI
Use this method to change the status of one or more inventory revaluation profiles to Closed.
Create
Driver Type: SASI
Use this method to create one or more inventory revaluation profiles. If an inventory revaluation profile already exists, an error message is produced and the payload is rejected.
CreateAsDraft
Driver Type: SASI
Use this method to create one or more draft inventory revaluation profiles.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more inventory revaluation profiles. An inventory revaluation profile is created if it does not exist and amended if it does. Whereas both the Create and Amend methods require you to know in advance if an inventory revaluation profile exists, this method can be used if you are unsure.
Delete
Driver Type: SASI
Use this method to delete one or more inventory revaluation profiles.
DeleteChildData
Driver Type: SASI
This method deletes child data (Cost Type Selection, Item Selection, Item Analysis, Location Selection, Warehouse Selection, Warehouse Analysis, Report Selection) but retains the parent record (Inventory Revaluation Profile).
Hidden
Driver Type: SASI
Use this method to change the status of one or more inventory revaluation profiles to Hidden.
Open
Driver Type: SASI
Use this method to change the status of one or more inventory revaluation profiles to Open.
Query
Driver Type: Export
Use this method to obtain inventory revaluation profile details or to extract inventory revaluation profiles data from SunSystems.
SuspendedHeld
Driver Type: SASI
Use this method to change the status of one or more inventory revaluation profiles to Suspended/Held.

Mandatory fields

General
When creating or amending an inventory revaluation profile, the following must be supplied:
  • Inventory Revaluation Profile Code - payload element <InventoryRevaluationProfileCode>
  • User Defined Cost Definition Code - payload element <UserDefinedCostDefinitionCode>
Note: When deleting an inventory revaluation profile, only the inventory revaluation profile code must be supplied.
Selections
  • When creating or amending cost type selections, a value must be supplied for Cost Type Code - payload element <CostTypeCode>
  • When creating or amending item selections, the following must be supplied:
    • From Item Code - payload element <FromItemCode>
    • To Item Code - payload element <ToItemCode>
  • When creating or amending item analysis selections, a value must be supplied for Analysis Dimension - payload element <AnalysisDimension>
  • When creating or amending location selections, the following must be supplied:
    • From Location - payload element <FromLocation>
    • To Location - payload element <ToLocation>
  • When creating or amending warehouse selections, the following must be supplied:
    • From Warehouse - payload element <FromWarehouse>
    • To Warehouse - payload element <ToWareHouse>
  • When creating or amending warehouse analysis selections, a value must be supplied for Analysis Dimension - payload element <AnalysisDimensions>
  • When creating or amending report selections, a value must be supplied for Document Format Code - payload element <DocumentFormatCode>
Deleting Child Data
  • When deleting child data, a value must be supplied for Inventory Revaluation Profile Code - payload element <InventoryRevaluationProfileCode>
  • When deleting Cost Type Selection child data, a value must be supplied for Cost Type Code - payload element <CostTypeSelection.CostTypeCode>
  • When deleting Item Selection child data, a value must be supplied for:
    • From Item Code - payload element <ItemSelection.FromItemCode>
    • To Item Code - payload element <ItemSelection.ToItemCode>
  • When deleting Item Analysis child data, a value must be supplied for Item Analysis Selection - payload element <ItemAnalysisSelection.Dimension.AnlCat_SHead>
  • When deleting Location Selection child data, the following must be supplied:
    • From Location - payload element <LocationSelection.FromLocation>
    • To Location - payload element <LocationSelection.ToLocation>
  • When deleting Warehouse Selection child data, the following must be supplied:
    • From Warehouse - payload element <WhseSelection.FromWarehouse>
    • To Warehouse - payload element <WhseSelection.ToWareHouse>
  • When deleting Warehouse Analysis child data, a value must be supplied for Warehouse Analysis Selection - payload element <WarehouseAnalysisSelection.Dimension.AnlCat_SHead>
  • When deleting Report Selection child data, a value must be supplied Document Format Code - payload element <ReportSelection.DocumentFormatCode>
Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

None.