823 Lockbox (004020)
This is the standard X12 004020 spec, with 35 loops and 95 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 823 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 823 files into TS823 objects. See ediFabric .NET.
ediFabric Native
Map version 004020 to the Native model with set_map, then parse 823 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 823 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 823 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 TS823. 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.
823 structure
Loops and segments of the standard 823, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| Loop N1 | Name | Mandatory | 2 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| REF | Reference Identification | Optional | 12 |
| PER | Administrative Communications Contact | Optional | 3 |
| TRN | Trace | Optional | 1 |
| DTM | Date/Time Reference | Optional | 2 |
| Loop DEP | Deposit | Mandatory | 100 |
| DEP | Deposit | Mandatory | 1 |
| AMT | Monetary Amount | Mandatory | 1 |
| QTY | Quantity | Mandatory | 2 |
| REF | Reference Identification | Optional | 5 |
| DTM | Date/Time Reference | Optional | 10 |
| Loop BAT | Batch | Optional | >1 |
| BAT | Batch | Mandatory | 1 |
| AVA | Funds Availability | Optional | 10 |
| AMT | Monetary Amount | Optional | 1 |
| QTY | Quantity | Optional | 1 |
| DTM | Date/Time Reference | Optional | 10 |
| Loop BPR | Beginning Segment for Payment Order/Remittance Advice | Optional | >1 |
| BPR | Beginning Segment for Payment Order/Remittance Advice | Mandatory | 1 |
| TRN | Trace | Optional | 1 |
| CUR | Currency | Optional | 1 |
| REF | Reference Identification | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| AVA | Funds Availability | Optional | 1 |
| Loop ADX | Adjustment | Optional | >1 |
| ADX | Adjustment | Mandatory | 1 |
| NTE | Note/Special Instruction | Optional | >1 |
| PER | Administrative Communications Contact | Optional | >1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop IT1 | Baseline Item Data (Invoice) | Optional | >1 |
| IT1 | Baseline Item Data (Invoice) | Mandatory | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop SAC | Service, Promotion, Allowance, or Charge Information | Optional | >1 |
| SAC | Service, Promotion, Allowance, or Charge Information | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop SLN | Subline Item Detail | Optional | >1 |
| SLN | Subline Item Detail | Mandatory | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop SAC | Service, Promotion, Allowance, or Charge Information | Optional | >1 |
| SAC | Service, Promotion, Allowance, or Charge Information | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop N1 | Name | Optional | 200 |
| N1 | Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Address Information | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| REF | Reference Identification | Optional | 12 |
| PER | Administrative Communications Contact | Optional | 3 |
| Loop RMR | Remittance Advice Accounts Receivable Open Item Reference | Optional | >1 |
| RMR | Remittance Advice Accounts Receivable Open Item Reference | Mandatory | 1 |
| N1 | Name | Optional | 1 |
| CUR | Currency | Optional | 1 |
| REF | Reference Identification | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop IT1 | Baseline Item Data (Invoice) | Optional | >1 |
| IT1 | Baseline Item Data (Invoice) | Mandatory | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop SAC | Service, Promotion, Allowance, or Charge Information | Optional | >1 |
| SAC | Service, Promotion, Allowance, or Charge Information | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop SLN | Subline Item Detail | Optional | >1 |
| SLN | Subline Item Detail | Mandatory | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop SAC | Service, Promotion, Allowance, or Charge Information | Optional | >1 |
| SAC | Service, Promotion, Allowance, or Charge Information | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop ADX | Adjustment | Optional | >1 |
| ADX | Adjustment | Mandatory | 1 |
| NTE | Note/Special Instruction | Optional | >1 |
| PER | Administrative Communications Contact | Optional | >1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop IT1 | Baseline Item Data (Invoice) | Optional | >1 |
| IT1 | Baseline Item Data (Invoice) | Mandatory | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop SAC | Service, Promotion, Allowance, or Charge Information | Optional | >1 |
| SAC | Service, Promotion, Allowance, or Charge Information | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop SLN | Subline Item Detail | Optional | >1 |
| SLN | Subline Item Detail | Mandatory | 1 |
| Loop REF | Reference Identification | Optional | >1 |
| REF | Reference Identification | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop SAC | Service, Promotion, Allowance, or Charge Information | Optional | >1 |
| SAC | Service, Promotion, Allowance, or Charge Information | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop TXP | Tax Payment | Optional | >1 |
| TXP | Tax Payment | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| Loop DED | Deductions | Optional | >1 |
| DED | Deductions | Mandatory | 1 |
| Loop LX | Assigned Number | Optional | >1 |
| LX | Assigned Number | Mandatory | 1 |
| REF | Reference Identification | Optional | >1 |
| TRN | Trace | Optional | >1 |
| Loop NM1 | Individual or Organizational Name | Optional | >1 |
| NM1 | Individual or Organizational Name | Mandatory | 1 |
| REF | Reference Identification | Optional | >1 |
| G53 | Maintenance Type | Optional | >1 |
| Loop AIN | Income | Optional | >1 |
| AIN | Income | Mandatory | 1 |
| QTY | Quantity | Optional | >1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop PEN | Pension Information | Optional | >1 |
| PEN | Pension Information | Mandatory | 1 |
| AMT | Monetary Amount | Optional | >1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop INV | Investment Vehicle Selection | Optional | >1 |
| INV | Investment Vehicle Selection | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| SE | Transaction Set Trailer | Optional | 1 |