ReconciliationProfiles

This component runs the Reconciliation Profiles (RCP) function and is used to define transaction selection criteria and match criteria for use in Reconciliation Manager.

Methods

Closed
Driver Type: SASI
Use this method to change the status of a reconciliation profile to Closed.
CreateAsDraft
Driver Type: SASI
Use this method to create one or more draft reconciliation profiles.
CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more reconciliation profiles. A reconciliation profile is created if it does not exist and amended if it does.
Delete
Driver Type: SASI
This method allows you to retrieve a reconciliation profile and deletes it.
Hidden
Driver Type: SASI
Use this method to change the status of a reconciliation profile to Hidden.
Open
Driver Type: SASI
Use this method to change the status of a reconciliation profile to Open.
Query
Driver Type: Export
This method allows you to extra reconciliation profiles from SunSystems.
Suspended/Held
Driver Type: SASI
Use this method to change the status of a reconciliation profile to Suspended/Held.

Mandatory fields

  • For all methods except Query, a value must be supplied for the Profile Code - payload element <ReconciliationProfiles/ProfileCode>
  • When using CreateOrAmend to maintain standard text, values must be supplied for the following:

    • <ReconciliationProfiles/StandardText/StandardTextLang/LanguageCode>

    • <ReconciliationProfiles/StandardText/StandardTextLang/StandardTextClassCode>

    • <ReconciliationProfiles/StandardText/StandardTextLang/StandardTextCode>

Note: 
  • 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.
  • 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

  • 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:

<ReconciliationProfiles>
	...
		<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>
</ReconciliationProfiles>