LedgerInterface

Methods

Closed

Driver Type: SASI

Use this method to change the status of one or more ledger interface records to Closed.

CreateAsDraft

Driver Type: SASI

Use this method to create one or more draft ledger interface configurations.

CreateOrAmend

Driver Type: SASI

Use this method to create or amend one or more ledger interface configuration. A ledger interface record is created if it does not exist and amended if it does.

Delete

Driver Type: SASI

Use this method to delete journal transfer configuration data from SunSystems.

DeleteChildData

Driver Type: SASI

Use this method to delete child data (Line Details) but retain the parent record (Ledger Interface).

Hidden

Driver Type: SASI

Use this method to change the status of one or more ledger interface records to Hidden.

Open

Driver Type: SASI

Use this method to change the status of one or more ledger interface records to Open.

Query

Driver Type: Export

Use this method to obtain journal transfer configuration details or to extract journal transfer configuration data from SunSystems.

SuspendedHeld

Driver Type: SASI

Use this method to change the status of one or more ledger interface records to Suspended/Held.

Mandatory fields

General

• For all methods other than Query, a value must be supplied for Ledger Interface Definition Code - payload element <LedgerInterfaceDefinitionCode>.
• When creating or amending a ledger interface detail line, supply the Ledger Interface Line Number - payload element <LineDetails.LedgerInterfaceLineNumber>.
• When creating or amending Transfer Data, the following must be supplied for each subsection of Transfer Data you have included in the payload:
  • Transfer Data Language Code - payload element <TransferData.Code.LanguageCode>
  • Transfer Data Code Description - payload element <TransferData.Code.Description>

  For example:

  <TransferData>
     <Transaction Reference>
      <Code>
        <Description>TRANSREF</Description>
        <LanguageCode>33</LanguageCode>
      </Code>
    </Transaction Reference>
  </TransferData>

  Note: Values for Language Code and Description must be provided, or an error will be returned. The data entered must use the same language code as the SSC operator.

Deleting Child Data

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

• Ledger Interface Definition Code - payload element <LedgerInterfaceDefinitionCode>
• Ledger Interface Line Number - payload element <LineDetails.LedgerInterfaceLineNumber>

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

• Line Details
• Transfer Data
• Value Labels
• Analysis (Suppression).