Methods: MovementOrder

ConfirmLineOrder

Driver Type: SASI

Use this method to confirm one or more movement order lines. If no line numbers are specified in the payload, the entire order, including all lines, is confirmed.

MovementOrderReference is mandatory. If the MovementOrderLine section is included in the payload, it must contain UserLineNumber or LineNumber. If both are provided, UserLineNumber is used.

CreateOrAmend

Driver Type: SASI

Use this method to create or amend one or more movement orders. A movement order is created if it does not exist and amended if it does.

Nota: If amending a movement order, MovementOrderReference must be provided. If MovementOrderReference is specified in the payload, but there is no existing order with this reference, then a new order is created. However, the new order may have a different transaction reference, depending on the Movement Type used, i.e. if the associated transaction reference format does not contain any items for a user to specify, then the movement order reference will be system generated, and the existing payload values are not used.

CreateorAmendandConfirm

Driver Type: SASI

Use this method to create or amend a movement order and then to confirm it. If the movement order does not exist already it is created and then confirmed, otherwise it is amended and then confirmed.

Nota: If amending a movement order, MovementOrderReference must be provided. If MovementOrderReference is specified in the payload, but there is no existing order with this reference, then a new order is created. However, the new order may have a different transaction reference, depending on the Movement Type used, i.e. if the associated transaction reference format does not contain any items for a user to specify, then the movement order reference will be system generated, and the existing payload values are not used.

CreateOrAmendWithSerialNumbers

Driver Type: SASI

Use this method to create or amend a movement order with serial numbers or amend an existing movement order. SSC supports serial number for both Issues and Receipts but the serial number data has separate payload sections for each.

Specific to Receipts:

When generating the receipt note from the movement order line, it selects all lines to process, creates all lines and uses the quantities entered on the movement order lines to get the serial numbers to be generated. Split lines/quantities are not supported for this method.

Masking is not supported in SSC, so you must ensure that the correct serial number format is entered in the payload, and that the corresponding serial number is valid. It is not possible to use a format consisting of part constant and part user input serial numbers. The supported formats are as follows:

System generated serial numbers - Serial Number format contains a constant value and a number stream. The serial numbers are automatically generated, but an empty tag must be provided in the payload.
User entered serial numbers - Serial Number format is defined as user input only. No constant values or number streams are in use. The serial numbers must be provided in the payload. One serial number per quantity is required, for example, a line with quantity 3 requires three serial numbers.

The serial numbers must be in a specific format for the input payload. The serial numbers follow the line details with one SerialNumbersForLine tag for each line; these must be supplied in the same order as the lines. See the example payload using CreateOrAmendWithSerialNumbers.

Nota: Serial numbers can only be added when the receipt note is created. For example, any serial number processing in the amendment of a movement order will fail with the message "Nothing generated", if the receipt note has already been created.

Specific to Issues:

The serial numbers for an item are added immediately after a line is entered. The serial numbers for Issues should be entered within the line level <IssueSerialNumbers> section of the payload. The number of serial numbers must match the quantity of items for the line. The order is not important but each serial number specified must be a valid serial number for the item code and it must be available for allocation. See the example payload using CreateOrAmendWithSerialNumbers.

Nota: This applies to both Receipts and Issues. Serial number entry is only supported when creating a Movement Order. If amending a movement order, MovementOrderReference must be provided. If MovementOrderReference is specified in the payload, but there is no existing order with this reference, then a new order is created. However, the new order may have a different transaction reference, depending on the Movement Type used, i.e. if the associated transaction reference format does not contain any items for a user to specify, then the movement order reference will be system generated, and the existing payload values are not used. This method does not support ‘round tripping’ or internal/external transfer since the serial numbers are not exported.

DeleteLineOrder

Driver Type: SASI

Use this method to delete one or more movement order lines. If no line numbers are specified in the payload, the entire order including all lines is deleted.

MovementOrderReference is mandatory. If the MovementOrderLine section is included in the payload, it must contain UserLineNumber or LineNumber. If both are provided, UserLineNumber is used.

DeleteLines

Driver Type: SASI

Use this method to delete specific lines from a movement order.

MovementOrderReference is mandatory and either UserLineNumber or LineNumber must be specified. If both are provided, UserLineNumber is used.

DeleteWholeOrder

Driver Type: SASI

Use this method to delete a movement order and all lines.

MovementOrderReference is mandatory.

HoldLineOrder

Driver Type: SASI

Use this method to hold one or more movement order lines. If no line numbers are specified in the payload, the entire order including all lines is held.

MovementOrderReference is mandatory. If the MovementOrderLine section is included in the payload, it must contain UserLineNumber or LineNumber. If both are provided, UserLineNumber is used.

Query

Driver Type: Export

Use this method to obtain movement order details or to extract movement order data from SunSystems.

ReleaseLineOrder

Driver Type: SASI

Use this method to release one or more movement order lines. If no line numbers are specified in the payload, the entire order including all lines is released.

MovementOrderReference is mandatory. If the MovementOrderLine section is included in the payload, it must contain UserLineNumber or LineNumber. If both are provided, UserLineNumber is used.