824 Application Advice (007040)

This is the standard X12 007040 spec, with 6 loops and 26 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.

Loading the spec…

The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (97 KB) Generate classes

The ediFabric .NET template, class TS824. It needs the common segments, composites and codes of X12 007040, one download for every transaction in the version. Download C# (1 KB) Common files (233 KB)

The intermediary model ediFabric Native loads with set_map. Download Native (70 KB)

Use the 824 spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read 824 files into TS824 objects. See ediFabric .NET.

ediFabric Native

Map version 007040 to the Native model with set_map, then parse 824 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate 824 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 824 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS824. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

For a sample file, the same data as JSON, and code to parse, validate and generate the 824, see the 824 transaction guide.

824 structure

Loops and segments of the standard 824, with their usage and maximum repeats.

ID	Name	Usage	Max use
ST	Transaction Set Header	Mandatory	1
BGN	BGN	Mandatory	1
Loop N1	N1	Optional	99999
N1	N1	Mandatory	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
REF	REF	Optional	12
PER	PER	Optional	3
Loop OTI	OTI	Mandatory	99999
OTI	OTI	Mandatory	1
REF	REF	Optional	99999
DTM	DTM	Optional	99999
PER	PER	Optional	3
AMT	AMT	Optional	99999
QTY	QTY	Optional	99999
NM1	NM1	Optional	9
Loop TED	TED	Optional	99999
TED	TED	Mandatory	1
CTX	CTX	Optional	10
NTE	NTE	Optional	100
RED	RED	Optional	100
Loop REF	REF	Mandatory	1
REF	REF	Mandatory	1
OOI	OOI	Mandatory	1
BDS	BDS	Mandatory	1
Loop LM	LM	Optional	99999
LM	LM	Mandatory	1
Loop LQ	LQ	Mandatory	100
LQ	LQ	Mandatory	1
RED	RED	Optional	100
SE	Transaction Set Trailer	Mandatory	1