NoUnderlyingAmounts (FIX tag 984)
NoUnderlyingAmounts (tag 984) is a NumInGroup field defined in FIX 5.0 SP2. It appears in 1 message type, always optionally. Its datatype is NumInGroup, which makes it a repeating-group counter: its value is the number of entries that follow, not a quantity in its own right.
At a glance
- Tag
- 984
- Name
- NoUnderlyingAmounts
- Datatype
- NumInGroup (int)
- Dialects
- FIX 5.0 SP2
- Messages
- 1
What the specification says
Total number of occurrences of Amount to pay in order to receive the underlying instrument
Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.
A real message using tag 984
| Tag | Field | Wire value | Meaning |
|---|---|---|---|
| 8 | BeginString | FIXT.1.1 | |
| 9 | BodyLength | 141 | |
| 35 | MsgType | AP | PositionReport |
| 49 | SenderCompID | BOARTEAM | |
| 56 | TargetCompID | COUNTERPARTY | |
| 34 | MsgSeqNum | 2 | |
| 52 | SendingTime | 20240101-12:00:00.000 | |
| 721 | PosMaintRptID | EXAMPLE | |
| 715 | ClearingBusinessDate | 20240101 | |
| 711 | NoUnderlyings1 entry | 1 | repeating group |
| 311 | UnderlyingSymbol | EXAMPLE | |
| 984 | NoUnderlyingAmounts2 entries | 2 | repeating group |
| 985 | UnderlyingPayAmount | 125000.00 | |
| 985 | UnderlyingPayAmount | 125000.00 | |
| 10 | CheckSum | 003 |
Shown with | separators for readability. On the wire FIX uses SOH (0x01), an invisible control byte — and because BodyLength and CheckSum are computed over the actual bytes, the two forms have different checksums. Both are valid and both decode here.
Generated from the FIX 5.0 SP2 dictionary and verified at build time: it parses and validates with no issues. Open the decoder to try your own message.
Where tag 984 appears
Requiredness is a property of the message, not of the field: the same tag can be optional in one message and conditionally required in another.
| Message | MsgType | Requiredness | Where in the message |
|---|---|---|---|
| PositionReport | AP | Optional | inside PosUndInstrmtGrp › UnderlyingAmount |
Wire format
The number of entries in the repeating group that follows. The next field on the wire is the group's delimiter tag. @boarteam/fix parses the value as a number and reports parse/invalid-int when it does not lex as one; the raw string is kept either way.
Read tag 984 in TypeScript
import { createFixEngine } from "@boarteam/fix";import { dictionary } from "@boarteam/fix-dict-fix50sp2";const fix = createFixEngine(dictionary);const { message, issues } = fix.parse(raw);// NoUnderlyingAmounts is a group counter, so the entries live on message.groups —// NOT on message.fields. message.fields[984] is undefined.const entries = message.groups[984] ?? [];for (const entry of entries) { // entry.fields is keyed by tag; entry.groups holds nested groups}Other NumInGroup fields
- 981NoExpiration
- 957NoStrategyParameters
- 952NoNested3PartySubIDs
- 1016NoSideTrdRegTS
- 1018NoInstrumentParties
- 948NoNested3PartyIDs
- 938NoCollInquiryQualifier
- 936NoCompIDs
- 1052NoInstrumentPartySubIDs
- 1058NoUndlyInstrumentParties
- 1062NoUndlyInstrumentPartySubIDs
- 897NoTrades
- 887NoUnderlyingStips
- 870NoInstrAttrib
- 864NoEvents
- 862NoCapacities
- 1116NoRootPartyIDs
- 1120NoRootPartySubIDs
- 1141NoMDFeedTypes
- 816NoAltMDSource
- 1158NoSettlDetails
- 809NoUsernames
- 806NoNested2PartySubIDs
- 804NoNestedPartySubIDs
Decode this in your own code
The same engine that produced the decoded example above is an Apache-2.0 npm package with zero runtime dependencies. It runs in Node and in the browser, and parse() returns problems as data instead of throwing.
npm i @boarteam/fix @boarteam/fix-dict-fix50sp2