TimeUnit (FIX tag 997)
TimeUnit (tag 997) is a String field defined in FIX 5.0 SP2. It appears in 72 message types, always optionally. It is an enumerated field with 7 defined values.
At a glance
- Tag
- 997
- Name
- TimeUnit
- Datatype
- String
- Dialects
- FIX 5.0 SP2
- Messages
- 72
- Valid values
- 7
What the specification says
Unit of time associated with the contract.
Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.
A real message using tag 997
| Tag | Field | Wire value | Meaning |
|---|---|---|---|
| 8 | BeginString | FIXT.1.1 | |
| 9 | BodyLength | 117 | |
| 35 | MsgType | D | NewOrderSingle |
| 49 | SenderCompID | BOARTEAM | |
| 56 | TargetCompID | COUNTERPARTY | |
| 34 | MsgSeqNum | 2 | |
| 52 | SendingTime | 20240101-12:00:00.000 | |
| 11 | ClOrdID | ORD-10042 | |
| 997 | TimeUnit | H | Hour |
| 54 | Side | 1 | Buy |
| 60 | TransactTime | 20240101-12:00:00.000 | |
| 40 | OrdType | 1 | Market |
| 10 | CheckSum | 115 |
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.
Valid values
A value outside this list is not a parse error — the message still decodes — but validate() reports it as validate/value-not-in-enum.
| Value | Meaning | Symbolic name |
|---|---|---|
| H | Hour | HOUR |
| Min | Minute | MINUTE |
| S | Second | SECOND |
| D | Day | DAY |
| Wk | Week | WEEK |
| Mo | Month | MONTH |
| Yr | Year | YEAR |
Where tag 997 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 |
|---|---|---|---|
| AdjustedPositionReport | BL | Optional | inside InstrmtGrp › Instrument |
| Advertisement | 7 | Optional | inside the Instrument component |
| AllocationInstruction | J | Optional | inside the Instrument component |
| AllocationInstructionAlert | BM | Optional | inside the Instrument component |
| AllocationReport | AS | Optional | inside the Instrument component |
| AssignmentReport | AW | Optional | inside the Instrument component |
| CollateralAssignment | AY | Optional | inside the Instrument component |
| CollateralInquiry | BB | Optional | inside the Instrument component |
| CollateralInquiryAck | BG | Optional | inside the Instrument component |
| CollateralReport | BA | Optional | inside the Instrument component |
| CollateralRequest | AX | Optional | inside the Instrument component |
| CollateralResponse | AZ | Optional | inside the Instrument component |
| Confirmation | AK | Optional | inside the Instrument component |
| ContraryIntentionReport | BO | Optional | inside the Instrument component |
| CrossOrderCancelReplaceRequest | t | Optional | inside the Instrument component |
| CrossOrderCancelRequest | u | Optional | inside the Instrument component |
| DerivativeSecurityList | AA | Optional | inside RelSymDerivSecGrp › Instrument |
| DerivativeSecurityListUpdateReport | BR | Optional | inside RelSymDerivSecUpdGrp › Instrument |
| DontKnowTrade | Q | Optional | inside the Instrument component |
| C | Optional | inside InstrmtGrp › Instrument | |
| ExecutionAcknowledgement | BN | Optional | inside the Instrument component |
| ExecutionReport | 8 | Optional | inside the Instrument component |
| IOI | 6 | Optional | inside the Instrument component |
| ListStrikePrice | m | Optional | inside InstrmtStrkPxGrp › Instrument |
| MarketDataIncrementalRefresh | X | Optional | inside MDIncGrp › Instrument |
| MarketDataRequest | V | Optional | inside InstrmtMDReqGrp › Instrument |
| MarketDataSnapshotFullRefresh | W | Optional | inside the Instrument component |
| MassQuote | i | Optional | inside QuotSetGrp › QuotEntryGrp › Instrument |
| MassQuoteAcknowledgement | b | Optional | inside QuotSetAckGrp › QuotEntryAckGrp › Instrument |
| MultilegOrderCancelReplace | AC | Optional | inside the Instrument component |
| NewOrderCross | s | Optional | inside the Instrument component |
| NewOrderList | E | Optional | inside ListOrdGrp › Instrument |
| NewOrderMultileg | AB | Optional | inside the Instrument component |
| NewOrderSingle | D | Optional | inside the Instrument component |
| News | B | Optional | inside InstrmtGrp › Instrument |
| OrderCancelReplaceRequest | G | Optional | inside the Instrument component |
| OrderCancelRequest | F | Optional | inside the Instrument component |
| OrderMassActionReport | BZ | Optional | inside the Instrument component |
| OrderMassActionRequest | CA | Optional | inside the Instrument component |
| OrderMassCancelReport | r | Optional | inside the Instrument component |
| OrderMassCancelRequest | q | Optional | inside the Instrument component |
| OrderMassStatusRequest | AF | Optional | inside the Instrument component |
| OrderStatusRequest | H | Optional | inside the Instrument component |
| PositionMaintenanceReport | AM | Optional | inside the Instrument component |
| PositionMaintenanceRequest | AL | Optional | inside the Instrument component |
| PositionReport | AP | Optional | inside the Instrument component |
| Quote | S | Optional | inside the Instrument component |
| QuoteCancel | Z | Optional | inside QuotCxlEntriesGrp › Instrument |
| QuoteRequest | R | Optional | inside QuotReqGrp › Instrument |
| QuoteRequestReject | AG | Optional | inside QuotReqRjctGrp › Instrument |
| QuoteResponse | AJ | Optional | inside the Instrument component |
| QuoteStatusReport | AI | Optional | inside the Instrument component |
| QuoteStatusRequest | a | Optional | inside the Instrument component |
| RFQRequest | AH | Optional | inside RFQReqGrp › Instrument |
| RequestForPositions | AN | Optional | inside the Instrument component |
| RequestForPositionsAck | AO | Optional | inside the Instrument component |
| SecurityDefinition | d | Optional | inside the Instrument component |
| SecurityDefinitionRequest | c | Optional | inside the Instrument component |
| SecurityDefinitionUpdateReport | BP | Optional | inside the Instrument component |
| SecurityList | y | Optional | inside SecListGrp › Instrument |
| SecurityListRequest | x | Optional | inside the Instrument component |
| SecurityListUpdateReport | BK | Optional | inside SecLstUpdRelSymGrp › Instrument |
| SecurityStatus | f | Optional | inside the Instrument component |
| SecurityStatusRequest | e | Optional | inside the Instrument component |
| SettlementObligationReport | BQ | Optional | inside SettlObligationInstructions › Instrument |
| StreamAssignmentReport | CD | Optional | inside StrmAsgnRptGrp › StrmAsgnRptInstrmtGrp › Instrument |
| StreamAssignmentRequest | CC | Optional | inside StrmAsgnReqGrp › StrmAsgnReqInstrmtGrp › Instrument |
| TradeCaptureReport | AE | Optional | inside the Instrument component |
| TradeCaptureReportAck | AR | Optional | inside the Instrument component |
| TradeCaptureReportRequest | AD | Optional | inside the Instrument component |
| TradeCaptureReportRequestAck | AQ | Optional | inside the Instrument component |
| TradingSessionStatus | h | Optional | inside the Instrument component |
Wire format
Free-form text. Any byte except the SOH separator is legal, so values are not trimmed or case-folded on the wire. @boarteam/fix keeps the value as a string; format rules are checked by validate(), which reports validate/invalid-value rather than throwing.
Read tag 997 in TypeScript
import { createFixEngine } from "@boarteam/fix";import { dictionary } from "@boarteam/fix-dict-fix50sp2";const fix = createFixEngine(dictionary);const { message, issues } = fix.parse(raw);const timeUnit = message.fields[997]?.raw;// e.g. "H" — Hour// The dictionary also carries the labels:const label = fix.dictionary .fieldByTag(997) ?.enumValues?.find((e) => e.value === timeUnit) ?.description;Other String fields
- 996UnitOfMeasure
- 998UnderlyingUnitOfMeasure
- 999LegUnitOfMeasure
- 994TierCode
- 1000UnderlyingTimeUnit
- 993AllocCustomerCapacity
- 1001LegTimeUnit
- 1003TradeID
- 990LegReportID
- 989SecondaryIndividualAllocID
- 1005SideTradeReportID
- 988UnderlyingSettlementStatus
- 1006SideFillStationCd
- 1007SideReasonCd
- 1011MessageEventSource
- 1014SideTrdRegTimestampSrc
- 979InputSource
- 977ContIntRptID
- 1019InstrumentPartyID
- 974UnderlyingCashType
- 1022MDFeedType
- 966SettleOnOpenFlag
- 965SecurityStatus
- 1030ReceivedDeptID
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