838 Trading Partner Profile (007040)

This is the standard X12 007040 spec, with 13 loops and 70 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 (145 KB) Generate classes

The ediFabric .NET template, class TS838. 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 (109 KB)

Use the 838 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 838 files into TS838 objects. See ediFabric .NET.

ediFabric Native

Map version 007040 to the Native model with set_map, then parse 838 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 838 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 838 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 TS838. 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.

838 structure

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

ID	Name	Usage	Max use
ST	Transaction Set Header	Mandatory	1
BTP	BTP	Mandatory	1
REQ	REQ	Optional	1
PER	PER	Optional	1
SPI	SPI	Optional	99999
DTM	DTM	Optional	99999
Loop LX	LX	Optional	99999
LX	LX	Mandatory	1
PLA	PLA	Optional	1
LCD	LCD	Optional	99999
LIN	LIN	Optional	99999
Loop N1	N1	Optional	99999
N1	N1	Mandatory	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
N9	N9	Optional	99999
PER	PER	Optional	99999
CUR	CUR	Optional	99999
TAX	TAX	Optional	99999
FOB	FOB	Optional	99999
ITD	ITD	Optional	99999
TD5	TD5	Optional	99999
SPI	SPI	Optional	99999
FBB	FBB	Optional	99999
DTM	DTM	Optional	10
MEA	MEA	Optional	99999
Loop LCD	LCD	Optional	99999
LCD	LCD	Mandatory	1
N2	N2	Optional	1
N4	N4	Optional	1
DMG	DMG	Optional	99999
MEA	MEA	Optional	99999
Loop TPD	TPD	Optional	99999
TPD	TPD	Mandatory	1
N9	N9	Optional	99999
PID	PID	Optional	99999
DTM	DTM	Optional	99999
Loop LS	LS	Optional	1
LS	LS	Mandatory	1
Loop TUD	TUD	Optional	99999
TUD	TUD	Mandatory	1
DTM	DTM	Optional	99999
N1	N1	Optional	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
PER	PER	Optional	99999
LE	LE	Mandatory	1
Loop SPR	SPR	Optional	99999
SPR	SPR	Mandatory	1
N9	N9	Optional	99999
DTM	DTM	Optional	99999
Loop PAM	PAM	Optional	99999
PAM	PAM	Mandatory	1
DTM	DTM	Optional	99999
TAX	TAX	Optional	99999
CUR	CUR	Optional	99999
Loop TXN	TXN	Optional	99999
TXN	TXN	Mandatory	1
N9	N9	Optional	99999
DTM	DTM	Optional	99999
Loop LM	LM	Optional	99999
LM	LM	Mandatory	1
LQ	LQ	Mandatory	99999
Loop ENE	ENE	Optional	99999
ENE	ENE	Mandatory	1
Loop N1	N1	Optional	99999
N1	N1	Mandatory	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
TPD	TPD	Optional	99999
PID	PID	Optional	99999
N9	N9	Optional	99999
PER	PER	Optional	99999
Loop TXN	TXN	Optional	99999
TXN	TXN	Mandatory	1
N9	N9	Optional	99999
DTM	DTM	Optional	99999
ERI	ERI	Optional	99999
AMT	AMT	Optional	99999
SE	Transaction Set Trailer	Mandatory	1