Methods: SalesTypes

Closed

Driver Type: SASI

Use this method to change the status of one or more sales types to Closed.

Create

Driver Type: SASI

Use this method to create one or more sales types. This method only creates a sales type. If the sales type 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 sales types.

CreateOrAmend

Driver Type: SASI

Use this method to create or amend one or more sales types. A sales type is created if it does not exist and amended if it does. The Create method requires you to know in advance if the analysis dimension exists, whereas this method can be used if you are unsure.

Примечание. Do not include Stage data in the payload for this method if there are existing Stage records for the transaction type. The update/insert of Stage records is prevented if any Stage data already exists. In this case, Stage records must be created/amended via SunSystems.

Delete

Driver Type: SASI

Use this method to delete sales types.

Примечание. You cannot delete a SalesTypes record if child data, such as Stage or Value data, exists. If this occurs, use the DeleteChildData method prior to using the Delete method.

DeleteChildData

Driver Type: SASI

This method deletes child data (SO Assign Preset, SO Analysis, Value, Stage) but retains the parent record (Sales Type).

It is also possible to delete 'grandchild' data. The deletion of child and grandchild data is controlled by a <DeletionFlag> node at child level. If the flag is set to Y, both child and grandchild is deleted. Otherwise, the child data is retained.

For example, the <Stage> node contains child data, and the <LedgerIFReversal> node contains grandchild data. The <DeletionFlag> node is set to Y, so the <LedgerInterfaceDefinitionCode> data is deleted first, followed by the <Stage> data:

<SalesTypes>
<SalesTypes.SalesDefinitionCode>SAL</SalesType.SalesDefinitionCode>
<Stage>
<Stage>0</Stage>
<DeletionFlag>
<DeleteStageAfterLIReversalDeleted>Y</DeleteStageAfterLIReversalDeleted>
</DeletionFlag>
<LedgerIFReversal>
<LedgerInterfaceDefinitionCode>LIDEF</LedgerInterfaceDefinitionCode>
</LedgerIFReversal>
</Stage>
</SalesTypes>

Примечание. Stage data must be deleted in reverse order, i.e. you must not delete a stage that is defined as a Sequence on another record.

Примечание. A SalesTypes payload deleting Sales Quantity is invalid and will return the error message "One Sales Quantity must be set per Sales Transaction Type". This is because all Order Fulfilment transaction types must have one value label that is flagged as the Quantity.

Hidden

Driver Type: SASI

Use this method to change the status of one or more sales types to Hidden.

Open

Driver Type: SASI

Use this method to change the status of one or more sales types to Open.

Query

Driver Type: Export

Use this method to obtain sales type details or to extract sales types data from SunSystems.

SuspendedHeld

Driver Type: SASI

Use this method to change the status of one or more sales types to SuspendedHeld.