568 Contract Payment Management Report (004020)
This is the standard X12 004020 spec, with 9 loops and 32 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.
Use the 568 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 568 files into TS568 objects. See ediFabric .NET.
ediFabric Native
Map version 004020 to the Native model with set_map, then parse 568 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 568 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 568 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 TS568. 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.
568 structure
Loops and segments of the standard 568, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| BGN | Beginning Segment | Mandatory | 1 |
| AMT | Monetary Amount | Mandatory | 2 |
| Loop N1 | Name | Optional | 10 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| PER | Administrative Communications Contact | Optional | 1 |
| Loop CS | Contract Summary | Optional | >1 |
| CS | Contract Summary | Mandatory | 1 |
| N9 | Reference Identification | Optional | 3 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop LM | Code Source Information | Optional | 10 |
| LM | Code Source Information | Mandatory | 1 |
| LQ | Industry Code | Mandatory | 100 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| Loop LX | Assigned Number | Optional | >1 |
| LX | Assigned Number | Mandatory | 1 |
| N9 | Reference Identification | Mandatory | 1 |
| AMT | Monetary Amount | Optional | >1 |
| QTY | Quantity | Optional | 1 |
| Loop LM | Code Source Information | Optional | 10 |
| LM | Code Source Information | Mandatory | 1 |
| LQ | Industry Code | Mandatory | 100 |
| Loop N1 | Name | Optional | 1 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| N9 | Reference Identification | Optional | 2 |
| Loop FA1 | Type of Financial Accounting Data | Optional | >1 |
| FA1 | Type of Financial Accounting Data | Mandatory | 1 |
| FA2 | Accounting Data | Mandatory | >1 |
| Loop BAL | Balance Detail | Optional | >1 |
| BAL | Balance Detail | Mandatory | 1 |
| N9 | Reference Identification | Optional | >1 |
| RTE | Rate Information | Optional | >1 |
| CTT | Transaction Totals | Optional | 1 |
| SE | Transaction Set Trailer | Optional | 1 |