COLREQ Request for a documentary collection message (D17A)

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

The ediFabric .NET template, class TSCOLREQ. It needs the common segments, composites and codes of EDIFACT D17A, one download for every transaction in the version. Download C# (1 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 COLREQ 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 COLREQ files into TSCOLREQ 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 COLREQ 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 COLREQ classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each COLREQ as JSON. To work with COLREQ data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSCOLREQ. 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.

COLREQ structure

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

ID	Name	Usage	Max use
UNH	UNH	Mandatory	1
BGM	BGM	Mandatory	1
DTM	DTM	Optional	1
FCA	FCA	Mandatory	1
DOC	DOC	Mandatory	40
INP	INP	Optional	20
FTX	FTX	Optional	15
Loop FII	FII	Mandatory	7
FII	FII	Mandatory	1
RFF	RFF	Optional	1
CTA	CTA	Optional	1
COM	COM	Optional	5
Loop NAD	NAD	Mandatory	9
NAD	NAD	Mandatory	1
RFF	RFF	Optional	3
CTA	CTA	Optional	1
COM	COM	Optional	5
Loop PYT	PYT	Mandatory	1
PYT	PYT	Mandatory	1
DTM	DTM	Optional	1
FTX	FTX	Optional	1
Loop MOA	MOA	Mandatory	5
MOA	MOA	Mandatory	1
FTX	FTX	Optional	1
Loop TDT	TDT	Optional	1
TDT	TDT	Mandatory	1
DTM	DTM	Optional	1
LOC	LOC	Optional	3
Loop GEI	GEI	Optional	10
GEI	GEI	Mandatory	1
MOA	MOA	Optional	1
LOC	LOC	Optional	2
NAD	NAD	Optional	1
RCS	RCS	Optional	1
FTX	FTX	Optional	10
Loop AUT	AUT	Optional	1
AUT	AUT	Mandatory	1
DTM	DTM	Optional	1
UNT	UNT	Mandatory	1