SettlObligMode (FIX tag 1159)

intFIX 5.0 SP2

SettlObligMode (tag 1159) is an int field defined in FIX 5.0 SP2. It appears in 1 message type and is required in 1 of them. It is an enumerated field with 2 defined values.

At a glance

Tag
1159
Name
SettlObligMode
Datatype
int
Dialects
FIX 5.0 SP2
Messages
1
Valid values
2

What the specification says

Used to identify the reporting mode of the settlement obligation which is either preliminary or final

Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.

A real message using tag 1159

SettlementObligationReport · FIX 5.0 SP2
TagFieldWire valueMeaning
8BeginStringFIXT.1.1
9BodyLength84
35MsgTypeBQSettlementObligationReport
49SenderCompIDBOARTEAM
56TargetCompIDCOUNTERPARTY
34MsgSeqNum2
52SendingTime20240101-12:00:00.000
1160SettlObligMsgIDEXAMPLE
1159SettlObligMode1Preliminary
10CheckSum179
Edit and decode it yourself

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.

Open in the full decoder →

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.

ValueMeaningSymbolic name
1PreliminaryPRELIMINARY
2FinalFINAL

Where tag 1159 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.

MessageMsgTypeRequirednessWhere in the message
SettlementObligationReportBQRequireddirectly on the message body

Wire format

A whole number, optionally signed. Leading zeros are legal on the wire and are preserved in the raw value. @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 1159 in TypeScript

decode.tsts
import { createFixEngine } from "@boarteam/fix";import { dictionary } from "@boarteam/fix-dict-fix50sp2";const fix = createFixEngine(dictionary);const { message, issues } = fix.parse(raw);const settlObligMode = message.fields[1159]?.raw;// e.g. "1" — Preliminary// The dictionary also carries the labels:const label = fix.dictionary  .fieldByTag(1159)  ?.enumValues?.find((e) => e.value === settlObligMode)  ?.description;

Other int fields

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