COPAYM Contributions for payment (D17A)

This is the standard EDIFACT D17A spec, with 7 loops and 46 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 (72 KB) Generate classes
The ediFabric .NET template, class TSCOPAYM. 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 COPAYM 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 COPAYM files into TSCOPAYM 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 COPAYM 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 COPAYM classes in Python, Java, Node.js, Go, Rust or C

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

COPAYM structure

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

IDNameUsageMax use
UNHUNHMandatory1
BGMBGMMandatory1
GEIGEIMandatory1
DTMDTMMandatory9
QTYQTYOptional1
RFFRFFOptional9
CUXCUXOptional1
Loop PNAPNAMandatory9
PNAPNAMandatory1
ADRADROptional1
CTACTAOptional1
COMCOMOptional9
RFFRFFOptional9
ATTATTOptional9
UNSUNSMandatory1
Loop PNAPNAMandatory9999
PNAPNAMandatory1
ADRADROptional9
CTACTAOptional1
COMCOMOptional9
DTMDTMOptional9
MOAMOAOptional9
QTYQTYOptional99
RFFRFFOptional9
ATTATTOptional9
Loop COTCOTOptional999
COTCOTMandatory1
DLIDLIOptional1
DTMDTMOptional1
PCDPCDOptional9
MOAMOAOptional9
QTYQTYOptional9
RFFRFFOptional9
ATTATTOptional9
Loop LOCLOCOptional99
LOCLOCMandatory1
Loop PCDPCDMandatory9
PCDPCDMandatory1
MOAMOAMandatory9
UNSUNS2Mandatory1
MOAMOAOptional9
CNTCNTOptional1
Loop PAIPAIOptional9
PAIPAIMandatory1
FIIFIIOptional1
MOAMOAOptional9
RFFRFFOptional9
DTMDTMOptional9
Loop AUTAUTOptional9
AUTAUTMandatory1
DTMDTMOptional9
RFFRFFOptional9
UNTUNTMandatory1