INVOIC Invoice message (D17A)

This is the standard EDIFACT D17A spec, with 55 loops and 192 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 (150 KB) Generate classes

The ediFabric .NET template, class TSINVOIC. It needs the common segments, composites and codes of EDIFACT D17A, one download for every transaction in the version. Download C# (3 KB) Common files (69 KB)

The intermediary model ediFabric Native loads with set_map. Native supports X12 today, and EDIFACT is coming. Download Native (1 KB)

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

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D17A to this Native model with set_map to parse INVOIC files to JSON from Python, Java, C or C#. See ediFabric Native.

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 INVOIC classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each INVOIC as JSON. To work with INVOIC data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSINVOIC. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. 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 INVOIC, see the INVOIC transaction guide.

INVOIC structure

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

ID	Name	Usage	Max use
UNH	UNH	Mandatory	1
BGM	BGM	Mandatory	1
DTM	DTM	Mandatory	35
PAI	PAI	Optional	1
ALI	ALI	Optional	5
IMD	IMD	Optional	1
FTX	FTX	Optional	99
LOC	LOC	Optional	10
GEI	GEI	Optional	10
DGS	DGS	Optional	1
GIR	GIR	Optional	10
Loop RFF	RFF	Optional	99999
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
GIR	GIR	Optional	5
LOC	LOC	Optional	2
MEA	MEA	Optional	5
QTY	QTY	Optional	2
FTX	FTX	Optional	5
MOA	MOA	Optional	2
RTE	RTE	Optional	99
Loop NAD	NAD	Optional	99
NAD	NAD	Mandatory	1
LOC	LOC	Optional	25
FII	FII	Optional	5
MOA	MOA	Optional	99
Loop RFF	RFF	Optional	9999
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
Loop DOC	DOC	Optional	5
DOC	DOC	Mandatory	1
DTM	DTM	Optional	5
Loop CTA	CTA	Optional	5
CTA	CTA	Mandatory	1
COM	COM	Optional	5
Loop TAX	TAX	Optional	5
TAX	TAX	Mandatory	1
MOA	MOA	Optional	1
LOC	LOC	Optional	5
Loop CUX	CUX	Optional	99
CUX	CUX	Mandatory	1
DTM	DTM	Optional	5
Loop PYT	PYT	Optional	10
PYT	PYT	Mandatory	1
DTM	DTM	Optional	5
PCD	PCD	Optional	1
MOA	MOA	Optional	1
PAI	PAI	Optional	1
FII	FII	Optional	1
Loop TDT	TDT	Optional	10
TDT	TDT	Mandatory	1
TSR	TSR	Optional	1
Loop LOC	LOC	Optional	10
LOC	LOC	Mandatory	1
DTM	DTM	Optional	5
Loop RFF	RFF	Optional	9999
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
Loop TOD	TOD	Optional	5
TOD	TOD	Mandatory	1
LOC	LOC	Optional	2
Loop EQD	EQD	Optional	99
EQD	EQD	Mandatory	1
SEL	SEL	Optional	9
Loop PAC	PAC	Optional	1000
PAC	PAC	Mandatory	1
MEA	MEA	Optional	5
EQD	EQD	Optional	1
Loop PCI	PCI	Optional	5
PCI	PCI	Mandatory	1
RFF	RFF	Optional	1
DTM	DTM	Optional	5
GIN	GIN	Optional	5
Loop ALC	ALC	Optional	9999
ALC	ALC	Mandatory	1
ALI	ALI	Optional	5
FTX	FTX	Optional	1
Loop RFF	RFF	Optional	5
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
Loop QTY	QTY	Optional	1
QTY	QTY	Mandatory	1
RNG	RNG	Optional	1
Loop PCD	PCD	Optional	1
PCD	PCD	Mandatory	1
RNG	RNG	Optional	1
Loop MOA	MOA	Optional	2
MOA	MOA	Mandatory	1
RNG	RNG	Optional	1
CUX	CUX	Optional	1
DTM	DTM	Optional	1
Loop RTE	RTE	Optional	1
RTE	RTE	Mandatory	1
RNG	RNG	Optional	1
Loop TAX	TAX	Optional	5
TAX	TAX	Mandatory	1
MOA	MOA	Optional	1
Loop RCS	RCS	Optional	100
RCS	RCS	Mandatory	1
RFF	RFF	Optional	5
DTM	DTM	Optional	5
FTX	FTX	Optional	5
Loop AJT	AJT	Optional	1
AJT	AJT	Mandatory	1
FTX	FTX	Optional	5
Loop INP	INP	Optional	1
INP	INP	Mandatory	1
FTX	FTX	Optional	5
Loop EFI	EFI	Optional	99
EFI	EFI	Mandatory	1
CED	CED	Optional	99
COM	COM	Optional	9
RFF	RFF	Optional	9
DTM	DTM	Optional	9
QTY	QTY	Optional	9
Loop LIN	LIN	Optional	99999
LIN	LIN	Mandatory	1
PIA	PIA	Optional	25
PGI	PGI	Optional	99
IMD	IMD	Optional	99
MEA	MEA	Optional	5
QTY	QTY	Optional	5
PCD	PCD	Optional	1
ALI	ALI	Optional	5
DTM	DTM	Optional	35
GIN	GIN	Optional	1000
GIR	GIR	Optional	1000
QVR	QVR	Optional	1
EQD	EQD	Optional	1
FTX	FTX	Optional	99
DGS	DGS	Optional	1
Loop MOA	MOA	Optional	99
MOA	MOA	Mandatory	1
CUX	CUX	Optional	1
Loop PYT	PYT	Optional	10
PYT	PYT	Mandatory	1
DTM	DTM	Optional	5
PCD	PCD	Optional	99
MOA	MOA	Optional	1
Loop PRI	PRI	Optional	25
PRI	PRI	Mandatory	1
CUX	CUX	Optional	1
APR	APR	Optional	1
RNG	RNG	Optional	1
DTM	DTM	Optional	5
Loop RFF	RFF	Optional	10
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
Loop PAC	PAC	Optional	999
PAC	PAC	Mandatory	1
MEA	MEA	Optional	10
EQD	EQD	Optional	1
Loop PCI	PCI	Optional	10
PCI	PCI	Mandatory	1
RFF	RFF	Optional	1
DTM	DTM	Optional	5
GIN	GIN	Optional	10
Loop LOC	LOC	Optional	9999
LOC	LOC	Mandatory	1
QTY	QTY	Optional	100
DTM	DTM	Optional	5
Loop TAX	TAX	Optional	99
TAX	TAX	Mandatory	1
MOA	MOA	Optional	2
LOC	LOC	Optional	5
Loop NAD	NAD	Optional	99
NAD	NAD	Mandatory	1
LOC	LOC	Optional	5
FII	FII	Optional	5
Loop RFF	RFF	Optional	5
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
Loop DOC	DOC	Optional	5
DOC	DOC	Mandatory	1
DTM	DTM	Optional	5
Loop CTA	CTA	Optional	5
CTA	CTA	Mandatory	1
COM	COM	Optional	5
Loop ALC	ALC	Optional	30
ALC	ALC	Mandatory	1
ALI	ALI	Optional	5
DTM	DTM	Optional	5
FTX	FTX	Optional	1
Loop QTY	QTY	Optional	1
QTY	QTY	Mandatory	1
RNG	RNG	Optional	1
Loop PCD	PCD	Optional	1
PCD	PCD	Mandatory	1
RNG	RNG	Optional	1
Loop MOA	MOA	Optional	2
MOA	MOA	Mandatory	1
RNG	RNG	Optional	1
CUX	CUX	Optional	1
DTM	DTM	Optional	1
Loop RTE	RTE	Optional	1
RTE	RTE	Mandatory	1
RNG	RNG	Optional	1
Loop TAX	TAX	Optional	5
TAX	TAX	Mandatory	1
MOA	MOA	Optional	2
Loop TDT	TDT	Optional	10
TDT	TDT	Mandatory	1
Loop LOC	LOC	Optional	10
LOC	LOC	Mandatory	1
DTM	DTM	Optional	5
Loop TOD	TOD	Optional	5
TOD	TOD	Mandatory	1
LOC	LOC	Optional	2
Loop RCS	RCS	Optional	100
RCS	RCS	Mandatory	1
RFF	RFF	Optional	5
DTM	DTM	Optional	5
FTX	FTX	Optional	5
Loop GEI	GEI	Optional	999
GEI	GEI	Mandatory	1
RFF	RFF	Optional	9
IMD	IMD	Optional	99
DTM	DTM	Optional	5
GIR	GIR	Optional	5
LOC	LOC	Optional	2
MEA	MEA	Optional	5
QTY	QTY	Optional	9
FTX	FTX	Optional	5
MOA	MOA	Optional	2
Loop EFI	EFI	Optional	99
EFI	EFI	Mandatory	1
CED	CED	Optional	99
COM	COM	Optional	9
RFF	RFF	Optional	9
DTM	DTM	Optional	9
QTY	QTY	Optional	9
UNS	UNS	Mandatory	1
CNT	CNT	Optional	10
Loop MOA	MOA	Mandatory	100
MOA	MOA	Mandatory	1
Loop RFF	RFF	Optional	1
RFF	RFF	Mandatory	1
DTM	DTM	Optional	5
Loop TAX	TAX	Optional	10
TAX	TAX	Mandatory	1
MOA	MOA	Optional	9
Loop ALC	ALC	Optional	15
ALC	ALC	Mandatory	1
ALI	ALI	Optional	1
MOA	MOA	Optional	2
FTX	FTX	Optional	1
UNT	UNT	Mandatory	1