Accounts

Methods

Amend

Driver Type: SASI

Use this method to amend one or more accounts. If an account 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 account. Instead, use one of the Open, Hidden, Suspended, Held or Closed methods.

BulkCreateOrAmend

Driver Type: DJI

Use this method for the bulk loading of data or bulk amendment of 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 account. Instead, use one of the Open, Hidden, SuspendedHeld or Closed methods.

Note: The DJI bulk Create or Amend component for Accounts replicates, but does not run, the SunSystems Chart of Accounts (COA) function. The DJI bulk Create or Amend method and the non DJI Create or Amend method generally perform the same validation rules, but the DJI method is faster when importing a large number of data records. DJI bulk imports do not apply rules defined in Rule Sets. If user business rules are required, they must be defined in a transformation attached to the transfer profile.

Closed

Driver Type: SASI

Use this method to amend the status of one or more accounts to Closed.

Create

Driver Type: SASI

Use this method to create one or more accounts. If an account 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 accounts.

CreateOrAmend

Driver Type: SASI

Use this method to create or amend one or more accounts. An account 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 the account already exists, whereas this method can be used if you are unsure.

Note: You cannot use this method to amend the status of the account. Instead, use one of the Open, Hidden, SuspendedHeld or Closed methods.

CreateReplaceOrDelete

Driver Type: SASI

Use this method to synchronize one or more accounts. An account is created if it does not exist already and replaced if it does. If the account does not exist in the originating business unit, it is deleted.

Delete

Driver Type: SASI

Use this method to delete one or more accounts.

DeleteChildData

Driver Type: SASI

Use this method to delete child data (Disallowed Currency Codes) but retain the parent record (Chart of Accounts).

Note: Standard Text should be deleted using the Delete method for the StandardTextLanguageVariants component .

Hidden

Driver Type: SASI

Use this method to amend the status of one or more accounts to Hidden.

Query

Driver Type: Export

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

Open

Driver Type: SASI

Use this method to amend the status of one or more accounts to Open.

SuspendedHeld

Driver Type: SASI

Use this method to amend the status of one or more accounts to Suspended/Held.

Mandatory fields

Some payload elements are mandatory, depending on the method you are using, or the data that is present.

For all methods, a value must be supplied for Account Code - payload element <AccountCode> except for the Query method where it is optional.

Account Analysis

When creating or amending Analysis entries, a value must be supplied for:

• Analysis Code - payload element <VAcntCatAnalysis_AnlCode>
• Short Heading - payload element <VAcntCatAnalysis_SHead>

Bank Currency

When creating or amending Account Bank Currency details, a value must be supplied for:

• Account Bank Currency - payload element <AccountBankCurrency.CurrencyCode>

Deleting Child Data

When deleting child data, a value must be supplied for:

• Account Code - payload element <AccountCode>

• Account Bank Currency - payload element <AccountBankCurrency.CurrencyCode>

Related data

• Standard Text and Standard Text Language
• Account Analysis 1-10
• Bank Currency

The attachment of Standard Text is supported by the Create, Amend and CreateOrAmend methods only, and not by BulkCreateOrAmend. 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:

<Accounts>
		...
		<StandardText>
				<StandardTextLang>
						<LanguageCode>1</LanguageCode>
						<StandardTextClassCode>STD</StandardTextClassCode>
						<StandardTextCode>DELIV</StandardTextCode>
			 </StandardTextLang>
  </StandardText>
</Accounts>