COLREQ Request for a documentary collection message (D03A)
This is the standard EDIFACT D03A 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.
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 D03A 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 | Message Header | Optional | 1 |
| BGM | BEGINNING OF MESSAGE | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 1 |
| FCA | FINANCIAL CHARGES ALLOCATION | Mandatory | 1 |
| DOC | DOCUMENT/MESSAGE DETAILS | Mandatory | 40 |
| INP | PARTIES AND INSTRUCTION | Optional | 20 |
| FTX | FREE TEXT | Optional | 15 |
| Loop FII | FINANCIAL INSTITUTION INFORMATION | Mandatory | 7 |
| FII | FINANCIAL INSTITUTION INFORMATION | Mandatory | 1 |
| RFF | REFERENCE | Optional | 1 |
| CTA | CONTACT INFORMATION | Optional | 1 |
| COM | COMMUNICATION CONTACT | Optional | 5 |
| Loop NAD | NAME AND ADDRESS | Mandatory | 9 |
| NAD | NAME AND ADDRESS | Mandatory | 1 |
| RFF | REFERENCE | Optional | 3 |
| CTA | CONTACT INFORMATION | Optional | 1 |
| COM | COMMUNICATION CONTACT | Optional | 5 |
| Loop PYT | PAYMENT TERMS | Mandatory | 1 |
| PYT | PAYMENT TERMS | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 1 |
| FTX | FREE TEXT | Optional | 1 |
| Loop MOA | MONETARY AMOUNT | Mandatory | 5 |
| MOA | MONETARY AMOUNT | Mandatory | 1 |
| FTX | FREE TEXT | Optional | 1 |
| Loop TDT | TRANSPORT INFORMATION | Optional | 1 |
| TDT | TRANSPORT INFORMATION | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 1 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 3 |
| Loop GEI | PROCESSING INFORMATION | Optional | 10 |
| GEI | PROCESSING INFORMATION | Mandatory | 1 |
| MOA | MONETARY AMOUNT | Optional | 1 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 2 |
| NAD | NAME AND ADDRESS | Optional | 1 |
| RCS | REQUIREMENTS AND CONDITIONS | Optional | 1 |
| FTX | FREE TEXT | Optional | 10 |
| Loop AUT | AUTHENTICATION RESULT | Optional | 1 |
| AUT | AUTHENTICATION RESULT | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 1 |
| UNT | Message Trailer | Optional | 1 |