HsvICM Object Overview

The HsvICM object enables you to work with intercompany transactions. For example, you can create, match, and unmatch intercompany transactions. For information on setting HsvICM object references and details on the object’s methods, see HsvICM Object Methods.

The following table summarizes the HsvICM object’s methods.

Table 40. HsvICM Object Methods

Method

Description

AllMVTransPosted

Indicates whether all transactions for a given scenario, year, period, and entity that are in a matched state have been posted.

CheckReportSecurity

For internal use.

CreateICTransaction

Creates an intercompany transaction for a given cell.

DeleteICReasonCode

Deletes a reason code.

DoesCellSupportICTransactionDetail

Indicates whether a cell supports intercompany transactions.

GetColumnFilter

For internal use.

GetCurrencyInfo

Returns a currency’s label, translation operator, and scale.

GetEntityCurrencyID

Returns the currency ID of an entity’s default currency.

GetEntitiesContacts

Returns the usernames and security identifiers of the users to be alerted for a given scenario and intercompany transaction-related event for the specified entities.

GetICReasonCodeID

Gets the ID of a reason code.

GetICReasonCodeLabel

Returns a reason code from the code’s internal ID.

GetICReasonCodes

Returns an application’s reason codes and their corresponding IDs and descriptions.

GetICTransactions

Populates an HsvICTransactionsData object reference with intercompany transactions for the scenario, year, and period specified with the HsvICTransactionsData method Initialize.

GetMonitorICDetails

Returns counts of intercompany transactions that have various posting and matching statuses for the specified Scenario, Year, Period, and Entity dimension members.

GetMonitorICSummary

Returns the number of Entity dimension members that have various combinations of locking and process statuses for the given Scenario, Year, Period, and Entity dimension members.

GetMonitorICTransactions

Indicates whether one or more Entity dimension members have intercompany transactions for given Scenario, Year, and Period dimension members. For the entities that have intercompany transactions, GetMonitorICTransactions returns an array that consists of the entities’ member IDs, process and locking statuses, and usernames and timestamps for the most recently modified transactions.

GetRowFilter

For internal use.

GetTransCurrencyID

Returns the currency ID of a given currency.

GetUnMatchTransactions

Populates an HsvICTransactionsData object reference with unmatched intercompany transactions for the scenario, year, and period specified with the HsvICTransactionsData method Initialize.

IsOneSideOfTransactionGroupWriteable

Indicates whether the user has write access to either the entity or Intercompany Partner cell of all transactions in a given range of an HsvICTransactionsData object reference’s transactions.

MatchAutoAccounts

Matches intercompany transactions by account.

MatchAutoIDs

Matches intercompany transactions by Transaction ID or Reference ID.

NoTransMatchedOrPosted

Indicates whether matched or posted transactions exist for a given scenario, year, and period.

  

ProcessAllICTrans

Deletes, posts, unposts, or unmatches all transactions for a given scenario, year, and period.

ProcessICTransactions

Deletes, posts, unposts, or unmatches the specified intercompany transactions for a given scenario, year, and period.

SaveColumnFilter

For internal use.

SaveICReasonCode

Creates a reason code.

SaveICTransaction

Updates an existing transaction.

SaveRowFilter

For internal use.

SetReasonCodeToICTransactions

Sets the reason code for one or more intercompany transactions.

UnMatchICTransactions

Unmatches transactions to which the specified match codes have been assigned.