811 Consolidated Service Invoice/Statement (007020)

This is the standard X12 007020 spec, with 30 loops and 138 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 (182 KB) Generate classes

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

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

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

ediFabric Native

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

ediFabric Native returns each 811 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 TS811. 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.

811 structure

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

ID	Name	Usage	Max use
ST	Transaction Set Header	Mandatory	1
BIG	BIG	Mandatory	1
NTE	NTE	Optional	100
CUR	CUR	Optional	1
REF	REF	Optional	99999
PER	PER	Optional	3
ITD	ITD	Optional	99999
DTM	DTM	Optional	10
TXI	TXI	Optional	99999
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
DMG	DMG	Optional	1
Loop FA1	FA1	Optional	99999
FA1	FA1	Mandatory	1
FA2	FA2	Mandatory	99999
Loop HL	HL	Mandatory	99999
HL	HL	Mandatory	1
Loop LX	LX	Optional	99999
LX	LX	Mandatory	1
VEH	VEH	Optional	1
SI	SI	Optional	8
PID	PID	Optional	200
MEA	MEA	Optional	20
REF	REF	Optional	99999
AMT	AMT	Optional	99999
DTM	DTM	Optional	8
TXI	TXI	Optional	99999
Loop QTY	QTY	Optional	10
QTY	QTY	Mandatory	1
SI	SI	Optional	1
Loop NM1	NM1	Optional	1
NM1	NM1	Mandatory	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
REF	REF	Optional	99999
PER	PER	Optional	99999
TXI	TXI	Optional	99999
DMG	DMG	Optional	1
Loop ITA	ITA	Optional	99999
ITA	ITA	Mandatory	1
DTM	DTM	Optional	1
REF	REF	Optional	5
Loop IT1	IT1	Optional	999999
IT1	IT1	Mandatory	1
SI	SI	Optional	2
PID	PID	Optional	200
MEA	MEA	Optional	20
INC	INC	Optional	1
TXI	TXI	Optional	99999
REF	REF	Optional	99999
DTM	DTM	Optional	10
MSG	MSG	Optional	99999
CAD	CAD	Optional	1
YNQ	YNQ	Optional	99999
LQ	LQ	Optional	99999
LCD	LCD	Optional	99999
Loop AMT	AMT	Optional	99999
AMT	AMT	Mandatory	1
DTM	DTM	Optional	1
Loop QTY	QTY	Optional	99999
QTY	QTY	Mandatory	1
SI	SI	Optional	1
Loop ITA	ITA	Optional	99999
ITA	ITA	Mandatory	1
DTM	DTM	Optional	1
REF	REF	Optional	5
Loop NM1	NM1	Optional	99999
NM1	NM1	Mandatory	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
PER	PER	Optional	3
NX2	NX2	Optional	99999
DMG	DMG	Optional	1
REF	REF	Optional	99999
LCD	LCD	Optional	99999
Loop SLN	SLN	Optional	99999
SLN	SLN	Mandatory	1
SI	SI	Optional	2
PID	PID	Optional	200
MEA	MEA	Optional	20
CUR	CUR	Optional	1
INC	INC	Optional	1
ITA	ITA	Optional	10
TXI	TXI	Optional	99999
REF	REF	Optional	99999
PER	PER	Optional	3
DTM	DTM	Optional	10
AMT	AMT	Optional	15
MSG	MSG	Optional	99999
Loop QTY	QTY	Optional	99999
QTY	QTY	Mandatory	1
SI	SI	Optional	1
Loop NM1	NM1	Optional	99999
NM1	NM1	Mandatory	1
N2	N2	Optional	2
N3	N3	Optional	2
N4	N4	Optional	1
REF	REF	Optional	8
PER	PER	Optional	3
DMG	DMG	Optional	1
Loop TCD	TCD	Optional	99999
TCD	TCD	Mandatory	1
SI	SI	Optional	2
TXI	TXI	Optional	99999
ITA	ITA	Optional	99999
Loop QTY	QTY	Optional	99999
QTY	QTY	Mandatory	1
SI	SI	Optional	1
Loop USD	USD	Optional	99999
USD	USD	Mandatory	1
SI	SI	Optional	2
ITA	ITA	Optional	2
TRF	TRF	Optional	18
Loop QTY	QTY	Optional	99999
QTY	QTY	Mandatory	1
SI	SI	Optional	1
Loop III	III	Optional	99999
III	III	Mandatory	1
DTP	DTP	Optional	5
AMT	AMT	Optional	5
PCT	PCT	Optional	5
NX2	NX2	Optional	5
REF	REF	Optional	5
Loop LQ	LQ	Optional	99999
LQ	LQ	Mandatory	1
AMT	AMT	Optional	5
PCT	PCT	Optional	5
Loop FA1	FA1	Optional	99999
FA1	FA1	Mandatory	1
FA2	FA2	Mandatory	99999
TDS	TDS	Mandatory	1
Loop ITA	ITA	Optional	99999
ITA	ITA	Mandatory	1
DTM	DTM	Optional	1
REF	REF	Optional	5
Loop BAL	BAL	Optional	99999
BAL	BAL	Mandatory	1
DTM	DTM	Optional	1
Loop N1	N1	Optional	99999
N1	N1	Mandatory	1
Loop BAL	BAL	Optional	99999
BAL	BAL	Mandatory	1
DTM	DTM	Optional	1
Loop ITA	ITA	Optional	99999
ITA	ITA	Mandatory	1
DTM	DTM	Optional	2
AMT	AMT	Optional	1
SI	SI	Optional	2
REF	REF	Optional	5
CUR	CUR	Optional	1
Loop LX	LX	Optional	99999
LX	LX	Mandatory	1
REF	REF	Optional	1
Loop AMT	AMT	Optional	99999
AMT	AMT	Mandatory	1
DTM	DTM	Optional	1
Loop ITA	ITA	Optional	99999
ITA	ITA	Mandatory	1
DTM	DTM	Optional	1
CTT	CTT	Optional	1
SE	Transaction Set Trailer	Mandatory	1