HoldingActualsReset

This message clears out the fields from Holding records that would not be unloaded from the engine and represent the metrics for the actual activity accrued against that Holding since actuals were last reset.

This procesing will have no affect on any of the "Planned" or "Unconfirmed" activities.

The Holdings that will be affected depends on the parameters provided in the message. The message user must have SetBalance permisssion over all Accounts.

The available options for specifying the Holdings are:

  • Id - the single Holding will have its metrics reset. changed. The other fields in the message are ignored.
  • Account - All Holdings for the Account will be reset. This is the Id of the Account for which the Holdings are to be reset.
  • Market Holdings for the specified Market have their metrics reset. A Holding will qualify if there is an InstrumentMarket in the nominated Market attached to the Instrument to which the Holding relates.
  • InstrumentGroup Holdings for the specified InstrumentGroup have their metrics reset
  • Instrument Holdings for the specified Instrument have metrics reset
  • InstrumentMarket Holdings for the Instrument from the specified InstrumentMarket have their metrics reset
  • Firm - All Holdings from the specified Firm will have their metrics reset

If nothing is specified, all Holdings will have their metrics reset. The Holdings changed are only those of which the User has permission to change the balance.

Metadata

  • Message Type: TransactionMessage
  • Message Number: 1158

Inherited fields

NameTypeSize (bytes)Description
MessageTypeInteger (unsigned)2The unique identifier of this message.
ClientIdInteger (unsigned)4The unique identifier of a session with the server, returned in a successful LoginReply message.
RequestIdInteger (unsigned)4Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session.

Fields

NameTypeSize (bytes)Description
HoldingForeign key to Holding8If the metrics are to be reset for a specific Holding, this is the Id of the Holding for which the metrics should be reset.
FirmForeign key to Firm8If the Holdings to be consolidated are from a specific Firm only, this is the Id of the Firm.
AccountCodeString40If the Holdings to be consolidated are from a specific Account only, this is the AccountCode of the Account that will be used in conjunction with the Firm to resolve a specific Account.
AccountForeign key to Account8If the Holdings to be consolidated are from a specific Account only, this is the Id of the Account.
MarketForeign key to Market8If the Holdings to be consolidated are from a specific Market only, this is the Id of the Market.
InstrumentGroupForeign key to InstrumentGroup8If the Holdings to be consolidated are from a specific InsrumentGroup only, this is the Id of the Instrument.
InstrumentForeign key to Instrument8If the Holdings to be consolidated are from a specific Instrument only, this is the Id of the Instrument.