ValueBooks

This component runs the Value Book (VBS) function and allows you to set up and maintain value books.

Note: Value Book pages are maintained using the SunSystems Sales Value Book Pages (VBP) function or via payloads using the ValueBookPages component.

Methods

CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more value books. A value book is created if it does not exist and amended if it does.
Query
Driver Type: Export
Use this method to obtain value book details or to extract value book data from SunSystems. In your query you must set Price Book Type - payload element <PriceBookType> to '3'.

Mandatory fields

When creating or amending a value book, a value must be supplied for the Value Book Definition Code - payload element <ValueBookDefinitionCode>.

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.

Related data

  • Value Book Analysis
  • Sales Price Book Analysis
  • Standard Text
  • Standard Text Language

The attachment of Standard Text is supported by the CreateOrAmend method. If the standard text supplied in the payload does not exist then it is created. However, it is not possible to amend existing standard text by this means; existing standard text is attached by key only, and any non-key fields in the SSC payload are ignored. Standard text can be amended using the Standard Text Language Variants function from SunSystems or the SSC component StandardTextLanguageVariants.

The standard text to be attached is language specific and therefore must be included within the StandardTextLang part of the payload in order to be detected by the SSC component, as shown in the following example:

<ValueBooks>
	...
		<StandardText>
			<StandardTextLang>
				<Description>Delivery</Description>
				<LanguageCode>1</LanguageCode>
				<Paragraph1>Follow the special Instructions on the Invoice</Paragraph1>
				<ShortHeading>Delivery</ShortHeading>
				<StandardTextClassCode>SALES</StandardTextClassCode>
				<StandardTextCode>DELIVERY</StandardTextCode>
			</StandardTextLang>
		</StandardText>
</ValueBooks>