CustOrderHandlingInst (FIX tag 1031)
CustOrderHandlingInst (tag 1031) is a MultipleStringValue field defined in FIX 5.0 SP2. It appears in 3 message types, always optionally. It is an enumerated field with 24 defined values.
At a glance
- Tag
- 1031
- Name
- CustOrderHandlingInst
- Datatype
- MultipleStringValue (String)
- Dialects
- FIX 5.0 SP2
- Messages
- 3
- Valid values
- 24
What the specification says
Codes that apply special information that the Broker / Dealer needs to report, as specified by the customer.
Descriptions are quoted from the FIX Orchestra sources under the Apache 2.0 licence.
A real message using tag 1031
| Tag | Field | Wire value | Meaning |
|---|---|---|---|
| 8 | BeginString | FIXT.1.1 | |
| 9 | BodyLength | 120 | |
| 35 | MsgType | D | NewOrderSingle |
| 49 | SenderCompID | BOARTEAM | |
| 56 | TargetCompID | COUNTERPARTY | |
| 34 | MsgSeqNum | 2 | |
| 52 | SendingTime | 20240101-12:00:00.000 | |
| 11 | ClOrdID | ORD-10042 | |
| 54 | Side | 1 | Buy |
| 60 | TransactTime | 20240101-12:00:00.000 | |
| 40 | OrdType | 1 | Market |
| 1031 | CustOrderHandlingInst | ADD | Add-on order |
| 10 | CheckSum | 010 |
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 |
|---|---|---|
| ADD | Add-on order | ADD_ON_ORDER |
| AON | All or none | ALL_OR_NONE |
| CNH | Cash not held | CASH_NOT_HELD |
| DIR | Directed order | DIRECTED_ORDER |
| E.W | Exchange for physical transaction | EXCHANGE_FOR_PHYSICAL_TRANSACTION |
| FOK | Fill or kill | FILL_OR_KILL |
| IO | Imbalance only | IMBALANCE_ONLY |
| IOC | Immediate or cancel | IMMEDIATE_OR_CANCEL |
| LOO | Limit on open | LIMIT_ON_OPEN |
| LOC | Limit on Close | LIMIT_ON_CLOSE |
| MAO | Market at Open | MARKET_AT_OPEN |
| MAC | Market at close | MARKET_AT_CLOSE |
| MOO | Market on open | MARKET_ON_OPEN |
| MOC | Market on close | MARKET_ON_CLOSE |
| MQT | Minimum quantity | MINIMUM_QUANTITY |
| NH | Not held | NOT_HELD |
| OVD | Over the day | OVER_THE_DAY |
| PEG | Pegged | PEGGED |
| RSV | Reserve size order | RESERVE_SIZE_ORDER |
| S.W | Stop stock transaction | STOP_STOCK_TRANSACTION |
| SCL | Scale | SCALE |
| TMO | Time order | TIME_ORDER |
| TS | Trailing stop | TRAILING_STOP |
| WRK | Work | WORK |
Where tag 1031 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 |
|---|---|---|---|
| ExecutionReport | 8 | Optional | directly on the message body |
| NewOrderSingle | D | Optional | directly on the message body |
| OrderCancelReplaceRequest | G | Optional | directly on the message body |
Wire format
Several values in one field, separated by spaces. Decoders return an array. @boarteam/fix splits the value on its delimiter and returns an array of strings.
Read tag 1031 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 custOrderHandlingInst = message.fields[1031]?.raw;// e.g. "ADD" — Add-on order// The dictionary also carries the labels:const label = fix.dictionary .fieldByTag(1031) ?.enumValues?.find((e) => e.value === custOrderHandlingInst) ?.description;Other MultipleStringValue 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