820 Payment Order/Remittance Advice (005040)
This is the standard X12 005040 spec, with 53 loops and 142 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 820 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 820 files into TS820 objects. See ediFabric .NET.
ediFabric Native
Map version 005040 to the Native model with set_map, then parse 820 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 820 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 820 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 TS820. 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.
820 structure
Loops and segments of the standard 820, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| BPR | Beginning Segment for Payment Order/Remittance Advice | Mandatory | 1 |
| NTE | Note/Special Instruction | Optional | >1 |
| TRN | Trace | Optional | 1 |
| CUR | Currency | Optional | 1 |
| REF | Reference Information | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop N1 | Party Identification | Optional | >1 |
| N1 | Party Identification | Mandatory | 1 |
| N2 | Additional Name Information | Optional | >1 |
| N3 | Party Location | Optional | >1 |
| N4 | Geographic Location | Optional | 1 |
| REF | Reference Information | Optional | >1 |
| PER | Administrative Communications Contact | Optional | >1 |
| RDM | Remittance Delivery Method | Optional | 1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop ENT | Entity | Optional | >1 |
| ENT | Entity | Mandatory | 1 |
| Loop FA1 | Type of Financial Accounting Data | Optional | >1 |
| FA1 | Type of Financial Accounting Data | Mandatory | 1 |
| FA2 | Accounting Data | Mandatory | >1 |
| Loop NM1 | Individual or Organizational Name | Optional | >1 |
| NM1 | Individual or Organizational Name | Mandatory | 1 |
| N2 | Additional Name Information | Optional | >1 |
| N3 | Party Location | Optional | >1 |
| N4 | Geographic Location | Optional | 1 |
| REF | Reference Information | Optional | >1 |
| PER | Administrative Communications Contact | 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 Information | Optional | >1 |
| REF | Reference Information | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop IT1 | Baseline Item Data (Invoice) | Optional | >1 |
| IT1 | Baseline Item Data (Invoice) | Mandatory | 1 |
| RPA | Rate Amounts or Percents | Optional | 1 |
| QTY | Quantity Information | Optional | 1 |
| Loop REF | Reference Information | Optional | >1 |
| REF | Reference Information | 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 |
| DTM | Date/Time Reference | Optional | 10 |
| Loop SLN | Subline Item Detail | Optional | >1 |
| SLN | Subline Item Detail | Mandatory | 1 |
| Loop REF | Reference Information | Optional | >1 |
| REF | Reference Information | 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 FA1 | Type of Financial Accounting Data | Optional | >1 |
| FA1 | Type of Financial Accounting Data | Mandatory | 1 |
| FA2 | Accounting Data | Mandatory | >1 |
| Loop RMR | Remittance Advice Accounts Receivable Open Item Reference | Optional | >1 |
| RMR | Remittance Advice Accounts Receivable Open Item Reference | Mandatory | 1 |
| NTE | Note/Special Instruction | Optional | >1 |
| REF | Reference Information | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| VEH | Vehicle Information | Optional | 1 |
| Loop IT1 | Baseline Item Data (Invoice) | Optional | >1 |
| IT1 | Baseline Item Data (Invoice) | Mandatory | 1 |
| RPA | Rate Amounts or Percents | Optional | 1 |
| QTY | Quantity Information | Optional | 1 |
| Loop REF | Reference Information | Optional | >1 |
| REF | Reference Information | 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 Information | Optional | >1 |
| REF | Reference Information | 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 Information | Optional | >1 |
| REF | Reference Information | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop IT1 | Baseline Item Data (Invoice) | Optional | >1 |
| IT1 | Baseline Item Data (Invoice) | Mandatory | 1 |
| RPA | Rate Amounts or Percents | Optional | 1 |
| QTY | Quantity Information | Optional | 1 |
| Loop REF | Reference Information | Optional | >1 |
| REF | Reference Information | 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 |
| DTM | Date/Time Reference | Optional | 10 |
| Loop SLN | Subline Item Detail | Optional | >1 |
| SLN | Subline Item Detail | Mandatory | 1 |
| Loop REF | Reference Information | Optional | >1 |
| REF | Reference Information | 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 FA1 | Type of Financial Accounting Data | Optional | >1 |
| FA1 | Type of Financial Accounting Data | Mandatory | 1 |
| FA2 | Accounting Data | Mandatory | >1 |
| Loop TXP | Tax Payment | Optional | >1 |
| TXP | Tax Payment | Mandatory | 1 |
| TXI | Tax Information | Optional | >1 |
| REF | Reference Information | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop DED | Deductions | Optional | >1 |
| DED | Deductions | Mandatory | 1 |
| Loop LX | Transaction Set Line Number | Optional | >1 |
| LX | Transaction Set Line Number | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| TRN | Trace | Optional | >1 |
| Loop NM1 | Individual or Organizational Name | Optional | >1 |
| NM1 | Individual or Organizational Name | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| G53 | Maintenance Type | Optional | 1 |
| Loop AIN | Income | Optional | >1 |
| AIN | Income | Mandatory | 1 |
| QTY | Quantity Information | Optional | >1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop PEN | Pension Information | Optional | >1 |
| PEN | Pension Information | Mandatory | 1 |
| AMT | Monetary Amount Information | 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 |
| Loop N9 | Extended Reference Information | Optional | 1 |
| N9 | Extended Reference Information | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| Loop AMT | Monetary Amount Information | Optional | >1 |
| AMT | Monetary Amount Information | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| Loop N1 | Party Identification | Optional | >1 |
| N1 | Party Identification | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| Loop EMS | Employment Position | Optional | >1 |
| EMS | Employment Position | Mandatory | 1 |
| ATN | Attendance | Optional | >1 |
| AIN | Income | Optional | >1 |
| PYD | Payroll Deduction | Optional | >1 |
| Loop RYL | Royalty Payment | Optional | >1 |
| RYL | Royalty Payment | Mandatory | 1 |
| Loop NM1 | Individual or Organizational Name | Optional | >1 |
| NM1 | Individual or Organizational Name | Mandatory | 1 |
| Loop LOC | Location | Optional | >1 |
| LOC | Location | Mandatory | 1 |
| Loop PID | Product/Item Description | Optional | >1 |
| PID | Product/Item Description | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop PCT | Percent Amounts | Optional | >1 |
| PCT | Percent Amounts | Mandatory | 1 |
| QTY | Quantity Information | Optional | 1 |
| Loop AMT | Monetary Amount Information | Optional | >1 |
| AMT | Monetary Amount Information | Mandatory | 1 |
| ADX | Adjustment | Optional | >1 |
| Loop ASM | Amount and Settlement Method | Optional | 1 |
| ASM | Amount and Settlement Method | Mandatory | 1 |
| ADX | Adjustment | Optional | 1 |
| Loop INS | Insured Benefit | Optional | >1 |
| INS | Insured Benefit | Mandatory | 1 |
| QTY | Quantity Information | Optional | >1 |
| NM1 | Individual or Organizational Name | Optional | 1 |
| REF | Reference Information | Optional | >1 |
| DMG | Demographic Information | Optional | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| Loop ADX | Adjustment | Optional | >1 |
| ADX | Adjustment | Mandatory | 1 |
| DTM | Date/Time Reference | Optional | 1 |
| Loop HD | Health Coverage | Optional | >1 |
| HD | Health Coverage | Mandatory | 1 |
| DTP | Date or Time or Period | Optional | >1 |
| REF | Reference Information | Optional | >1 |
| Loop RMR | Remittance Advice Accounts Receivable Open Item Reference | Optional | >1 |
| RMR | Remittance Advice Accounts Receivable Open Item Reference | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| Loop ADX | Adjustment | Optional | >1 |
| ADX | Adjustment | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| Loop N1 | Party Identification | Optional | >1 |
| N1 | Party Identification | Mandatory | 1 |
| REF | Reference Information | Optional | >1 |
| DTM | Date/Time Reference | Optional | >1 |
| SE | Transaction Set Trailer | Optional | 1 |