Download the PHP package eskrano/php-edi without Composer
On this page you can find all versions of the php package eskrano/php-edi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eskrano/php-edi
More information about eskrano/php-edi
Files in eskrano/php-edi
Package php-edi
Short Description EDI Management for PHP (from Coedition)
License MIT
Informations about the package php-edi
PHP EDI
This is a php library for EDI management.
Testing
Documentation
Docs are done via couscous. So make sure you have it installed globally.
Schedule For EDI Data Exchange
-
Inbound 832 - Price/Sales Catalog -A complete load of 832 file is sent daily between 10:00 PM and 11:30 PM EST. -No delta/change 832 files are sent.
-
Inbound 846 - Inventory Inquiry/Advice -A delta/change 846 file at top of the hour -A complete load of 846 file is sent daily between 10:00 PM and 11:30 PM EST
-
Inbound 855 – Purchase Order Acknowledgement -855 is sent within 2 hours of 850
-
Inbound 856 – Advance Shipment Notice -856 is sent within 2 hours of post shipment
- Outbound / Outbound 997 – Functional Acknowledgement -A functional acknowledgement will be exchanged for every I/O within 2 hours of transaction
EDI Specifications and Id's
FTP
Test (FTP)
ISA Qualifier & ID : 12 & 86643873224 GS ID: 86643873224
Production (FTP)
ISA Qualifier & ID : 12 & 86643873224 GS ID: 86643873224
EDI Specifications (Outbound-832 - ASC X12 004010)
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ISA | Interchange Control Header | M | 1 | |||
01 | I01 | Authorization Information Qual | M | ID | 2/2 | |
02 | I02 | Authorization Information | M | AN | 10/10 | |
03 | I03 | Security Information Qualifier | M | ID | 2/2 | |
04 | I04 | Security Information | M | AN | 10/10 | |
05 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
06 | I06 | Interchange Sender ID | M | AN | 15/15 | |
07 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
08 | I07 | Interchange Receiver ID | M | AN | 15/15 | |
09 | I08 | Interchange Date | M | DT | 6/6 | |
10 | I09 | Interchange Time | M | TM | 4/4 | |
11 | I10 | Interchange Control Standards Id | M | ID | 1/1 | |
12 | I11 | Interchange Control Version Num | M | ID | 5/5 | |
13 | I12 | Interchange Control Number | M | N0 | 9/9 | |
14 | I13 | Acknowledgment Requested | M | ID | 1/1 | |
15 | I14 | Usage Indicator | M | ID | 1/1 | |
16 | I15 | Component Element Separator | M | 1/1 | ||
GS | Functional Group Header | M | 1 | |||
01 | 479 | Functional Identifier Code | M | ID | 2/2 | |
2 | 142 | Application Sender's Code | M | AN | 2/15 | |
03 | 124 | Application Receiver's Code | M | AN | 2/15 | |
04 | 373 | Date | M | DT | 8/8 | |
05 | 337 | Time | M | TM | 4/8 | |
06 | 28 | Group Control Number | M | N0 | 1/9 | |
07 | 455 | Responsible Agency Code | M | ID | 1/2 | |
08 | 480 | Version / Release / Industry Id | M | AN | 1/12 |
Heading:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ST | Transaction Set Header | M | 1 | |||
01 | 143 | Transaction Set Identifier Code | M | ID | 3/3 | |
02 | 329 | Transaction Set Control Number | M | AN | 4/9 | |
BCT | Beginning Segment | M | 1 | |||
01 | 683 | Catalog Purpose | M | ID | 2/2 | |
SC – Sales Catalog | ||||||
02 | 684 | Catalog Number | M | AN | 1/15 | |
09 | 352 | Catalog Title | O | AN | 1/80 | |
10 | 353 | Transaction set purpose | O | ID | 2/2 | |
00 – Original – Complete |
Detail:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
LIN | Line Item Description | M | 1 | |||
01 | 350 | Assigned Identification | M | AN | 1/20 | |
02 | 235 | Product/Service ID Qualifier | M | ID | 2 | |
03 | 234 | Product Service ID | ||||
VP - Vendor’s (Seller’s) Part Number | M | AN | 1/18 | |||
MG - Manufacturer’s Part Number | M | AN | 1/20 | |||
UP - UPC Consumer Package Code | M | AN | 1/20 No dashes | |||
PID | Product/Item Description | M | 1 | |||
01 | 349 | Item Description Type | M | ID | 1/1 | |
F – Free Form | ||||||
05 | 352 | Description | M | AN | 1/40 | |
PO4 | Item Physical Details | M | 1 | |||
03 | 355 | Unit or Basis for Measurement | M | AN | 2/2 | |
EA - each | ||||||
06 | 384 | Gross Weight (in lbs) | O | N2 | 4/9 (6.2) | |
10 | 82 | Length (in inches) | O | N2 | 4/8 (5.2) | |
11 | 189 | Width (in inches) | O | N2 | 4/8 (5.2) | |
12 | 65 | Height (in inches) | O | N2 | 4/8 (6.2) | |
CTP | Pricing Information | M | 1 | 25 | ||
01 | 687 | Class of Trade Code | M | ID | 2/2 | |
DI - Distributor | ||||||
02 | 236 | Price Identifier Code | M | ID | 3/3 | |
‘CON’,’MSR’,’MNC’ | ||||||
03 | 212 | Price | M | N2 | 1/10 (8.2) |
Summary:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
CTT | Transaction Totals | M | 1 | |||
01 | 354 | Number of Line Items | M | N0 | 1/6 | |
SE | Transaction Set Trailer | M | 1 | |||
1 | 96 | Number of Included Segments | M | N0 | 1/10 | |
02 | 329 | Transaction Set Control Number | M | AN | 4/9 |
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
GE | Functional Group Trailer | M | 1 | |||
01 | 97 | Number of Transaction Sets Incl | M | N0 | 1/6 | |
02 | 28 | Group Control Number | M | N0 | 1/9 | |
IEA | Interchange Control Trailer | M | 1 | |||
01 | I16 | Num of Included Functional Grps | M | N0 | 1/5 | |
02 | I12 | Interchange Control Number | M | N0 | 9/9 |
EDI-832 Sample data
EDI Specifications (Outbound-846 - ASC X12 004010)
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ISA | Interchange Control Header | M | 1 | |||
01 | I01 | Authorization Information Qual | M | ID | 2/2 | |
02 | I02 | Authorization Information | M | AN | 10/10 | |
03 | I03 | Security Information Qualifier | M | ID | 2/2 | |
04 | I04 | Security Information | M | AN | 10/10 | |
05 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
06 | I06 | Interchange Sender ID | M | AN | 15/15 | |
07 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
08 | I07 | Interchange Receiver ID | M | AN | 15/15 | |
09 | I08 | Interchange Date | M | DT | 6/6 | |
10 | I09 | Interchange Time | M | TM | 4/4 | |
11 | I10 | Interchange Control Standards Id | M | ID | 1/1 | |
12 | I11 | Interchange Control Version Num | M | ID | 5/5 | |
13 | I12 | Interchange Control Number | M | N0 | 9/9 | |
14 | I13 | Acknowledgment Requested | M | ID | 1/1 | |
15 | I14 | Usage Indicator | M | ID | 1/1 | |
16 | I15 | Component Element Separator | M | 1/1 | ||
GS | Functional Group Header | M | 1 | |||
01 | 479 | Functional Identifier Code | M | ID | 2/2 | |
2 | 142 | Application Sender's Code | M | AN | 2/15 | |
03 | 124 | Application Receiver's Code | M | AN | 2/15 | |
04 | 373 | Date | M | DT | 8/8 | |
05 | 337 | Time | M | TM | 4/8 | |
06 | 28 | Group Control Number | M | N0 | 1/9 | |
07 | 455 | Responsible Agency Code | M | ID | 1/2 | |
08 | 480 | Version / Release / Industry Id | M | AN | 1/12 |
Heading:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ST | Transaction Set Header | M | 1 | |||
1 | 143 | Transaction Set Identifier Code | M | ID | 3/3 | |
2 | 329 | Transaction Set Control Number | M | AN | 4/9 | |
BIA | Beg. Segment for Inv. Inquiry | M | 1 | |||
01 | 353 | Transaction Set Purpose Code | M | ID | 2/2 | |
00 – Original | ||||||
25 - Incremental | ||||||
02 | 755 | Report Type Code | M | ID | 2/2 | |
DD – Distributor Inventory Report | ||||||
03 | 127 | Reference Identification | M | AN | 1/30 | |
04 | 373 | Date | M | DT | 8/8 |
Detail:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
LIN | Line Item Description | M | 1 | |||
01 | 350 | Assigned Identification | M | AN | 1/20 | |
2 | 235 | Product/Service ID Qualifier | M | ID | 2 | |
3 | 234 | Product Service ID | ||||
VP - Vendors Part Number | M | AN | 1/18 | |||
CTP | Pricing Information | M | 1 | |||
01 | 687 | Class of Trade Code | M | ID | 2/2 | |
2 | 236 | Price Identifier (CON or MSR) | M | ID | 3/3 | |
3 | 212 | Unit Price | M | R | 1/17 | |
CTP is Optional if you are sending an 832, if no 832, CTP is mandatory | ||||||
QTY | Quantity | M | 10 | |||
01 | 673 | Quantity Qualifier | M | ID | 2 | |
33 – Quantity Available for sale | ||||||
02 | 380 | Quantity | M | ID | 1/15 | |
03 | C001 | Composite Unit of Measure | O | |||
EA – Each |
Summary:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
CTT | Transaction Totals | M | 1 | |||
01 | 354 | Number of Line Items | M | N0 | 1/6 | |
SE | Transaction Set Trailer | M | 1 | |||
1 | 96 | Number of Included Segments | M | N0 | 1/10 | |
02 | 329 | Transaction Set Control Number | M | AN | 4/9 |
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
GE | Functional Group Trailer | M | 1 | |||
01 | 97 | Number of Transaction Sets Incl | M | N0 | 1/6 | |
02 | 28 | Group Control Number | M | N0 | 1/9 | |
IEA | Interchange Control Trailer | M | 1 | |||
01 | I16 | Num of Included Functional Grps | M | N0 | 1/5 | |
02 | I12 | Interchange Control Number | M | N0 | 9/9 |
EDI-846 Sample data
EDI Specifications (Inbound-850 - ASC X12 004010)
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ISA | Interchange Control Header | M | 1 | |||
01 | I01 | Authorization Information Qual | M | ID | 2/2 | |
02 | I02 | Authorization Information | M | AN | 10/10 | |
03 | I03 | Security Information Qualifier | M | ID | 2/2 | |
04 | I04 | Security Information | M | AN | 10/10 | |
05 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
06 | I06 | Interchange Sender ID | M | AN | 15/15 | |
07 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
08 | I07 | Interchange Receiver ID | M | AN | 15/15 | |
09 | I08 | Interchange Date | M | DT | 6/6 | |
10 | I09 | Interchange Time | M | TM | 4/4 | |
11 | I10 | Interchange Control Standards Id | M | ID | 1/1 | |
12 | I11 | Interchange Control Version Num | M | ID | 5/5 | |
13 | I12 | Interchange Control Number | M | N0 | 9/9 | |
14 | I13 | Acknowledgment Requested | M | ID | 1/1 | |
15 | I14 | Usage Indicator | M | ID | 1/1 | |
16 | I15 | Component Element Separator | M | 1/1 | ||
GS | Functional Group Header | M | 1 | |||
01 | 479 | Functional Identifier Code | M | ID | 2/2 | |
2 | 142 | Application Sender's Code | M | AN | 2/15 | |
03 | 124 | Application Receiver's Code | M | AN | 2/15 | |
04 | 373 | Date | M | DT | 8/8 | |
05 | 337 | Time | M | TM | 4/8 | |
06 | 28 | Group Control Number | M | N0 | 1/9 | |
07 | 455 | Responsible Agency Code | M | ID | 1/2 | |
08 | 480 | Version / Release / Industry Id | M | AN | 1/12 |
Heading:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ST | Transaction Set Header | M | 1 | |||
1 | 143 | Transaction Set Identifier Code | M | ID | 3/3 | |
2 | 329 | Transaction Set Control Number | M | AN | 4/9 | |
BEG | Beginning Segment for PO | M | 1 | |||
01 | 353 | Transaction Set Purpose Code | M | ID | 2/2 | |
00 - Original | ||||||
02 | 92 | Purchase Order Type Code | M | ID | 2/2 | |
DS - Dropship | ||||||
03 | 324 | Purchase Order Number | M | AN | 1/20 | |
05 | 373 | Date | M | DT | 8/8 | |
REF | Reference Identification | O | 5 | |||
1 | 128 | Reference Identification Qualifier | M | ID | 2/3 | |
2 | 127 | Reference Identification | ||||
ZZ – Mutually Defined | O | AN | 1/30 | |||
TD5 | Carrier Details (Routing Seq) | O | 1 | |||
1 | 133 | Routing Sequence Code | M | ID | 1/2 | |
2 | 66 | Identification Code Qualifier | M | ID | 1/2 | |
3 | 67 | Identification Code | M | AN | 1/4 | |
N1 | Name | M | 1 | |||
1 | 98 | Entity Identifier Code | M | ID | 2/3 | |
ST - Ship To | ||||||
2 | 93 | Company Name | M | AN | 1/36 | |
N2 | Additional Name Information | O | 2 | |||
1 | 93 | Name | O | AN | 1/36 | |
2 | 93 | Address (REF2) | O | AN | 1/36 | |
N3 | Address Information | M | 2 | |||
1 | 166 | Street Address | M | AN | 1/36 | |
2 | 166 | Addl. Address (REF1) | O | AN | 1/36 | |
N4 | Geographic Location | M | 1 | |||
1 | 19 | City Name | M | AN | 2/20 | |
2 | 156 | State or Province Code | M | ID | 2/2 | |
3 | 116 | Postal Code | M | ID | 5/10 | |
PER | Administrative Com Contact | O | 1 | |||
1 | 366 | Contact Function Code | M | ID | 2/2 | |
IC – Information Contact | ||||||
2 | 93 | Name | M | AN | 1/36 |
Detail:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
PO1 | Baseline Item Data | M | 1 | |||
1 | 350 | Assigned Identification | M | N0 | 1/4 | |
2 | 330 | Quantity Ordered | M | N0 | 1/10 | |
3 | 355 | Unit or Basis for Measurement | M | ID | 2/2 | |
EA - Each | ||||||
4 | 212 | Unit Price | M | N2 | 4/10 (8.2) | |
6 | 235 | Product/Service ID Qualifier | M | ID | 2/2 | |
7 | 234 | Product/Service ID | ||||
BP - Creative Computers Part Number | M | AN | 1/20 | |||
VP - Vendors Part Number | M | AN | 1/18 |
Summary:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
CTT | Transaction Totals | M | 1 | |||
01 | 354 | Number of Line Items | M | N0 | 1/6 | |
SE | Transaction Set Trailer | M | 1 | |||
1 | 96 | Number of Included Segments | M | N0 | 1/10 | |
02 | 329 | Transaction Set Control Number | M | AN | 4/9 |
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
GE | Functional Group Trailer | M | 1 | |||
01 | 97 | Number of Transaction Sets Incl | M | N0 | 1/6 | |
02 | 28 | Group Control Number | M | N0 | 1/9 | |
IEA | Interchange Control Trailer | M | 1 | |||
01 | I16 | Num of Included Functional Grps | M | N0 | 1/5 | |
02 | I12 | Interchange Control Number | M | N0 | 9/9 |
EDI-850 Sample data
EDI Specifications (Outbound-855 - ASC X12 004010)
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ISA | Interchange Control Header | M | 1 | |||
01 | I01 | Authorization Information Qual | M | ID | 2/2 | |
02 | I02 | Authorization Information | M | AN | 10/10 | |
03 | I03 | Security Information Qualifier | M | ID | 2/2 | |
04 | I04 | Security Information | M | AN | 10/10 | |
05 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
06 | I06 | Interchange Sender ID | M | AN | 15/15 | |
07 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
08 | I07 | Interchange Receiver ID | M | AN | 15/15 | |
09 | I08 | Interchange Date | M | DT | 6/6 | |
10 | I09 | Interchange Time | M | TM | 4/4 | |
11 | I10 | Interchange Control Standards Id | M | ID | 1/1 | |
12 | I11 | Interchange Control Version Num | M | ID | 5/5 | |
13 | I12 | Interchange Control Number | M | N0 | 9/9 | |
14 | I13 | Acknowledgment Requested | M | ID | 1/1 | |
15 | I14 | Usage Indicator | M | ID | 1/1 | |
16 | I15 | Component Element Separator | M | 1/1 | ||
GS | Functional Group Header | M | 1 | |||
01 | 479 | Functional Identifier Code | M | ID | 2/2 | |
2 | 142 | Application Sender's Code | M | AN | 2/15 | |
03 | 124 | Application Receiver's Code | M | AN | 2/15 | |
04 | 373 | Date | M | DT | 8/8 | |
05 | 337 | Time | M | TM | 4/8 | |
06 | 28 | Group Control Number | M | N0 | 1/9 | |
07 | 455 | Responsible Agency Code | M | ID | 1/2 | |
08 | 480 | Version / Release / Industry Id | M | AN | 1/12 |
Heading:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ST | Transaction Set Header | M | 1 | |||
1 | 143 | Transaction Set Identifier Code | M | ID | 3/3 | |
2 | 329 | Transaction Set Control Number | M | AN | 4/9 | |
BAK | Begin Segment for PO Acknowledge | M | 1 | |||
01 | 353 | Transaction Set Purpose Code | M | ID | 2/2 | |
00 – Original | ||||||
02 | 587 | Acknowledgment Type | M | ID | 2/2 | |
AC Acknowledge - With Detail and Change | ||||||
AD Acknowledge - With Detail, No Change | ||||||
AK Acknowledge - No Detail or Change | ||||||
AT Accepted | ||||||
RD Reject with Detail | ||||||
RJ Rejected - No Detail | ||||||
03 | 324 | Purchase Order Number | M | AN | 1/20 | |
4 | 373 | Date | M | DT | 8/8 |
Detail:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
PO1 | Baseline Item Data | M | 1 | |||
01 | 350 | Assigned Identification | M | N0 | 1/4 | |
02 | 330 | Quantity Ordered | M | N0 | 1/10 | |
03 | 355 | Unit or Basis for Measurement | M | ID | 2/2 | |
EA - each | ||||||
04 | 212 | Unit Price | M | N2 | 4/10 (8.2) | |
06 | 235 | Product/Service ID Qualifier | M | ID | 2/2 | |
7 | 234 | Product/Service ID | ||||
VP - Vendors Part Number | M | AN | 1/18 | |||
ACK | Line Item Acknowledgment | M | 1 | |||
01 | 668 | Line Item Status Code | M | ID | 2/2 | |
*** | Allowable Acceptance Codes | |||||
AC – Item Accepted and Shipped | ||||||
IA – Item Accepted | ||||||
*** | Allowable Reject Codes | |||||
IR – Item Rejected | ||||||
02 | 380 | Quantity | M | N0 | 1/10 | |
03 | 355 | Unit or Basis for Measurement | M | ID | 2/2 | |
EA - each | ||||||
05 | 373 | Date | M | DT | 8/8 |
Summary:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
CTT | Transaction Totals | M | 1 | |||
01 | 354 | Number of Line Items | M | N0 | 1/6 | |
SE | Transaction Set Trailer | M | 1 | |||
1 | 96 | Number of Included Segments | M | N0 | 1/10 | |
02 | 329 | Transaction Set Control Number | M | AN | 4/9 |
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
GE | Functional Group Trailer | M | 1 | |||
01 | 97 | Number of Transaction Sets Incl | M | N0 | 1/6 | |
02 | 28 | Group Control Number | M | N0 | 1/9 | |
IEA | Interchange Control Trailer | M | 1 | |||
01 | I16 | Num of Included Functional Grps | M | N0 | 1/5 | |
02 | I12 | Interchange Control Number | M | N0 | 9/9 |
EDI-855 Sample data
EDI Specifications (Outbound-856 - ASC X12 004010)
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ISA | Interchange Control Header | M | 1 | |||
01 | I01 | Authorization Information Qual | M | ID | 2/2 | |
02 | I02 | Authorization Information | M | AN | 10/10 | |
03 | I03 | Security Information Qualifier | M | ID | 2/2 | |
04 | I04 | Security Information | M | AN | 10/10 | |
05 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
06 | I06 | Interchange Sender ID | M | AN | 15/15 | |
07 | I05 | Interchange ID Qualifier | M | ID | 2/2 | |
08 | I07 | Interchange Receiver ID | M | AN | 15/15 | |
09 | I08 | Interchange Date | M | DT | 6/6 | |
10 | I09 | Interchange Time | M | TM | 4/4 | |
11 | I10 | Interchange Control Standards Id | M | ID | 1/1 | |
12 | I11 | Interchange Control Version Num | M | ID | 5/5 | |
13 | I12 | Interchange Control Number | M | N0 | 9/9 | |
14 | I13 | Acknowledgment Requested | M | ID | 1/1 | |
15 | I14 | Usage Indicator | M | ID | 1/1 | |
16 | I15 | Component Element Separator | M | 1/1 | ||
GS | Functional Group Header | M | 1 | |||
01 | 479 | Functional Identifier Code | M | ID | 2/2 | |
2 | 142 | Application Sender's Code | M | AN | 2/15 | |
03 | 124 | Application Receiver's Code | M | AN | 2/15 | |
04 | 373 | Date | M | DT | 8/8 | |
05 | 337 | Time | M | TM | 4/8 | |
06 | 28 | Group Control Number | M | N0 | 1/9 | |
07 | 455 | Responsible Agency Code | M | ID | 1/2 | |
08 | 480 | Version / Release / Industry Id | M | AN | 1/12 |
Heading:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
ST | Transaction Set Header | M | 1 | |||
1 | 143 | Transaction Set Identifier Code | M | ID | 3/3 | |
2 | 329 | Transaction Set Control Number | M | AN | 4/9 | |
BSN | Beginning Segment for Ship Notice | M | 1 | |||
1 | 353 | Transaction Set Purpose Code | M | ID | 2/2 | |
2 | 396 | Shipment Identification | M | AN | 2/30 | |
3 | 373 | Date | M | DT | 8/8 | |
4 | 337 | Time | M | TM | 4/8 |
Detail:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
HL | Hierarchical Level | M | 1 | |||
1 | 628 | Hierarchical ID Number | M | AN | 1/12 | |
3 | 735 | Hierarchical Level Code | M | ID | 1/2 | |
S - Shipped | ||||||
TD5 | Carrier Details (Routing Seq/Time) | O | 1 | |||
2 | 66 | Identification Code Qualifier | C | ID | 1/2 | |
3 | 67 | Shipping Method Code | C | ID | 2/80 | |
REF | Reference Identification | O | 1 | |||
1 | 128 | Reference Identification Qualifier | M | ID | 2/2 | |
SI – Shipper’s Identifying Number | ||||||
2 | 127 | Reference Identification (Tracking #) | C | AN | 1/30 | |
DTM | Date/Time Qualifier | O | 1 | |||
1 | 374 | Date/Time Qualifier | M | ID | 3/3 | |
011 - Shipped | ||||||
2 | 373 | Date | C | DT | 8/8 | |
HL | Hierarchical Level | M | 1 | |||
1 | 628 | Hierarchical ID Number | M | AN | 1/12 | |
3 | 735 | Hierarchical Level Code | M | ID | 1/2 | |
O – Order Level | ||||||
PRF | Purchase Order Reference | O | 1 | |||
1 | 324 | Purchase Order Number | M | AN | 1/22 | |
HL | Hierarchical Level | M | 1 | |||
1 | 628 | Hierarchical ID Number | M | AN | 1/12 | |
3 | 735 | Hierarchical Level Code | M | ID | 1/2 | |
I – Item Level | ||||||
LIN | Line Identification | O | 1 | |||
1 | 350 | Assigned Identification | O | AN | 1/20 | |
2 | 235 | Product/Service ID Qualifier | M | ID | 2/2 | |
VP – Vendor’s(Seller’s) Part Number | ||||||
3 | 234 | Product/Service ID | M | AN | 1/48 | |
SN1 | Item Detail (Shipment) | O | 1 | |||
2 | 382 | Number of Units Shipped | M | R | 1/10 | |
3 | 355 | Unit or Basis for Measurement Code | M | ID | 2/2 |
Summary:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
SAC | Service, Promotion, Allowance | O | 1 | |||
1 | 248 | Allowance or Charge Indicator | M | ID | 1/1 | |
C – Charge | ||||||
2 | 1300 | Service, Promotion, Allowance | M | ID | 4/4 | |
G830 – Shipping and Handling | ||||||
5 | 610 | Amount | O | N2 | 1/15 (8.2) | |
CTT | Transaction Totals | M | 1 | |||
01 | 354 | Number of Line Items | M | N0 | 1/6 | |
SE | Transaction Set Trailer | M | 1 | |||
1 | 96 | Number of Included Segments | M | N0 | 1/10 | |
02 | 329 | Transaction Set Control Number | M | AN | 4/9 |
Envelope:
SegID | Ref. Des. | Elem. | Name | Req. | Type | Max Usage |
---|---|---|---|---|---|---|
GE | Functional Group Trailer | M | 1 | |||
01 | 97 | Number of Transaction Sets Incl | M | N0 | 1/6 | |
02 | 28 | Group Control Number | M | N0 | 1/9 | |
IEA | Interchange Control Trailer | M | 1 | |||
01 | I16 | Num of Included Functional Grps | M | N0 | 1/5 | |
02 | I12 | Interchange Control Number | M | N0 | 9/9 |
EDI-856 Sample data
EDI Specifications (Outbound-997 - ASC X12)
Purpose: This draft standard for trial use contains the format and establishes the data contents of the Functional Acknowledgment Transaction Set (997) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to define the control structures for a set of acknowledgments to indicate the results of the syntactical analysis of the electronically encoded documents. The encoded documents are the transaction sets, which are grouped in functional groups, used in defining transactions for business data interchange. This standard does not cover the semantic meaning of the information encoded in the transaction sets.
Not Defined:
Id | Segment Name | Req | Max Use | Repeat | Notes | Usage |
---|---|---|---|---|---|---|
ISA | Interchange Control Header | M | 1 | Must use | ||
GS | Functional Group Header | M | 1 | Must use |
Heading:
Id | Segment Name | Req | Max Use | Repeat | Notes | Usage |
---|---|---|---|---|---|---|
ST | Transaction Set Header | M | 1 | N1/010 | Must use | |
AK1 | Functional Group Response Header | M | 1 | N1/020 | Must use | |
AK2 - Loop | 999999 | N1/030L | ||||
AK2 | Transaction Set Response Header | O | 1 | N1/030 | Used | |
AK5 | Transaction Set Response Trailer | M | 1 | Must use | ||
AK9 | Functional Group Response | M | 1 | Must use | ||
SE | Transaction Set Trailer | M | 1 | Must use |
Not Defined:
Id | Segment Name | Req | Max Use | Repeat | Notes | Usage |
---|---|---|---|---|---|---|
GE | Functional Group Trailer | M | 1 | Must Use | ||
IEA | Interchange Control Trailer | M | 1 | Must Use |
ISA Interchange Control Header
Loop: Level: Usage: Mandatory Max Use: 1 Purpose: To start and identify an interchange of zero or more functional groups and interchange-related control segments.
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
ISA01 | I01 | Qualifier | M | ID | 2/2 | 0 |
ISA02 | I02 | Authorization | M | AN | 10/10 | Blanks |
ISA03 | I03 | Qualifier | M | ID | 2/2 | 0 |
ISA04 | I04 | Security | M | AN | 10/10 | Blanks |
ISA05 | I05 | Qualifier | M | ID | 2/2 | 01 – DUNS |
08 – UCC Comm ID | ||||||
12 – Telephone Number | ||||||
ZZ – Mutually Defined (Valoran Supplier ID) | ||||||
ISA06 | I06 | Sender ID | M | AN | 15/15 | Duns Number |
UCC Communication ID | ||||||
Telephone Number | ||||||
Valoran Supplier ID | ||||||
ISA07 | I05 | Qualifier | M | ID | 2/2 | 12 – Telephone Number |
ISA08 | I07 | Receiver ID | M | AN | 15/15 | Telephone Number – for Valoran use 5215382901 |
ISA09 | I08 | Date | M | DT | 6/6 | YYMMDD |
ISA10 | I09 | Time | M | TM | 4/4 | HHMM (UTC) |
ISA11 | I65 | Repetition Separator | M | 1/1 | U | |
ISA12 | I11 | Interchange Control Version Number | M | ID | 5/5 | 00501 |
ISA13 | I12 | Interchange Control Number | M | NO | 9/9 | Sequential Number |
ISA14 | I13 | Request Acknowledgment | M | ID | 1/1 | 0 |
ISA15 | I14 | Test Indicator | M | ID | 1/1 | P – Production |
T – Test | ||||||
ISA16 | I15 | Component Element Separator | M | 1/1 | > |
GS Functional Group Header
Loop: Level: Usage: Mandatory Max Use: 1 Purpose: To indicate the beginning of a functional group and to provide control. Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
GS01 | 479 | ID | M | ID | 2/2 | FA |
GS02 | 142 | Sender’s Code | M | AN | 2/15 | Same as ISA06 |
GS03 | 124 | Receiver’s Code | M | AN | 2/15 | Same as ISA08 |
GS04 | 373 | Date | M | DT | 8/8 | CCYYMMDD (group date) |
GS05 | 337 | Time | M | TM | 4/8 | HHMM (group time – UTC) |
GS06 | 28 | Group Control Number | M | NO | 1/9 | Sequential Number (same as GE02) |
GS07 | 455 | Agency Code | M | ID | 1/2 | X |
GS08 | 480 | Version | M | AN | 1/12 | 005010 |
ST Transaction Set Header
Loop: Level: Heading Usage: Mandatory Max Use: 1 Purpose: To indicate the start of a transaction set and to assign a control number. Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
ST01 | 143 | Transaction Set Identifier Code | M | ID | 3/3 | 997 Functional Acknowledgement |
ST02 | 329 | Transaction Set Control Number | M | AN | 4/9 |
AK1 Functional Group Response Header
Loop: Level: Heading Usage: Mandatory Max Use: 1 Purpose: To start acknowledgment of a functional group Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
AK101 | 479 | Functional Identifier Code | M | ID | 2/2 | PO – Purchase Order (850) |
IN – Invoice Information (810) | ||||||
PR – Purchase Order Acknowledgment (855) | ||||||
SH – Ship Notice (856) | ||||||
AK102 | 28 | Group Control Number | M | NO | 1/9 |
Loop Transaction Set Response Header
Loop: AK2 Usage: Used Repeat: 999999 Purpose: To start acknowledgment of a single transaction set. Notes:
ID | Segment Name | Req | Max Use | Repeat | Usage |
---|---|---|---|---|---|
AK2 | Transaction Set Response Header | O | 1 | Used | |
AK5 | Transaction Set Response Trailer | M | 1 | Must Use |
AK2 Transaction Set Response Header
Loop: AK2 Level: Heading Usage: Used Max Use: 1 Purpose: To start acknowledgment of a single transaction set Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
AK201 | 143 | Transaction Set Identifier | M | ID | 3/3 | 850 – Purchase Order |
855 – Purchase Order Acknowledgment | ||||||
856 – ASN | ||||||
810 – Invoice | ||||||
AK202 | 329 | Transaction Set Control Number | M | AN | 4/9 |
AK5 Transaction Set Response Trailer
Loop: AK2 Level: Heading Usage: Mandatory Max Use: 1 Purpose: To acknowledge acceptance or rejection and report errors in a transaction set Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
AK501 | 717 | Transaction Set Acknowledgement Code | M | ID | 1/1 | A - Accepted |
E - Accepted But Errors Were Noted | ||||||
R - Rejected | ||||||
E - Accepted But Errors Were Noted | ||||||
R - Rejected |
AK9 Functional Group Response Trailer
Loop: Level: Heading Usage: Mandatory Max Use: 1 Purpose: To acknowledge acceptance or rejection of a functional group and report the number of included transaction sets from the original trailer, the accepted sets, and the received sets in this functional group Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
AK901 | 715 | Functional Group Acknowledge Code | M | ID | 1/1 | A -Accepted |
E -Accepted But Errors Were Noted | ||||||
R -Rejected | ||||||
AK902 | 97 | Number of Transaction Sets Included | M | NO | 1/6 | |
AK903 | 123 | Number of Received Transaction Sets | M | NO | 1/6 | |
AK904 | 2 | Number of Accepted Transaction Sets | M | NO | 1/6 |
SE Transaction Set Trailer
Loop: Usage: Mandatory Max Use: 1 Purpose: To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
SE01 | 96 | Number of Included Segments | M | NO | 1/10 | Total Number of Segments |
SE02 | 329 | Transaction Set Control Number | O | AN | 4/9 | Sum of values of the specified data element. |
GE Functional Group Trailer
Loop: Usage: Mandatory Max Use: 1 Purpose: End of functional group. Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
GE01 | 97 | Number of Transaction Sets Included | M | NO | 1/6 | Total Number of Transaction Sets |
GE02 | 28 | Transaction Set Control Number | M | NO | 1/9 | Assigned number of originated by sender |
IEA Interchange Control Trailer
Loop: Usage: Mandatory Max Use: 1 Purpose: End of functional group. Notes:
Ref | ID | Name | Req | Type | Min/Max | Value/Comments |
---|---|---|---|---|---|---|
IEA01 | 116 | Number of Included Functional Groups | M | NO | 1/5 | Count of the number of functional groups |
IEA02 | 112 | Interchange Control Number | M | NO | 9/9 | Assigned number of originated by sender |
EDI-997 Sample data