ReceiptNotesGenerate

This component generates receipt notes and is associated with the ReceiptNotes component.

Receipt notes are normally used to update inventory. However, inventory can be updated at other stages such as Order Confirmation, Invoice Confirmation, etc.

Methods

Note: The Generate, GenerateWithSerialNumbers, GenerateAndFinish and GenerateAmendQuantityAndFinish methods use a different payload to the ReceiptNotes component methods. The component ReceiptNotesGenerate contains parameters corresponding to the entry fields in the Receipt Note entry function in SunSystems. Line Details must be supplied in order to select the line(s) for each receipt note.

Generate

Driver Type: SASI

You can use this method to generate one or more receipt note lines, directly from purchase orders, purchase invoices and movement orders.

Note: You cannot mix purchase and movement transactions within a single receipt note. Also, all lines within a receipt note must be for the same purchase or movement transaction type.

GenerateAndFinish

Driver Type: SASI

This method combines the functionality of the Generate and Finish methods into one method.

GenerateWithSerialNumbers

Driver Type: SASI

You can use this method to generate one or more receipt note lines directly from purchase orders, purchase invoices, and movement orders with serial numbers included, where applicable.

Note:

You cannot mix purchase and movement transactions within a single receipt note. Also, all lines within a receipt note must be for the same purchase or movement transaction type.
There is a separate section of the payload for serial numbers. An ItemSerialNumber entry must be included for each serialized item where serial number entry occurs at Receipt. Each of these ItemSerialNumber entries must contain an ItemCode and the entries must appear in the payload in the same order as the lines which make up the Receipt Note. In addition, if the item serial numbers are entered manually, rather than the item having a serial number format defined, the correct number of serial numbers must be supplied in the payload.

For example, the Purchase Order PO/002100 has 3 lines:

Line 1 – 2 x item TEST-AS1 (serialized item with serial number format defined, serial number required at receipt)
Line 2 – 2 x item TEST-AS2 (serialized item with serial number format defined, serial number not required at receipt)
Line 3 – 3 x item TEST-MS1 (serialized item without serial number format defined, serial number required at receipt)

Example payload for ReceiptNotesGenerate GenerateWithSerialNumbers:

<ReceiptNotesGenerate>
  <SupplierCode>81001</SupplierCode>
  <TransactionReferenceFrom>PO/002100</TransactionReferenceFrom> 
  <TransactionReferenceTo>PO/002100</TransactionReferenceTo>
  <LineDetails>
    <LineNumber>1</LineNumber> 
    <TransactionReference>PO/002100</TransactionReference>
  </LineDetails>
  <LineDetails>
    <LineNumber>2</LineNumber>
    <TransactionReference>PO/002100</TransactionReference> 
  </LineDetails> 
  <LineDetails>
    <LineNumber>3</LineNumber>
    <TransactionReference>PO/002100</TransactionReference>
  </LineDetails> 
  <ItemSerialNumbers>
    <ItemCode>TEST-AS1</ItemCode>
  </ItemSerialNumbers> 
  <ItemSerialNumbers> 
    <ItemCode>TEST-MS1</ItemCode>
    <SerialNumbers> 
      <SerialNumber>0000001</SerialNumber>
    </SerialNumbers> 
    <SerialNumbers>
      <SerialNumber>0000002</SerialNumber>
    </SerialNumbers>
    <SerialNumbers>
      <SerialNumber>0000003</SerialNumber>
    </SerialNumbers>
  </ItemSerialNumbers> 
</ReceiptNotesGenerate>

GenerateAndFinish

Driver Type: SASI

This method combines the functionality of the Generate and Finish methods into one method.

GenerateAmendQuantityAndFinish

Driver Type: SASI

This method generates the receipt note, allows the quantity to be amended and then finishes it.

Mandatory fields

Note: The Generate, GenerateWithSerialNumbers and GenerateAndFinish methods require the user line number, whereas the GenerateAmendQuantityAndFinish method requires the system line number. If the orders were created with user line numbers out of sequence, or a line has been deleted, the user and system line numbers may be different so it is important to use the correct line number for each method.

For the Generate, GenerateWithSerialNumbers and GenerateAndFinish methods, values must be supplied for:

Line Number - payload element <LineNumber>
Transaction Reference - payload element <TransactionReference>.

For the GenerateAmendQuantityAndFinish method, a value must be supplied for:

Original Line Number - payload element <OriginalLineNumber>
Original Transaction Reference - payload element <OriginalTransactionReference>.

Note:

If not provided, the value for payload element ValueLabelForQuantity will default to 1. It is the value label ID used for quantity, on the Value child function for the transaction type.
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.