Supplier

This component runs the Supplier (SUS) function and allows you to set up and maintain supplier details.

Suppliers are used throughout SunSystems. In SunSystems Order Fulfilment, purchase orders and invoices can be entered for suppliers. In Financials, suppliers are used indirectly because they are linked to an associated creditor/payables or client account.

Note: There is a large amount of information that can be maintained for each supplier, some of which is only required if you are using Order Fulfilment. In addition to the predefined details, a supplier may have up to ten analysis codes. You can use these analysis codes to maintain other useful information. For example, you might establish analysis dimension to record product group code to enable you to identify the type of products supplied by the supplier. A creditor/payables account may also have up to ten analysis codes and these may be totally different to the ten supplier analysis codes.

Whilst you can use this component to create and maintain supplier accounts, only the Account and Account Analysis details are available here. If you require finer control of supplier accounts, for example, the entry of Tax or Currency details, you must use the Accounts component methods to import or extract this data.

For multi-line entry in a text field, the XML input payload should include where the linefeed carriage return is required. In order to view the resultant multi-line entry the associated form must be set to multi-line entry.

Methods

Amend
Driver Type: SASI
Use this method to amend one or more suppliers. This method only amends an existing supplier. If the supplier does not exist, an error message is produced and the payload is rejected.
Note: You cannot use this method to amend the status of the supplier. Instead, use one of the Open, Hidden, Suspended/Held or Close methods.
BulkCreateOrAmend
Driver Type: SASI
Use this method for the bulk loading of suppliers or bulk amendment of supplier data, or where performance is critical.
Note: Although the SASI method accepts dates and periods with slashes, the DJI method does not and expects dates in ddmmyyyy format and periods in pppyyyy format.

You cannot use this method to amend the status of the Supplier. Instead, use one of the Open, Hidden, Suspended/Held or Closed methods.

Closed
Driver Type: SASI
Use this method to amend the status of one or more suppliers to Closed.
Create
Driver Type: SASI
Use this method to create one or more suppliers. This method only creates a supplier. If the supplier 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 suppliers
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more suppliers. A supplier is created if it does not exist and amended if it does. Both the Create and Amend methods require you to know in advance if a supplier exists, whereas this method can be used if you are unsure.
Note: You cannot use this method to amend the status of the supplier. Instead, use one of the Open, Hidden, Suspended/Held or Closed methods.
CreateReplaceOrDelete
Driver Type: SASI
Use this method to synchronize suppliers. The supplier is created if it does not exist already and replaced if it does. If the supplier does not exist in the originating business unit, it is deleted.
Delete
Driver Type: SASI
Use this method to delete suppliers.
DeleteChildData
Driver Type: SASI
Use this method to delete child data (Contacts, DocumentFormat, Order Addresses) but retain the parent record (Supplier).
Note: Standard Text should be deleted using the Delete method for the StandardTextLanguageVariants.
Hidden
Driver Type: SASI
Use this method to amend the status of a supplier to Hidden.
Open
Driver Type: SASI
Use this method to amend the status of a supplier to Open.
Query
Driver Type: Export
Use this method to obtain supplier details or to extract supplier data from SunSystems.
Suspended/Held
Driver Type: SASI
Use this method to amend the status of a supplier to Suspended/Held.

Mandatory fields

General
  • When creating, amending, deleting or changing the supplier status, a value must be supplied for Supplier Code - payload element <SupplierCode>.
  • In addition, when creating Supplier details, a value for either Description (payload element <Description>) or Short Heading (payload element <ShortHeading>) must be supplied.
    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.
Supplier Account and Account Analysis
Refer to the Accounts component for the mandatory fields required for the maintenance of Supplier Account details.
Tax Entries
When creating or amending supplier tax entries, a value must be supplied for Sequence Number - payload element <SequenceNumber>.
Supplier Analysis
When creating or amending supplier analysis entries, a value must be supplied for Analysis Code - payload element <VSuppCatAnalysis_AnlCode>.
Document Format Codes
When creating or amending a supplier document format code, a value must be supplied for Document Format Code - payload element <DocumentFormatCode>.
Supplier Contacts
  • When creating or amending a supplier contact, values for the following must be supplied:
    • Contact Identifier - payload element <ContactIdentifier>
    • Address Code - payload element <AddressCode>
    • Supplier Order Address
  • When creating or amending a supplier order address, a value must be supplied for Address Code - payload element <AddressCode>.
Tax Id Validation

Tax Id validation can be defined by means of Event Profiles/Rule Sets – see Administrator Help for details. The Supplier payload includes a flag to control the user response to the duplicate supplier Id message for Amend, Create and CreateOrAmend methods, for example: 

<Supplier>
		<FlagOptions>
				<AllowDuplicateTaxId>1</AllowDuplicateTaxId>
		</FlagOptions>
...
</Supplier>

The values are 0 = No, 1 = Yes. SSC defaults to No if a value is not provided. Duplicate tax Ids are supported for Supplier in SSC provided the Supplier.FlagOptions.AllowDuplicateTaxId tag is set to 1; otherwise SSC will abort if the duplicate tax id message occurs.

Deleting Child Data
  • When deleting child data, a value must be supplied for Supplier Code - payload element <SupplierCode>.
  • When deleting Contact child data, a value must be supplied for:
    • Contact Identifier - payload element <Address_Contact.ContactIdentifier>
    • Address Code - payload element <Address_Contact.AddressCode>
  • When deleting Document Format child data, a value must be supplied for:
    • Purchase Transaction Type - payload element <DocumentFormat.PurchaseTransactionType>
    • Purchase Stage - payload element <DocumentFormat.PurchaseStage>
  • When deleting Order Address child data, a value must be supplied for Purchase Transaction Type - payload element <OrderAddress.AddressCode>.

Related data