ValidateLineItems

Validates whether the values passed would define a valid journal.

The journal line item data is passed as arrays; these arrays must have a one-to-one correspondence. ValidateLineItems returns an array of error numbers that corresponds to these arrays of line item data.

Syntax

<IHsvJournalsEx>.ValidateLineItems lScenarioID, lYear, lPeriod, lValueID, lJournalID, sJournalType, sBalanceAttribute, lSingleEntity, lSingleParent, vararlLineItemID, vararlEntityID, vararlParent, vararlAccount, vararlICP, vararlCustom1, vararlCustom2, vararlCustom3, vararlCustom4, vararnDebitCreditUnit, varabstrAmount, pvarHRLineItems

Argument

Description

lScenarioID

Long (ByVal). The member ID of the Scenario dimension member.

lYear

Long (ByVal). The member ID of the Year dimension member.

lPeriod

Long (ByVal). The member ID of the Period dimension member.

lValueID

Long (ByVal). The member ID of the Value dimension member.

lJournalID

Long (ByVal). Pass 0 (zero) to this argument.

sJournalType

Integer (ByVal). Specifies the journal’s type. Pass one of the HFMConstants type library constants listed in Journal Type Constants.

sBalanceAttribute

Integer (ByVal). Specifies whether the journal must be balanced. Pass one of the HFMConstants type library constants listed in Balance Type Constants.

lSingleEntity

Long (ByVal). For single entity journals, specify the member ID of the journal’s base entity. For multi-entity journals, pass a value of -1.

lSingleParent

Long (ByVal). For single entity journals, specify the member ID of the journal’s parent entity. For multi-entity journals, pass a value of -1.

vararlLineItemID

Long array (ByVal). The line numbers of the journal line items.

vararlEntityID

Long array (ByVal). The member IDs of the line items’ child Entity dimension members.

vararlParent

Long array (ByVal). The member IDs of the line items’ parent Entity dimension members.

vararlAccount

Long array (ByVal). The member IDs of the line items’ Account dimension members.

vararlICP

Long array (ByVal). The member IDs of the line items’ Intercompany Partner dimension members.

vararlCustom1

Long array (ByVal). The member IDs of the line items’ Custom 1 dimension members.

vararlCustom2

Long array (ByVal). The member IDs of the line items’ Custom 2 dimension members.

vararlCustom3

Long array (ByVal). The member IDs of the line items’ Custom 3 dimension members.

vararlCustom4

Long array (ByVal). The member IDs of the line items’ Custom 4 dimension members.

vararnDebitCreditUnit

Integer array (ByVal). A flag that determines whether the line items are debits or credits. Pass one of the HFMConstants type library constants listed in Debit/Credit Constants.

varabstrAmount

String array (ByVal). The amounts of the line items.

pvarHRLineItems

Variant array. Returns the Financial Management error numbers that correspond to the line items. If a line item is valid, the corresponding item in this array has a value of 0; otherwise, the array item has a non-zero error number.

Tip:

To look up a description of a Financial Management error number, use the utility described in Error Message Lookup Utility.