Input Payload Element Definitions
Payload elements are defined as follows:
| Element | Type | Description |
|---|---|---|
<SSC> |
Top level element. | |
<User> |
User element. | |
<Name> |
Alphanumeric, length 3 | User name. Specify the user ID under which the payload is run. This user Id must be already set up in SunSystems using Security Console or User Manager prior to executing the payload. |
<SunSystemsContext> |
Used to specify high level information that is used at runtime to identify which business unit and ledger table are to be used. | |
<BusinessUnit> |
Alphanumeric, length 3 | Business unit specify the business unit in for which ledger
transactions are to be amended.
Nota: If this element value is blank, the
component defaults to the demonstration PKP business
unit.
|
<BudgetCode> |
Alphabetic, length 1 | Budget code specify which Ledger Budget Code for the transactions that are to be amended. |
<Payload> |
High level element that is used to flag the start of the data. A
payload file only contains one <Payload> element.
|
|
<LedgerUpdate> |
High level element that is used to flag the start of a
LedgerUpdate data element. A payload file must
contain at least one of these. There is no limit to the number of
<LedgerUpdate> that can be present within a
<Payload> element.
|
|
<AllocationMarker> |
Alphanumeric, length 1 | This is used as a selection criterion. Specify the allocation marker
value that you wish to amend. The component then only selects ledger
transactions that have this value. Allowable values are:
|
<AnalysisCode1> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode2> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode3> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode4> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode5> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode6> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode7> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode8> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode9> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<AnalysisCode10> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This is used as a selection criterion. The component then only selects transactions that have this value. |
<BaseAmount> |
Numeric, maximum number of digits in total must not exceed 18 and including up to 3 decimal places | Transaction line value (base currency) - this is used as a selection criterion. The component then only selects transactions that have this value. |
<DebitCredit> |
Alphabetic, length 1 | Debit credit indicator - this is used as a selection criterion. The
component then only selects transactions that have this value. Allowable
values are:
|
<DueDate> |
Date, must be in DDMMYYY format, e.g.
31012003
|
Used as a selection criterion.
Nota: The component selects all transactions that have a
due date that is earlier or equal to this value.
|
<JournalLineNumber> |
Numeric, must be greater than zero and less than 1000000000 | Journal line number this is used as a selection criterion. The
component then only selects transactions that have this
value.
Nota: SunSystems does not allow you to create more than
999,999,999 journal lines for a single journal.
|
<JournalNumber> |
Numeric, must be greater than zero and less than 1000000000 | Journal number - this is used as a selection criterion. The component
then only selects transactions that have this value.
Nota: SunSystems
does not allow you to create more than 999,999,999
Journals.
|
<JournalType> |
Alphanumeric, length 5 | Journal type - this is used as a selection criterion. The component then only selects transactions that have this value. |
<TransactionAmount> |
Numeric, maximum number of digits in total must not exceed 18, including up to 3 decimal places | Transaction line value (transaction currency) - this is used as a selection criterion. The component then only selects transactions that have this value. |
<TransactionReference> |
Alphanumeric, length 30 | Transaction reference this is used as a selection criterion. The component then only selects transactions that have this value. |
<AccountRange> |
High level element used to specify an account code range, from which ledger transactions are selected. | |
<AccountCodeFrom> |
Alphanumeric, length 15 | From account code - this is used as a selection criterion. The
component then only selects transactions that have this value. Specify
the start of the account code range that you wish to use.
Nota: If you
wish to specify a single account code, then set
<AccountCodeFrom> and
<AccountCodeTo> to the same
value.
|
<AccountCodeTo> |
Alphanumeric, length 15 | To account code - this is used as a selection criterion. The
component then only selects transactions that have this value. Specify
the end of the account code range that you wish to use.
Nota: If you wish
to specify a single account code, then set
<AccountCodeFrom> and
<AccountCodeTo> to the same
value.
|
<Actions> |
High level element used to specify what action(s) you want to apply to your selected ledger transactions. | |
<AnalysisCode1> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode2> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode3> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode4> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode5> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode6> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode7> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode8> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode9> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<AnalysisCode10> |
Alphanumeric, length 15 | Analysis value for given analysis dimension applicable for the ledger transaction. This should be the value that you want it changed to. |
<ControlTotal> |
Numeric, maximum number of digits in total must not exceed 18 and including up to 3 decimal places | control total of summed transaction line values (base currency).
Nota: You must manually calculate the figure to be
specified. If the specified figure differs from the sum calculated
by the component at run time, an error is returned and the
transaction lines are unchanged.
Nota: If you specify a control total value, you must
specify a value for
<DebitCredit>.
|
<DebitCredit> |
Alphabetic, length 1 | Debit credit indicator this is used with ControlTotal to specify whether the ControlTotal value is debit or credit.
Allowable values are:
Nota: If you specify a
<DebitCredit> value you must specify a value for
<ControlTotal>.
|
<Description> |
Alphabetic, length 50 | The descriptive text associated with a transaction. |