EANCOM® 2002 S3
APERAK
Application error and acknowledgement
message
Edition 2012
1. Introduction ...................................................................................................................... 2 2. Message Structure Chart ................................................................................................ 4 3. Branching Diagram .......................................................................................................... 5 4. Segments Description ..................................................................................................... 6 5. Segments Layout............................................................................................................. 7 6. Example(s) .................................................................................................................... 20
EANCOM® 2002 S3 Part II The Messages
APERAK Application error and acknowledgement message
1. Introduction
© Copyright GS1 - 2 - Edition 2012
Status
MESSAGE TYPE : APERAK
REFERENCE DIRECTORY : D.01B
EANCOM® SUBSET VERSION : 003
Definition
A message from the party who received an original message, to the party who issued the original message, to acknowledge to the message issuer the receipt of the original message by the recipient’s application and to acknowledge errors made during the processing within the application.
Principles
A message which is first processed at translator level to detect syntax errors and to acknowledge its receipt (CONTRL) is then transmitted to the receiving application to be processed. Upon reaching this state the receiving application may issue an acknowledgement confirming receipt of the message by the application.
The picture below shows the difference between the CONTRL message and APERAK:
Ap
plic
atio
n
Ap
plic
atio
n
Tra
nsla
tor
Tra
nsla
tor
CONTRL
APERAK
The APERAK message should be generated by the application software NOT by an EDI-translator software.
The APERAK message must NOT be used to acknowledge the receipt of an interchange.
Parties as stated in the message which is being acknowledged, must be mentioned in the APERAK. Such parties are not the sender and the receiver identified at the interchange level.
Within one APERAK message it is NOT possible to acknowledge the receipt of more than one message.
Example with an INVOIC message:
EANCOM® 2002 S3 Part II The Messages
APERAK Application error and acknowledgement message
1. Introduction
© Copyright GS1 - 3 - Edition 2012
INVOIC
APERAK
Buyer Supplier
Number of the INVOIC (RFF)
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
2. Message Structure Chart
© Copyright GS1 - 4 - Edition 2012
Application error and acknowledgement message Heading Section
UNH 1 M 1 - Message header
BGM 2 M 1 - Beginning of message
DTM 3 C 9 - Date/time/period
SG2 C 9 - RFF-DTM
RFF 4 M 1 - Reference
DTM 5 C 9 - Date/time/period
SG3 C 9 - NAD
NAD 6 M 1 - Name and address
Application error and acknowledgement message Detail Section
SG4 C 99999 - ERC-FTX-SG5
ERC 7 M 1 - Application error information
FTX 8 C 1 - Free text
SG5 + C 9 - RFF-FTX
RFF + 9 M 1 - Reference
FTX + 10 C 9 - Free text
Application error and acknowledgement message Summary Section
UNT 11 M 1 - Message trailer
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
3. Branching Diagram
© Copyright GS1 - 5 - Edition 2012
0
1
2
3
UNH
M 1
1
BGM
M 1
2
DTM
C 9
3
SG2
C 9
RFF
M 1
4
DTM
C 9
5
SG3
C 9
NAD
M 1
6
SG4
C 99999
ERC
M 1
7
FTX
C 1
8
SG5
C 9
RFF
M 1
9
FTX
C 9
10
UNT
M 1
11
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
4. Segments Description
© Copyright GS1 - 6 - Edition 2012
Application error and acknowledgement message Heading Section
UNH - M 1 - Message header
This segment is used to head, identify and specify a message.
BGM - M 1 - Beginning of message
This segment is used to indicate the type and function of a message and to transmit the identifying number.
DTM - C 9 - Date/time/period
This segment is used to specify the date of the message.
SG2 - C 9 - RFF-DTM
A group of segments to specify the document/message to which the current message relates, and related date and time.
RFF - M 1 - Reference
This segment is used to specify reference numbers related to the message which is
being acknowledged.
DTM - C 9 - Date/time/period
This segment is used to specify dates or periods relating to the previous RFF
segment.
SG3 - C 9 - NAD
A group of segments to specify the identifications of message sender and message
receiver. NAD - M 1 - Name and address
This segment is used to identify the parties who exchanged the message which is
being acknowlegded.
Application error and acknowledgement message Detail Section
SG4 - C 99999 - ERC-FTX-SG5
A group of segments to identify the application error(s) within a specified received
message and to give specific details related to the error type or to precise the type
of acknowledgement. ERC - M 1 - Application error information
This segment is used to identify the type of application error in the previously sent message.
FTX - C 1 - Free text
This segment is used to provide free text information related to the application error.
SG5 - C 9 - RFF-FTX
A group of segments to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error; further details can be added to
identify the error more precisely. RFF - M 1 - Reference
This segment is used to specify reference numbers related to the message which is
being acknowledged.
FTX - C 9 - Free text
This segment is used to provide free text information related to the application error.
Application error and acknowledgement message Summary Section
UNT - M 1 - Message trailer
This segment is a mandatory UN/EDIFACT segment. It must always be the last segment in the message.
EANCOM®
2002 S4 Part II The Messages
APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 7 - Edition 2012
This section describes each segment used in the EANCOM® Application error and acknowledgement message.
The original EDIFACT segment layout is listed. The appropriate comments relevant to the EANCOM® subset are
indicated. Notes: 1. The segments are presented in the sequence in which they appear in the message. The segment or segment
group tag is followed by the (M)andatory / (C)onditional indicator, the maximum number of occurrences and the segment description.
2. Reading from left to right, in column one, the data element tags and descriptions are shown, followed by in
the second column the EDIFACT status (M or C), the field format, and the picture of the data elements. These first pieces of information constitute the original EDIFACT segment layout.
Following the EDIFACT information, EANCOM
® specific information is provided in the third, fourth, and fifth
columns. In the third column a status indicator for the use of (C)onditional EDIFACT data elements (see 2.1 through 2.3 below), in the fourth column the restricted indicator (see point 3 on the following page), and in the fifth column notes and code values used for specific data elements in the message.
2.1 (M)andatory data elements in EDIFACT segments retain their status in EANCOM®.
2.2 Additionally, there are five types of status for data elements with a (C)onditional EDIFACT status, whether for
simple, component or composite data elements. These are listed below and can be identified when relevant by the following abbreviations:
- REQUIRED
R Indicates that the entity is required and must be sent.
- ADVISED
A Indicates that the entity is advised or recommended.
- DEPENDENT
D Indicates that the entity must be sent in certain conditions, as defined by the relevant explanatory note.
- OPTIONAL
O Indicates that the entity is optional and may be sent at the discretion of the user.
- NOT USED
N Indicates that the entity is not used and should be omitted.
2.3 If a composite is flagged as N, NOT USED, all data elements within that composite will have blank status indicators assigned to them.
3. Status indicators detailed in the fourth column which directly relate to the code values detailed in the fifth
column may have two values:
- RESTRICTED
* A data element marked with an asterisk (*) in the fourth column indicates that the listed codes in column five are the only codes available for use with this data element, in this segment, in this message.
- OPEN
All data elements where coded representation of data is possible and a restricted set of code values is not indicated are open (no asterisk in fourth column). The available codes are listed in the EANCOM
® Data Elements and Code Sets Directory. Code values
may be given as examples or there may be a note on the format or type of code to be used.
4. Different colours are used for the code values in the segment details: restricted codes are in red and open codes in blue.
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 8 - Edition 2012
Segment number: 1
UNH - M 1 - Message header
Function:
A service segment starting and uniquely identifying a message. The message type code for the Application error and acknowledgement message is APERAK. Note: Application error and acknowledgement messages conforming to this document must contain the following data in segment UNH, composite S009: Data element 0065 APERAK 0052 D 0054 01B 0051 UN
EDIFACT GS1 * Description
0062 Message reference number M an..14 M Senders unique message reference. Sequence number of messages in the interchange. DE 0062 in UNT will have the same value. Generated by the sender.
S009 MESSAGE IDENTIFIER M M
0065 Message type M an..6 M * APERAK = Application error and acknowledgement message
0052 Message version number M an..3 M * D = Draft version/UN/EDIFACT Directory
0054 Message release number M an..3 M * 01B = Release 2001 - B
0051 Controlling agency M an..2 M * UN = UN/CEFACT
0057 Association assigned code C an..6 R * EAN003 = GS1 version control number (GS1 Code)
Indicates that the message is the EANCOM version 003 of the Application Error and Acknowledgement message.
0068 Common access reference C an..35 N
S010 STATUS OF THE TRANSFER
C N
0070 Sequence of transfers M n..2
0073 First and last transfer C a1
Segment Notes:
This segment is used to head, identify and specify a message. DE's 0065, 0052, 0054 and 0051: Indicate that the message is a UNSM Application Error and Acknowledgement message based on the D.01B directory under the control of the United Nations. Example: UNH+ME000001+APERAK:D:01B:UN:EAN003'
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 9 - Edition 2012
Segment number: 2
BGM - M 1 - Beginning of message
Function:
A segment to indicate the type and function of the message and to transmit the identifying number.
EDIFACT GS1 * Description
C002 DOCUMENT/MESSAGE NAME
C R
1001 Document name code C an..3 R * 305 = Application error and acknowledgement
1131 Code list identification code C an..17 N
3055 Code list responsible agency code
C an..3 N
1000 Document name C an..35 N
C106 DOCUMENT/MESSAGE IDENTIFICATION
C R
1004 Document identifier C an..35 R Number of the APERAK message assigned by document sender. This number has been given by the sender of this APERAK message it is NOT the number of the message which is being acknowledged. For global unique identification of documents Global Document Type Identifier (GDTI) is available.
1056 Version identifier C an..9 N
1060 Revision identifier C an..6 N
1225 Message function code C an..3 R * 6 = Confirmation 27 = Not accepted
4343 Response type code C an..3 N
Segment Notes:
This segment is used to indicate the type and function of a message and to transmit the identifying number. Example: BGM+305+100001+6'
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 10 - Edition 2012
Segment number: 3
DTM - C 9 - Date/time/period
Function:
A segment to specify related date/time.
EDIFACT GS1 * Description
C507 DATE/TIME/PERIOD M M
2005 Date or time or period function code qualifier
M an..3 M * 137 = Document/message date/time
2380 Date or time or period value C an..35 R
2379 Date or time or period format code
C an..3 R 102 = CCYYMMDD 203 = CCYYMMDDHHMM
Segment Notes:
This segment is used to specify the date of the message. DE 2005: Identification of the 'Document/message date/time' (code value 137) is mandatory in an EANCOM message. Example: DTM+137:200208301200:203' The Application Error and Acknowledgement message was created at 12 o'clock on the 30th of August 2002.
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 11 - Edition 2012
Segment number: 4
SG2 - C 9 - RFF-DTM
RFF - M 1 - Reference
Function:
A segment to indicate the reference number of the document/message.
EDIFACT GS1 * Description
C506 REFERENCE M M
1153 Reference code qualifier M an..3 M AAN = Delivery schedule number APQ = Commercial account summary
reference number AGG = Dispute number IV = Invoice number ON = Order number (buyer)
1154 Reference identifier C an..70 R This number is the same number as in the BGM segment (DE 1004) of the message which is being aknowledged.
1156 Document line identifier C an..6 N
4000 Reference version identifier C an..35 N
1060 Revision identifier C an..6 N
Segment Notes:
This segment is used to specify reference numbers related to the message which is being acknowledged. Example: RFF+ON:100001' The message being acknowledged is an order.
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 12 - Edition 2012
Segment number: 5
SG2 - C 9 - RFF-DTM
DTM - C 9 - Date/time/period
Function:
A segment to specify the date and time of the referenced document/message.
EDIFACT GS1 * Description
C507 DATE/TIME/PERIOD M M
2005 Date or time or period function code qualifier
M an..3 M * 171 = Reference date/time
2380 Date or time or period value C an..35 R The date/time indicated here is the same as the date/ time in the DTM segment under BGM used with qualifier 137 of the message which is being acknowledged.
2379 Date or time or period format code
C an..3 R 102 = CCYYMMDD 203 = CCYYMMDDHHMM
Segment Notes:
This segment is used to specify dates or periods relating to the previous RFF segment. Example: DTM+171:200208251000:203'
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 13 - Edition 2012
Segment number: 6
SG3 - C 9 - NAD
NAD - M 1 - Name and address
Function:
A segment to specify the identification of the message issuer and message receiver.
EDIFACT GS1 * Description
3035 Party function code qualifier M an..3 M BY = Buyer SU = Supplier
C082 PARTY IDENTIFICATION DETAILS
C A
3039 Party identifier M an..35 M For identification of parties it is recommended to use GLN - Format n13.
1131 Code list identification code C an..17 N
3055 Code list responsible agency code
C an..3 R * 9 = GS1
C058 NAME AND ADDRESS C O This composite may only be used to fulfill the requirements of directive 2003/58/EC, article 4.
3124 Name and address description M an..35 M
3124 Name and address description C an..35 O
3124 Name and address description C an..35 O
3124 Name and address description C an..35 O
3124 Name and address description C an..35 O
C080 PARTY NAME C D
3036 Party name M an..35 M Party Name in clear text.
3036 Party name C an..35 O
3036 Party name C an..35 O
3036 Party name C an..35 O
3036 Party name C an..35 O
3045 Party name format code C an..3 O
C059 STREET C D
3042 Street and number or post office box identifier
M an..35 M Building Name/Number and Street
3042 Street and number or post office box identifier
C an..35 O Name and/or P.O. Box.
3042 Street and number or post office box identifier
C an..35 O
3042 Street and number or post office box identifier
C an..35 O
3164 City name C an..35 D City/Town name, clear text
C819 COUNTRY SUB-ENTITY DETAILS
C D
3229 Country sub-entity name code C an..9 O
1131 Code list identification code C an..17 O
3055 Code list responsible agency code
C an..3 O
3228 Country sub-entity name C an..70 O County/State, clear text.
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 14 - Edition 2012
Segment number: 6
EDIFACT GS1 * Description
3251 Postal identification code C an..17 D Postal Code
3207 Country name code C an..3 D ISO 3166 two alpha code
Segment Notes:
This segment is used to identify the parties who exchanged the message which is being acknowlegded. Example: NAD+BY+5412345000013::9' NAD+SU+4012345500004::9' Dependency Notes: The following composites and data elements are only used when a coded name and address can not be used. The affected composites and data elements are as follows: C080 - C059 - 3164 - C819 - 3251 - 3207
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 15 - Edition 2012
Segment number: 7
SG4 - C 99999 - ERC-FTX-SG5
ERC - M 1 - Application error information
Function:
A segment identifying the type of application error or acknowledgement within the referenced message. In case of an error, the error code may specify the error in detail (e.g. a measurement relating to a piece of equipment is wrong) or as a rough indication (e.g. a measurement is wrong).
EDIFACT GS1 * Description
C901 APPLICATION ERROR DETAIL
M M Should it not be possible to provide a user code in this data element and a free form characteristic description is used in data element 9321, then it is recommended that the code value 'ZZZ' be put in data element 1131.
9321 Application error code M an..8 M
1131 Code list identification code C an..17 O ZZZ = Mutually defined
3055 Code list responsible agency code
C an..3 D 91 = Assigned by supplier or supplier's agent 92 = Assigned by buyer or buyer's agent
Segment Notes:
This segment is used to identify the type of application error in the previously sent message. Example: ERC+NODAT::91' The receiver did not get any dates in the application.
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 16 - Edition 2012
Segment number: 8
SG4 - C 99999 - ERC-FTX-SG5
FTX - C 1 - Free text
Function:
A segment to provide explanation and/or supplementary information related to the specified application error or acknowledgement. For example, the explanation may provide exact details relating to a generic error code.
EDIFACT GS1 * Description
4451 Text subject code qualifier M an..3 M AAO = Error description (free text)
4453 Free text function code C an..3 O 1 = Text for subsequent use 3 = Text for immediate use
C107 TEXT REFERENCE C D This composite is only used when trading partners have agreed to use mutually defined code values.
4441 Free text value code M an..17 M
1131 Code list identification code C an..17 O
3055 Code list responsible agency code
C an..3 D 86 = Assigned by party originating the message
C108 TEXT LITERAL C D This composite is only used if coded text can not be used.
4440 Free text value M an..512 M
4440 Free text value C an..512 O
4440 Free text value C an..512 O
4440 Free text value C an..512 O
4440 Free text value C an..512 O
3453 Language name code C an..3 D This data element is only used when non coded free text has been provided in data element C108.
4447 Free text format code C an..3 N
Segment Notes:
This segment is used to provide free text information related to the application error. Example: FTX+AAO+1+001::ZZZ'
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 17 - Edition 2012
Segment number: 9
SG4 - C 99999 - ERC-FTX-SG5
SG5 - C 9 - RFF-FTX
RFF - M 1 - Reference
Function:
A segment to provide a reference relating to the acknowledgement type or the specified error (e.g. functional entity reference such as equipment level).
EDIFACT GS1 * Description
C506 REFERENCE M M
1153 Reference code qualifier M an..3 M AAN = Delivery schedule number AGG = Dispute number APQ = Commercial account summary
reference number IV = Invoice number ON = Order number (buyer)
1154 Reference identifier C an..70 R This number is the same number as in the BGM segment (DE 1004) of the message which is being acknowledged.
1156 Document line identifier C an..6 O This number is the same number as in the LIN segment (DE 1082) of the message which is being aknowledged.
4000 Reference version identifier C an..35 N
1060 Revision identifier C an..6 N
Segment Notes:
This segment is used to specify reference numbers related to the message which is being acknowledged. Example: RFF+ON:652744:23' The line being acknowlegded is line 23 of the order with number 652744.
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 18 - Edition 2012
Segment number: 10
SG4 - C 99999 - ERC-FTX-SG5
SG5 - C 9 - RFF-FTX
FTX - C 9 - Free text
Function:
A segment to provide additional details relating to the reference, e.g. the content of the wrong data (and its exact place in the message).
EDIFACT GS1 * Description
4451 Text subject code qualifier M an..3 M AAO = Error description (free text)
4453 Free text function code C an..3 N
C107 TEXT REFERENCE C N
4441 Free text value code M an..17
1131 Code list identification code C an..17
3055 Code list responsible agency code
C an..3
C108 TEXT LITERAL C R
4440 Free text value M an..512 M
4440 Free text value C an..512 O
4440 Free text value C an..512 O
4440 Free text value C an..512 O
4440 Free text value C an..512 O
3453 Language name code C an..3 N
4447 Free text format code C an..3 N
Segment Notes:
This segment is used to provide free text information related to the application error. Example: FTX+AAO+++THE IDENTIFICATION NUMBER IS WRONG'
EANCOM® 2002 S3 Part II APERAK Application error and acknowledgement message
5. Segments Layout
© Copyright GS1 - 19 - Edition 2012
Segment number: 11
UNT - M 1 - Message trailer
Function:
A service segment ending a message, giving the total number of segments in the message (including the UNH & UNT) and the control reference number of the message.
EDIFACT GS1 * Description
0074 Number of segments in the message
M n..6 M The total number of segments in the message is specified here.
0062 Message reference number M an..14 M The message reference numbered detailed here should equal the one specified in the UNH segment.
Segment Notes:
This segment is a mandatory UN/EDIFACT segment. It must always be the last segment in the message. Example: UNT+11+ME000001'
EANCOM® 2002 S3 Part II The Messages
APERAK Application error and acknowledgement message
6. Examples
© Copyright GS1 - 20 - Edition 2012
Example 1
The following is an example of an APERAK message being sent to acknowledge the order number 652. The ORDERS message was sent on the 25th of August. The parties who exchanged the ORDERS message are the buyer with GLN 5412345000013 and the supplier with GLN 4012345500004.
UNH+ME00001+APERAK:D:01B:UN:EAN003' Message header
BGM+305+10012+6' Application Error and Acknowledgement number is 10012.
DTM+137:2002808301200:203' The Application Error and Acknowledgement message was created at 12:00 on the 30th of August 2002.
RFF+ON:652' The message being acknowledged is order number 652.
DTM+171+20020825:102' The message being acknowledged was sent on the 25th of August 2002.
NAD+BY+5412345000013::9' Buyer identified in the ORDERS message.
NAD+SU+4012345500004::9' Supplier identified in the ORDERS message.
UNT+8+ME00001' Total number of segments in the message equals 8.
Example 2
The following is an example of an APERAK message being sent to report an error encountered in invoice number 2744. The INVOIC message was sent at 11:00 on the 23rd of August. The parties who exchanged the INVOIC message are the buyer with GLN 5412345000013 and the supplier with GLN 4012345500004.
UNH+MD00001+APERAK:D:01B:UN:EAN003' Message header
BGM+305+10015+27' Application Error and Acknowledgement number is 10015.
DTM+137:200208231200:203' The Application Error and Acknowledgement message was created at 12:00 on the 23rd of August 2002.
RFF+IV:2744' The message being acknowledged is invoice number 2744.
DTM+171+200208231100:203' The message being acknowledged was sent at 11:00 on the 23rd of August 2002.
NAD+BY+5412345000013::9' Buyer identified in the INVOIC message.
NAD+SU+4012345500004::9' Supplier identified in the INVOIC message.
ERC+186::92’ The buyer reports a duplicate invoice number using the bilaterally agreed code 186.
UNT+9+ME00001' Total number of segments in the message equals 9.
Note:
EANCOM® 2002 S3 Part II The Messages
APERAK Application error and acknowledgement message
6. Examples
© Copyright GS1 - 21 - Edition 2012
The EDI interchange will include the UNB..UNZ segments and, if applicable, the UNG..UNE segments. (See part 1 section 5.7).