Allocation Markers - 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 prior to executing the payload.
<SunSystemsContext> Used to specify high level information that is used at run time to identify which business unit and ledger table are to be used.
<BusinessUnit> Alphanumeric, length 3 Business unit the business unit in which ledger transactions are to be amended must be specified.
<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.
<AllocationMarkers> High level element that is used to flag the start of an allocation marker data element. A payload file must contain at least one of these. There is no limit to the number of <AllocationMarkers> 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: 0-9, 'A', 'B', 'C', 'F', 'P', 'R', 'S', 'W', 'Y'.
<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: 'C' Credit 'D' Debit.
<DueDate> Date, must be in DDMMYYY format, e.g. 31012003 Due date - this is used as a selection criterion.
Note: 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.
Note:  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.
Note:  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.
<TransactionDateFrom> Alphanumeric.
Note: If you specify an incorrect date, the payload may not be imported into the system.
This is used as selection criteria. The component then only selects transactions taking place from that date.
<TransactionDateTo> Alphanumeric.
Note: If you specify an incorrect date, the payload may not be imported into the system.
This is used as selection criteria. The component then only selects transactions ending on that date.
<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.
Note: 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.
Note: 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.
<AllocationMarker> Alphanumeric, length 1 Specify the allocation marker that you wish the existing value to be amended to. Allowable values are: 0-9, 'F', 'R', and 'W'.
Note: You can only amend an existing non-balancing marker to another non-balancing marker.
<ControlTotal> Numeric, maximum number of digits in total must not exceed 18 and including up to 3 decimal places A control total of summed transaction line values (base currency).
Note: 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.
Note: 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: 'C' Credit, 'D' Debit.
Note: If you specify a <DebitCredit> value you MUST specify a value for <ControlTotal>.
<Increment> Numeric, 1 digit Specify the value by which the existing user-defined allocation marker is to be incremented by. Allowable values: 1-9.
Note: If you specify '1' an existing Allocation Marker value of '0' is amended to '1'. If you specify '3' an existing Allocation Marker value of '4' is amended to '7'.
If you specify an increment value that cannot be applied to a ledger line, an error message is displayed and the transaction is left unchanged. For example, if you specified an increment of '3' and a ledger transaction with an allocation marker value of '8' qualified for selection. Instead of amending the allocation marker value to '11', the component displays an error message and the line is left unchanged.
Note: You cannot specify both an <Increment> AND an <AllocationMarker> within an <Action> element. You MUST only specify one or the other.