INVOIC Invoice message (D01B)

This is the standard EDIFACT D01B spec, with 53 loops and 179 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 (146 KB) Generate classes

The ediFabric .NET template, class TSINVOIC. It needs the common segments, composites and codes of EDIFACT D01B, one download for every transaction in the version. Download C# (3 KB) Common files (57 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 D01B 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	Message Header	Optional	1
BGM	BEGINNING OF MESSAGE	Mandatory	1
DTM	DATE/TIME/PERIOD	Mandatory	35
PAI	PAYMENT INSTRUCTIONS	Optional	1
ALI	ADDITIONAL INFORMATION	Optional	5
IMD	ITEM DESCRIPTION	Optional	1
FTX	FREE TEXT	Optional	99
LOC	PLACE/LOCATION IDENTIFICATION	Optional	10
GIS	GENERAL INDICATOR	Optional	10
DGS	DANGEROUS GOODS	Optional	1
GIR	RELATED IDENTIFICATION NUMBERS	Optional	10
Loop RFF	REFERENCE	Optional	99999
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
GIR	RELATED IDENTIFICATION NUMBERS	Optional	5
LOC	PLACE/LOCATION IDENTIFICATION	Optional	2
MEA	MEASUREMENTS	Optional	5
QTY	QUANTITY	Optional	2
FTX	FREE TEXT	Optional	5
MOA	MONETARY AMOUNT	Optional	2
RTE	RATE DETAILS	Optional	99
Loop NAD	NAME AND ADDRESS	Optional	99
NAD	NAME AND ADDRESS	Mandatory	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	25
FII	FINANCIAL INSTITUTION INFORMATION	Optional	5
MOA	MONETARY AMOUNT	Optional	99
Loop RFF	REFERENCE	Optional	9999
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop DOC	DOCUMENT/MESSAGE DETAILS	Optional	5
DOC	DOCUMENT/MESSAGE DETAILS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop CTA	CONTACT INFORMATION	Optional	5
CTA	CONTACT INFORMATION	Mandatory	1
COM	COMMUNICATION CONTACT	Optional	5
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	5
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	5
Loop CUX	CURRENCIES	Optional	99
CUX	CURRENCIES	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop PAT	PAYMENT TERMS BASIS	Optional	10
PAT	PAYMENT TERMS BASIS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
PCD	PERCENTAGE DETAILS	Optional	1
MOA	MONETARY AMOUNT	Optional	1
PAI	PAYMENT INSTRUCTIONS	Optional	1
FII	FINANCIAL INSTITUTION INFORMATION	Optional	1
Loop TDT	DETAILS OF TRANSPORT	Optional	10
TDT	DETAILS OF TRANSPORT	Mandatory	1
TSR	TRANSPORT SERVICE REQUIREMENTS	Optional	1
Loop LOC	PLACE/LOCATION IDENTIFICATION	Optional	10
LOC	PLACE/LOCATION IDENTIFICATION	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop RFF	REFERENCE	Optional	9999
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop TOD	TERMS OF DELIVERY OR TRANSPORT	Optional	5
TOD	TERMS OF DELIVERY OR TRANSPORT	Mandatory	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	2
Loop EQD	EQUIPMENT DETAILS	Optional	99
EQD	EQUIPMENT DETAILS	Mandatory	1
SEL	SEAL NUMBER	Optional	9
Loop PAC	PACKAGE	Optional	1000
PAC	PACKAGE	Mandatory	1
MEA	MEASUREMENTS	Optional	5
EQD	EQUIPMENT DETAILS	Optional	1
Loop PCI	PACKAGE IDENTIFICATION	Optional	5
PCI	PACKAGE IDENTIFICATION	Mandatory	1
RFF	REFERENCE	Optional	1
DTM	DATE/TIME/PERIOD	Optional	5
GIN	GOODS IDENTITY NUMBER	Optional	5
Loop ALC	ALLOWANCE OR CHARGE	Optional	9999
ALC	ALLOWANCE OR CHARGE	Mandatory	1
ALI	ADDITIONAL INFORMATION	Optional	5
FTX	FREE TEXT	Optional	1
Loop RFF	REFERENCE	Optional	5
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop QTY	QUANTITY	Optional	1
QTY	QUANTITY	Mandatory	1
RNG	RANGE DETAILS	Optional	1
Loop PCD	PERCENTAGE DETAILS	Optional	1
PCD	PERCENTAGE DETAILS	Mandatory	1
RNG	RANGE DETAILS	Optional	1
Loop MOA	MONETARY AMOUNT	Optional	2
MOA	MONETARY AMOUNT	Mandatory	1
RNG	RANGE DETAILS	Optional	1
CUX	CURRENCIES	Optional	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop RTE	RATE DETAILS	Optional	1
RTE	RATE DETAILS	Mandatory	1
RNG	RANGE DETAILS	Optional	1
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	5
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	1
Loop RCS	REQUIREMENTS AND CONDITIONS	Optional	100
RCS	REQUIREMENTS AND CONDITIONS	Mandatory	1
RFF	REFERENCE	Optional	5
DTM	DATE/TIME/PERIOD	Optional	5
FTX	FREE TEXT	Optional	5
Loop AJT	ADJUSTMENT DETAILS	Optional	1
AJT	ADJUSTMENT DETAILS	Mandatory	1
FTX	FREE TEXT	Optional	5
Loop INP	PARTIES AND INSTRUCTION	Optional	1
INP	PARTIES AND INSTRUCTION	Mandatory	1
FTX	FREE TEXT	Optional	5
Loop LIN	LINE ITEM	Optional	9999999
LIN	LINE ITEM	Mandatory	1
PIA	ADDITIONAL PRODUCT ID	Optional	25
PGI	PRODUCT GROUP INFORMATION	Optional	99
IMD	ITEM DESCRIPTION	Optional	99
MEA	MEASUREMENTS	Optional	5
QTY	QUANTITY	Optional	5
PCD	PERCENTAGE DETAILS	Optional	1
ALI	ADDITIONAL INFORMATION	Optional	5
DTM	DATE/TIME/PERIOD	Optional	35
GIN	GOODS IDENTITY NUMBER	Optional	1000
GIR	RELATED IDENTIFICATION NUMBERS	Optional	1000
QVR	QUANTITY VARIANCES	Optional	1
EQD	EQUIPMENT DETAILS	Optional	1
FTX	FREE TEXT	Optional	99
DGS	DANGEROUS GOODS	Optional	1
Loop MOA	MONETARY AMOUNT	Optional	99
MOA	MONETARY AMOUNT	Mandatory	1
CUX	CURRENCIES	Optional	1
Loop PAT	PAYMENT TERMS BASIS	Optional	10
PAT	PAYMENT TERMS BASIS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
PCD	PERCENTAGE DETAILS	Optional	99
MOA	MONETARY AMOUNT	Optional	1
Loop PRI	PRICE DETAILS	Optional	25
PRI	PRICE DETAILS	Mandatory	1
CUX	CURRENCIES	Optional	1
APR	ADDITIONAL PRICE INFORMATION	Optional	1
RNG	RANGE DETAILS	Optional	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop RFF	REFERENCE	Optional	10
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop PAC	PACKAGE	Optional	10
PAC	PACKAGE	Mandatory	1
MEA	MEASUREMENTS	Optional	5
EQD	EQUIPMENT DETAILS	Optional	1
Loop PCI	PACKAGE IDENTIFICATION	Optional	5
PCI	PACKAGE IDENTIFICATION	Mandatory	1
RFF	REFERENCE	Optional	1
DTM	DATE/TIME/PERIOD	Optional	5
GIN	GOODS IDENTITY NUMBER	Optional	5
Loop LOC	PLACE/LOCATION IDENTIFICATION	Optional	9999
LOC	PLACE/LOCATION IDENTIFICATION	Mandatory	1
QTY	QUANTITY	Optional	100
DTM	DATE/TIME/PERIOD	Optional	5
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	99
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	2
LOC	PLACE/LOCATION IDENTIFICATION	Optional	5
Loop NAD	NAME AND ADDRESS	Optional	99
NAD	NAME AND ADDRESS	Mandatory	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	5
FII	FINANCIAL INSTITUTION INFORMATION	Optional	5
Loop RFF	REFERENCE	Optional	5
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop DOC	DOCUMENT/MESSAGE DETAILS	Optional	5
DOC	DOCUMENT/MESSAGE DETAILS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop CTA	CONTACT INFORMATION	Optional	5
CTA	CONTACT INFORMATION	Mandatory	1
COM	COMMUNICATION CONTACT	Optional	5
Loop ALC	ALLOWANCE OR CHARGE	Optional	30
ALC	ALLOWANCE OR CHARGE	Mandatory	1
ALI	ADDITIONAL INFORMATION	Optional	5
DTM	DATE/TIME/PERIOD	Optional	5
FTX	FREE TEXT	Optional	1
Loop QTY	QUANTITY	Optional	1
QTY	QUANTITY	Mandatory	1
RNG	RANGE DETAILS	Optional	1
Loop PCD	PERCENTAGE DETAILS	Optional	1
PCD	PERCENTAGE DETAILS	Mandatory	1
RNG	RANGE DETAILS	Optional	1
Loop MOA	MONETARY AMOUNT	Optional	2
MOA	MONETARY AMOUNT	Mandatory	1
RNG	RANGE DETAILS	Optional	1
CUX	CURRENCIES	Optional	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop RTE	RATE DETAILS	Optional	1
RTE	RATE DETAILS	Mandatory	1
RNG	RANGE DETAILS	Optional	1
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	5
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	2
Loop TDT	DETAILS OF TRANSPORT	Optional	10
TDT	DETAILS OF TRANSPORT	Mandatory	1
Loop LOC	PLACE/LOCATION IDENTIFICATION	Optional	10
LOC	PLACE/LOCATION IDENTIFICATION	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop TOD	TERMS OF DELIVERY OR TRANSPORT	Optional	5
TOD	TERMS OF DELIVERY OR TRANSPORT	Mandatory	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	2
Loop RCS	REQUIREMENTS AND CONDITIONS	Optional	100
RCS	REQUIREMENTS AND CONDITIONS	Mandatory	1
RFF	REFERENCE	Optional	5
DTM	DATE/TIME/PERIOD	Optional	5
FTX	FREE TEXT	Optional	5
Loop GIS	GENERAL INDICATOR	Optional	10
GIS	GENERAL INDICATOR	Mandatory	1
RFF	REFERENCE	Optional	1
DTM	DATE/TIME/PERIOD	Optional	5
GIR	RELATED IDENTIFICATION NUMBERS	Optional	5
LOC	PLACE/LOCATION IDENTIFICATION	Optional	2
MEA	MEASUREMENTS	Optional	5
QTY	QUANTITY	Optional	2
FTX	FREE TEXT	Optional	5
MOA	MONETARY AMOUNT	Optional	2
UNS	SECTION CONTROL	Mandatory	1
CNT	CONTROL TOTAL	Optional	10
Loop MOA	MONETARY AMOUNT	Mandatory	100
MOA	MONETARY AMOUNT	Mandatory	1
Loop RFF	REFERENCE	Optional	1
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	5
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	10
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	2
Loop ALC	ALLOWANCE OR CHARGE	Optional	15
ALC	ALLOWANCE OR CHARGE	Mandatory	1
ALI	ADDITIONAL INFORMATION	Optional	1
MOA	MONETARY AMOUNT	Optional	2
FTX	FREE TEXT	Optional	1
UNT	Message Trailer	Optional	1