BOPDIR Direct balance of payment declaration message (D02A)

This is the standard EDIFACT D02A spec, with 11 loops and 42 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 (68 KB) Generate classes
The ediFabric .NET template, class TSBOPDIR. It needs the common segments, composites and codes of EDIFACT D02A, one download for every transaction in the version. Download C# (1 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 BOPDIR 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 BOPDIR files into TSBOPDIR objects. See ediFabric .NET.

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D02A to this Native model with set_map to parse BOPDIR 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 BOPDIR classes in Python, Java, Node.js, Go, Rust or C

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

BOPDIR structure

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

IDNameUsageMax use
UNHMessage HeaderOptional1
BGMBEGINNING OF MESSAGEMandatory1
DTMDATE/TIME/PERIODMandatory9
Loop RFFREFERENCEOptional9
RFFREFERENCEMandatory1
DTMDATE/TIME/PERIODOptional1
Loop NADNAME AND ADDRESSMandatory9
NADNAME AND ADDRESSMandatory1
CTACONTACT INFORMATIONOptional1
COMCOMMUNICATION CONTACTOptional9
FTXFREE TEXTOptional99
Loop RFFREFERENCEOptional999
RFFREFERENCEMandatory1
ATTATTRIBUTEOptional1
FIIFINANCIAL INSTITUTION INFORMATIONOptional1
NADNAME AND ADDRESSOptional99
MOAMONETARY AMOUNTOptional9
CUXCURRENCIESOptional1
Loop RCSREQUIREMENTS AND CONDITIONSMandatory9999
RCSREQUIREMENTS AND CONDITIONSMandatory1
FTXFREE TEXTOptional99
DTMDATE/TIME/PERIODOptional9
FIIFINANCIAL INSTITUTION INFORMATIONOptional1
NADNAME AND ADDRESSOptional9
SPRORGANISATION CLASSIFICATION DETAILSOptional1
LOCPLACE/LOCATION IDENTIFICATIONOptional9
Loop RFFREFERENCEOptional9
RFFREFERENCEMandatory1
DTMDATE/TIME/PERIODOptional1
Loop MOAMONETARY AMOUNTMandatory9
MOAMONETARY AMOUNTMandatory1
CUXCURRENCIESOptional1
Loop GIRRELATED IDENTIFICATION NUMBERSOptional1
GIRRELATED IDENTIFICATION NUMBERSMandatory1
QTYQUANTITYOptional1
PRIPRICE DETAILSOptional1
UNSSECTION CONTROLMandatory1
Loop RFFREFERENCEOptional99
RFFREFERENCEMandatory1
Loop RCSREQUIREMENTS AND CONDITIONSMandatory99
RCSREQUIREMENTS AND CONDITIONSMandatory1
FTXFREE TEXTOptional1
CUXCURRENCIESOptional1
Loop MOAMONETARY AMOUNTMandatory9999
MOAMONETARY AMOUNTMandatory1
NADNAME AND ADDRESSOptional1
LOCPLACE/LOCATION IDENTIFICATIONOptional1
Loop GIRRELATED IDENTIFICATION NUMBERSOptional1
GIRRELATED IDENTIFICATION NUMBERSMandatory1
QTYQUANTITYOptional1
PRIPRICE DETAILSOptional1
CNTCONTROL TOTALOptional9
UNTMessage TrailerOptional1