561 Contract Abstract (005030)

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

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

ediFabric Native

Map version 005030 to the Native model with set_map, then parse 561 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 561 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 561 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 TS561. 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.

561 structure

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

IDNameUsageMax use
STTransaction Set HeaderOptional1
BGNBeginning SegmentMandatory1
N9Extended Reference InformationOptional1
Loop LMCode Source InformationOptional>1
LMCode Source InformationMandatory1
LQIndustry Code IdentificationMandatory100
Loop N1Party IdentificationOptional>1
N1Party IdentificationMandatory1
N2Additional Name InformationOptional2
N3Party LocationOptional2
N4Geographic LocationOptional1
G61ContactOptional1
Loop HLHierarchical LevelMandatory>1
HLHierarchical LevelMandatory1
CSContract SummaryOptional1
G62Date/TimeOptional2
ITDTerms of Sale/Deferred Terms of SaleOptional5
PO1Baseline Item DataOptional1
SLNSubline Item DetailOptional1
N9Extended Reference InformationOptional10
AMTMonetary Amount InformationOptional1
PCTPercent AmountsOptional2
PIDProduct/Item DescriptionOptional10
Loop FA1Type of Financial Accounting DataOptional>1
FA1Type of Financial Accounting DataMandatory1
FA2Accounting DataMandatory>1
AMTMonetary Amount InformationOptional2
N9Extended Reference InformationOptional1
Loop LMCode Source InformationOptional>1
LMCode Source InformationMandatory1
LQIndustry Code IdentificationMandatory100
Loop N1Party IdentificationOptional>1
N1Party IdentificationMandatory1
N2Additional Name InformationOptional2
N3Party LocationOptional2
N4Geographic LocationOptional1
G61ContactOptional1
Loop SCHLine Item ScheduleOptional>1
SCHLine Item ScheduleMandatory1
Loop N1Party IdentificationOptional>1
N1Party IdentificationMandatory1
N2Additional Name InformationOptional2
N3Party LocationOptional2
N4Geographic LocationOptional1
CTTTransaction TotalsOptional1
SETransaction Set TrailerOptional1