567 Contract Completion Status (003040)
This is the standard X12 003040 spec, with 3 loops and 18 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 567 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 567 files into TS567 objects. See ediFabric .NET.
ediFabric Native
Map version 003040 to the Native model with set_map, then parse 567 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 567 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 567 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 TS567. 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.
567 structure
Loops and segments of the standard 567, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| BC | Beginning Segment for Contract Completion Status | Mandatory | 1 |
| N1 | Name | Optional | 2 |
| G61 | Contact | Optional | 1 |
| NTE | Note/Special Instruction | Optional | 100 |
| Loop CS | Contract Summary | Mandatory | 100 |
| CS | Contract Summary | Mandatory | 1 |
| AMT | Monetary Amount | Optional | 1 |
| N9 | Reference Number | Optional | 1 |
| G62 | Date/Time | Optional | 3 |
| G61 | Contact | Optional | 1 |
| NTE | Note/Special Instruction | Optional | 5 |
| Loop LM | Code Source Information | Optional | 10 |
| LM | Code Source Information | Mandatory | 1 |
| LQ | Industry Code | Mandatory | 100 |
| 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 |
| SE | Transaction Set Trailer | Optional | 1 |