StandardUnitConversion

This component runs the Standard Unit Conversions function.

Methods

Closed
Driver Type: SASI
Use this method to change the status of a standard unit conversion to Closed.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more standard unit conversions. A standard unit conversion is created if it does not exist and amended if it does.
Note: The child records (payload tags StandardUnitLabel and StandardUnitAssignConversions) both have ConversionId in their key fields. This value is system generated and therefore may not be known if all of the Unit Of Measure data is created at the same time (that is, UnitOfMeasureLabels CreateOrAmend immediately followed by UnitLabelConversion CreateOrAmend immediately followed by StandardUnitConversion CreateOrAmend). It is therefore recommended that you exclude child records from the payload when creating records using StandardUnitConversion CreateOrAmend. Once the conversion Ids are known, the child data can then be added to the payload and the CreateOrAmend method can be rerun.
Delete
Driver Type: SASI
Use this method to delete a standard unit conversion.
Hidden
Driver Type: SASI
Use this method to amend the status of a standard unit conversion to Hidden.
Open
Driver Type: SASI
Use this method to amend the status of a standard unit conversion to Open.
Query
Driver Type: Export
Use this method to obtain standard unit conversion details or to extract standard unit conversions from SunSystems.
Suspended/Held
Driver Type: SASI
Use this method to amend the status of a standard unit conversion to Suspended/Held.

Mandatory fields

  • ShortDescription is required for all methods except Query. This tag in the payload is equivalent to the Standard Unit Code field on the system form within SunSystems.
  • DefaultInventoryUnit is required when creating a record.
  • When creating or amending Unit Labels, a value must be supplied for UnitLabelCode (in addition ConversionId and Sequence are required for the creation of a Unit Label.
  • When creating or amending Assign Conversions, ConversionId is required.

Related data

  • Unit Label Conversion.
  • Unit of Measure Label.