811 Consolidated Service Invoice/Statement (004020)

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

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

The intermediary model ediFabric Native loads with set_map. Download Native (120 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 004020 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	Optional	1
BIG	Beginning Segment for Invoice	Mandatory	1
NTE	Note/Special Instruction	Optional	100
CUR	Currency	Optional	1
REF	Reference Identification	Optional	>1
PER	Administrative Communications Contact	Optional	3
ITD	Terms of Sale/Deferred Terms of Sale	Optional	5
DTM	Date/Time Reference	Optional	10
TXI	Tax Information	Optional	>1
Loop N1	Name	Optional	>1
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Identification	Optional	12
PER	Administrative Communications Contact	Optional	3
DMG	Demographic Information	Optional	1
Loop FA1	Type of Financial Accounting Data	Optional	>1
FA1	Type of Financial Accounting Data	Mandatory	1
FA2	Accounting Data	Mandatory	>1
Loop HL	Hierarchical Level	Mandatory	>1
HL	Hierarchical Level	Mandatory	1
Loop LX	Assigned Number	Optional	>1
LX	Assigned Number	Mandatory	1
VEH	Vehicle Information	Optional	1
SI	Service Characteristic Identification	Optional	8
PID	Product/Item Description	Optional	200
MEA	Measurements	Optional	20
REF	Reference Identification	Optional	>1
AMT	Monetary Amount	Optional	>1
DTM	Date/Time Reference	Optional	8
TXI	Tax Information	Optional	>1
Loop QTY	Quantity	Optional	10
QTY	Quantity	Mandatory	1
SI	Service Characteristic Identification	Optional	1
Loop NM1	Individual or Organizational Name	Optional	1
NM1	Individual or Organizational Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Identification	Optional	>1
PER	Administrative Communications Contact	Optional	>1
TXI	Tax Information	Optional	>1
DMG	Demographic Information	Optional	1
Loop ITA	Allowance, Charge or Service	Optional	>1
ITA	Allowance, Charge or Service	Mandatory	1
DTM	Date/Time Reference	Optional	1
TXI	Tax Information	Optional	>1
Loop IT1	Baseline Item Data (Invoice)	Optional	999999
IT1	Baseline Item Data (Invoice)	Mandatory	1
SI	Service Characteristic Identification	Optional	2
PID	Product/Item Description	Optional	200
MEA	Measurements	Optional	20
INC	Installment Information	Optional	1
TXI	Tax Information	Optional	>1
REF	Reference Identification	Optional	8
DTM	Date/Time Reference	Optional	10
MSG	Message Text	Optional	>1
Loop AMT	Monetary Amount	Optional	>1
AMT	Monetary Amount	Mandatory	1
CUR	Currency	Optional	1
Loop QTY	Quantity	Optional	>1
QTY	Quantity	Mandatory	1
SI	Service Characteristic Identification	Optional	1
Loop ITA	Allowance, Charge or Service	Optional	10
ITA	Allowance, Charge or Service	Mandatory	1
DTM	Date/Time Reference	Optional	1
TXI	Tax Information	Optional	>1
Loop NM1	Individual or Organizational Name	Optional	>1
NM1	Individual or Organizational Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
PER	Administrative Communications Contact	Optional	3
NX2	Location ID Component	Optional	>1
DMG	Demographic Information	Optional	1
Loop SLN	Subline Item Detail	Optional	>1
SLN	Subline Item Detail	Mandatory	1
SI	Service Characteristic Identification	Optional	2
PID	Product/Item Description	Optional	200
MEA	Measurements	Optional	20
CUR	Currency	Optional	1
INC	Installment Information	Optional	1
ITA	Allowance, Charge or Service	Optional	10
TXI	Tax Information	Optional	>1
REF	Reference Identification	Optional	>1
PER	Administrative Communications Contact	Optional	3
DTM	Date/Time Reference	Optional	10
AMT	Monetary Amount	Optional	15
MSG	Message Text	Optional	>1
Loop QTY	Quantity	Optional	>1
QTY	Quantity	Mandatory	1
SI	Service Characteristic Identification	Optional	1
Loop NM1	Individual or Organizational Name	Optional	>1
NM1	Individual or Organizational Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Identification	Optional	8
PER	Administrative Communications Contact	Optional	3
DMG	Demographic Information	Optional	1
Loop TCD	Itemized Call Detail	Optional	>1
TCD	Itemized Call Detail	Mandatory	1
SI	Service Characteristic Identification	Optional	2
TXI	Tax Information	Optional	>1
ITA	Allowance, Charge or Service	Optional	>1
Loop QTY	Quantity	Optional	>1
QTY	Quantity	Mandatory	1
SI	Service Characteristic Identification	Optional	1
Loop USD	Usage-Sensitive Detail	Optional	>1
USD	Usage-Sensitive Detail	Mandatory	1
SI	Service Characteristic Identification	Optional	2
ITA	Allowance, Charge or Service	Optional	2
TRF	Rating Factors	Optional	18
Loop QTY	Quantity	Optional	>1
QTY	Quantity	Mandatory	1
SI	Service Characteristic Identification	Optional	1
Loop III	Information	Optional	>1
III	Information	Mandatory	1
DTP	Date or Time or Period	Optional	5
AMT	Monetary Amount	Optional	5
PCT	Percent Amounts	Optional	5
Loop LQ	Industry Code	Optional	>1
LQ	Industry Code	Mandatory	1
AMT	Monetary Amount	Optional	5
PCT	Percent Amounts	Optional	5
Loop FA1	Type of Financial Accounting Data	Optional	>1
FA1	Type of Financial Accounting Data	Mandatory	1
FA2	Accounting Data	Mandatory	>1
TDS	Total Monetary Value Summary	Mandatory	1
Loop ITA	Allowance, Charge or Service	Optional	>1
ITA	Allowance, Charge or Service	Mandatory	1
DTM	Date/Time Reference	Optional	1
REF	Reference Identification	Optional	5
Loop BAL	Balance Detail	Optional	>1
BAL	Balance Detail	Mandatory	1
DTM	Date/Time Reference	Optional	1
Loop N1	Name	Optional	>1
N1	Name	Mandatory	1
Loop BAL	Balance Detail	Optional	>1
BAL	Balance Detail	Mandatory	1
DTM	Date/Time Reference	Optional	1
Loop ITA	Allowance, Charge or Service	Optional	>1
ITA	Allowance, Charge or Service	Mandatory	1
DTM	Date/Time Reference	Optional	2
AMT	Monetary Amount	Optional	1
SI	Service Characteristic Identification	Optional	2
REF	Reference Identification	Optional	5
CUR	Currency	Optional	1
Loop LX	Assigned Number	Optional	>1
LX	Assigned Number	Mandatory	1
REF	Reference Identification	Optional	1
Loop AMT	Monetary Amount	Optional	>1
AMT	Monetary Amount	Mandatory	1
DTM	Date/Time Reference	Optional	1
Loop ITA	Allowance, Charge or Service	Optional	>1
ITA	Allowance, Charge or Service	Mandatory	1
DTM	Date/Time Reference	Optional	1
CTT	Transaction Totals	Optional	1
SE	Transaction Set Trailer	Optional	1