COLREQ Request for a documentary collection message (D03B)

This is the standard EDIFACT D03B spec, with 7 loops and 32 segment positions. Its structure is below. Download it as OpenEDI JSON, an ediFabric C# template or an ediFabric Native model, or customize it for a trading partner in the EDI Spec Builder.

Download the COLREQ spec

Sign in to download, free with the Community plan. Every plan includes 50 spec downloads a day, of any shape, after you accept the spec licence once. The C# template comes with the common segments, composites and codes it needs.

Customize in 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 D03B 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.

IDNameUsageMax use
UNHMessage HeaderOptional1
BGMBEGINNING OF MESSAGEMandatory1
DTMDATE/TIME/PERIODOptional1
FCAFINANCIAL CHARGES ALLOCATIONMandatory1
DOCDOCUMENT/MESSAGE DETAILSMandatory40
INPPARTIES AND INSTRUCTIONOptional20
FTXFREE TEXTOptional15
Loop FIIFINANCIAL INSTITUTION INFORMATIONMandatory7
FIIFINANCIAL INSTITUTION INFORMATIONMandatory1
RFFREFERENCEOptional1
CTACONTACT INFORMATIONOptional1
COMCOMMUNICATION CONTACTOptional5
Loop NADNAME AND ADDRESSMandatory9
NADNAME AND ADDRESSMandatory1
RFFREFERENCEOptional3
CTACONTACT INFORMATIONOptional1
COMCOMMUNICATION CONTACTOptional5
Loop PYTPAYMENT TERMSMandatory1
PYTPAYMENT TERMSMandatory1
DTMDATE/TIME/PERIODOptional1
FTXFREE TEXTOptional1
Loop MOAMONETARY AMOUNTMandatory5
MOAMONETARY AMOUNTMandatory1
FTXFREE TEXTOptional1
Loop TDTTRANSPORT INFORMATIONOptional1
TDTTRANSPORT INFORMATIONMandatory1
DTMDATE/TIME/PERIODOptional1
LOCPLACE/LOCATION IDENTIFICATIONOptional3
Loop GEIPROCESSING INFORMATIONOptional10
GEIPROCESSING INFORMATIONMandatory1
MOAMONETARY AMOUNTOptional1
LOCPLACE/LOCATION IDENTIFICATIONOptional2
NADNAME AND ADDRESSOptional1
RCSREQUIREMENTS AND CONDITIONSOptional1
FTXFREE TEXTOptional10
Loop AUTAUTHENTICATION RESULTOptional1
AUTAUTHENTICATION RESULTMandatory1
DTMDATE/TIME/PERIODOptional1
UNTMessage TrailerOptional1