256 Periodic Compensation (004020)

This is the standard X12 004020 spec, with 8 loops and 50 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 (87 KB) Generate classes
The ediFabric .NET template, class TS256. It needs the common segments, composites and codes of X12 004020, one download for every transaction in the version. Download C# (1 KB) Common files (254 KB)
The intermediary model ediFabric Native loads with set_map. Download Native (65 KB)

Use the 256 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 256 files into TS256 objects. See ediFabric .NET.

ediFabric Native

Map version 004020 to the Native model with set_map, then parse 256 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.

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 256 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 256 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS256. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

256 structure

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

IDNameUsageMax use
STTransaction Set HeaderOptional1
BSCBeginning Segment for Commission Sales ReportMandatory1
CURCurrencyOptional1
N9Reference IdentificationOptional9
DTPDate or Time or PeriodOptional9
Loop NM1Individual or Organizational NameOptional2
NM1Individual or Organizational NameMandatory1
N3Address InformationOptional3
N4Geographic LocationOptional1
REFReference IdentificationOptional9
PERAdministrative Communications ContactOptional3
Loop N1NameMandatory>1
N1NameMandatory1
N2Additional Name InformationOptional2
REFReference IdentificationOptional9
N3Address InformationOptional3
N4Geographic LocationOptional1
DTPDate or Time or PeriodOptional>1
Loop BLIBaseline Item DataOptional>1
BLIBaseline Item DataMandatory1
REFReference IdentificationOptional>1
DTPDate or Time or PeriodOptional>1
AMTMonetary AmountOptional>1
BLNBalance InformationOptional9
RPARate Amounts or PercentsOptional>1
Loop NM1Individual or Organizational NameOptional>1
NM1Individual or Organizational NameMandatory1
N2Additional Name InformationOptional2
REFReference IdentificationOptional9
N3Address InformationOptional3
N4Geographic LocationOptional1
DMGDemographic InformationOptional1
DTPDate or Time or PeriodOptional9
Loop AM1Informational ValuesOptional>1
AM1Informational ValuesMandatory1
REFReference IdentificationOptional9
IIIInformationOptional9
DTPDate or Time or PeriodOptional9
Loop AMTMonetary AmountOptional>1
AMTMonetary AmountMandatory1
REFReference IdentificationOptional1
MSGMessage TextOptional9
Loop RPARate Amounts or PercentsOptional>1
RPARate Amounts or PercentsMandatory1
IIIInformationOptional9
Loop ENTEntityOptional>1
ENTEntityMandatory1
REFReference IdentificationOptional9
NM1Individual or Organizational NameOptional1
N2Additional Name InformationOptional2
N3Address InformationOptional3
N4Geographic LocationOptional1
ADXAdjustmentOptional9
QTYQuantityOptional>1
AMTMonetary AmountOptional>1
BLNBalance InformationOptional>1
MSGMessage TextOptional>1
SETransaction Set TrailerOptional1