D.20A APERAK
Application error and acknowledgement message
Version historyMessage definition
UNHMESSAGE HEADERM 1
1Mandatory A service segment starting and uniquely identifying a message. The message type code for the Application error and acknowledgement message is APERAK.
0062
MESSAGE REFERENCE NUMBER
Mandatoryan0..14
Unique message reference assigned by the sender.
S009
MESSAGE IDENTIFIER
Mandatory
Identification of the type, version, etc. of the message being interchanged.
0065
Message type
Mandatoryan0..6
Code identifying a type of message and assigned by its controlling agency.
Show codelist0054
Message release number
Mandatoryan0..3
Release number within the current message version number.
Show codelist0057
Association assigned code
Conditionalan0..6
Code, assigned by the association responsible for the design and maintenance of the message type concerned, which further identifies the message.
0110
Code list directory version number
Conditionalan0..6
Version number of the code list directory.
0113
Message type sub-function identification
Conditionalan0..6
Code identifying a sub-function of a message type.
Show codelist0068
COMMON ACCESS REFERENCE
Conditionalan0..35
Reference serving as a key to relate all subsequent transfers of data to the same business case or file.
S010
STATUS OF THE TRANSFER
Conditional
Statement that the message is one in a sequence of transfers relating to the same topic.
0070
Sequence of transfers
Mandatoryn0..2
Number assigned by the sender indicating the transfer sequence of a message related to the same topic. The message could be an addition or a change to an earlier transfer related to the same topic.
0073
First and last transfer
Conditionala1
Indication used for the first and last message in a sequence of messages related to the same topic.
Show codelistS016
MESSAGE SUBSET IDENTIFICATION
Conditional
Identification of a message subset by its identifier, version, release and source.
0115
Message subset identification
Mandatoryan0..14
Coded identification of a message subset, assigned by its controlling agency.
0116
Message subset version number
Conditionalan0..3
Version number of the message subset.
0118
Message subset release number
Conditionalan0..3
Release number within the message subset version number.
S017
MESSAGE IMPLEMENTATION GUIDELINE IDENTIFICATION
Conditional
Identification of a message implementation guideline by its identifier, version, release and source.
0121
Message implementation guideline identification
Mandatoryan0..14
Coded identification of the message implementation guideline, assigned by its controlling agency.
0122
Message implementation guideline version number
Conditionalan0..3
Version number of the message implementation guideline.
0124
Message implementation guideline release number
Conditionalan0..3
Release number within the message implementation guideline version number.
S018
SCENARIO IDENTIFICATION
Conditional
Identification of a scenario.
0127
Scenario identification
Mandatoryan0..14
Code identifying scenario.
0128
Scenario version number
Conditionalan0..3
Version number of a scenario.
0130
Scenario release number
Conditionalan0..3
Release number within the scenario version number.
BGMBEGINNING OF MESSAGEM 1
1Mandatory A segment to indicate the type and function of the message and to transmit the identifying number.
C002
DOCUMENT/MESSAGE NAME
Conditional
Identification of a type of document/message by code or name. Code preferred.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist1000
Document name
Conditionalan0..35
Name of a document.
C106
DOCUMENT/MESSAGE IDENTIFICATION
Conditional
Identification of a document/message by its number and eventually its version or revision.
1004
Document identifier
Conditionalan0..70
To identify a document.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
4343
RESPONSE TYPE CODE
Conditionalan0..3
Code specifying the type of acknowledgment required or transmitted.
Show codelist3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
DTMDATE/TIME/PERIODC 9
9Conditional A segment to specify related date/time.
C507
DATE/TIME/PERIOD
Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date or time or period function code qualifier
Mandatoryan0..3
Code qualifying the function of a date, time or period.
Show codelist2380
Date or time or period text
Conditionalan0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date or time or period format code
Conditionalan0..3
Code specifying the representation of a date, time or period.
Show codelist
FTXFREE TEXTC 9
9Conditional A segment to specify free form or processable supplementary information related to the whole message. In computer-to-computer exchanges free form text will normally require the receiver to process this segment manually.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
CNTCONTROL TOTALC 9
9Conditional A segment to provide message control totals.
C270
CONTROL
Mandatory
Control total for checking integrity of a message or part of a message.
6069
Control total type code qualifier
Mandatoryan0..3
Code qualifying the type of control of hash total.
Show codelist6066
Control total quantity
Mandatoryn0..18
To specify the value of a control quantity.
6411
Measurement unit code
Conditionalan0..8
Code specifying the unit of measurement.
GRP1 DOC DTMC 99
99Conditional A segment group to provide information on the document being acknowledged.
DOCDOCUMENT/MESSAGE DETAILSM 1
1Mandatory A segment to provide the necessary identification information about the document being acknowledged.
C002
DOCUMENT/MESSAGE NAME
Mandatory
Identification of a type of document/message by code or name. Code preferred.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist1000
Document name
Conditionalan0..35
Name of a document.
C503
DOCUMENT/MESSAGE DETAILS
Conditional
Identification of document/message by number, status, source and/or language.
1004
Document identifier
Conditionalan0..70
To identify a document.
1366
Document source description
Conditionalan0..70
Free form description of the source of a document.
3453
Language name code
Conditionalan0..3
Code specifying the language name.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
3153
COMMUNICATION MEDIUM TYPE CODE
Conditionalan0..3
Code specifying the type of communication medium.
Show codelist1220
DOCUMENT COPIES REQUIRED QUANTITY
Conditionaln0..2
Quantity of document copies required.
1218
DOCUMENT ORIGINALS REQUIRED QUANTITY
Conditionaln0..2
Quantity of document originals required.
DTMDATE/TIME/PERIODC 99
99Conditional A segment to provide the relevant dates concerning the document being acknowledged.
C507
DATE/TIME/PERIOD
Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date or time or period function code qualifier
Mandatoryan0..3
Code qualifying the function of a date, time or period.
Show codelist2380
Date or time or period text
Conditionalan0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date or time or period format code
Conditionalan0..3
Code specifying the representation of a date, time or period.
Show codelist
GRP2 RFF DTMC 9
9Conditional A group of segments to specify the document/message to which the current message relates, and related date and time.
RFFREFERENCEM 1
1Mandatory A segment to indicate the reference number of the document/message.
C506
REFERENCE
Mandatory
Identification of a reference.
1154
Reference identifier
Conditionalan0..70
Identifies a reference.
1156
Document line identifier
Conditionalan0..6
To identify a line of a document.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
DTMDATE/TIME/PERIODC 9
9Conditional A segment to specify the date and time of the referenced document/message.
C507
DATE/TIME/PERIOD
Mandatory
Date and/or time, or period relevant to the specified date/time/period type.
2005
Date or time or period function code qualifier
Mandatoryan0..3
Code qualifying the function of a date, time or period.
Show codelist2380
Date or time or period text
Conditionalan0..35
The value of a date, a date and time, a time or of a period in a specified representation.
2379
Date or time or period format code
Conditionalan0..3
Code specifying the representation of a date, time or period.
Show codelist
GRP3 NAD CTA COMC 9
9Conditional A group of segments to specify the identifications of message sender and message receiver with their contacts and communication channels.
NADNAME AND ADDRESSM 1
1Mandatory A segment to specify the identification of the message issuer and message receiver.
3035
PARTY FUNCTION CODE QUALIFIER
Mandatoryan0..3
Code giving specific meaning to a party.
Show codelistC082
PARTY IDENTIFICATION DETAILS
Conditional
Identification of a transaction party by code.
3039
Party identifier
Mandatoryan0..35
Code specifying the identity of a party.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC058
NAME AND ADDRESS
Conditional
Unstructured name and address: one to five lines.
3124
Name and address description
Mandatoryan0..35
Free form description of a name and address line.
3124
Name and address description
Conditionalan0..35
Free form description of a name and address line.
3124
Name and address description
Conditionalan0..35
Free form description of a name and address line.
3124
Name and address description
Conditionalan0..35
Free form description of a name and address line.
3124
Name and address description
Conditionalan0..35
Free form description of a name and address line.
C080
PARTY NAME
Conditional
Identification of a transaction party by name, one to five lines. Party name may be formatted.
3036
Party name
Mandatoryan0..70
Name of a party.
3036
Party name
Conditionalan0..70
Name of a party.
3036
Party name
Conditionalan0..70
Name of a party.
3036
Party name
Conditionalan0..70
Name of a party.
3036
Party name
Conditionalan0..70
Name of a party.
3045
Party name format code
Conditionalan0..3
Code specifying the representation of a party name.
Show codelistC059
STREET
Conditional
Street address and/or PO Box number in a structured address: one to four lines.
3042
Street and number or post office box identifier
Mandatoryan0..256
To identify a street and number and/or Post Office box number.
3042
Street and number or post office box identifier
Conditionalan0..256
To identify a street and number and/or Post Office box number.
3042
Street and number or post office box identifier
Conditionalan0..256
To identify a street and number and/or Post Office box number.
3042
Street and number or post office box identifier
Conditionalan0..256
To identify a street and number and/or Post Office box number.
3164
CITY NAME
Conditionalan0..35
Name of a city.
C819
COUNTRY SUBDIVISION DETAILS
Conditional
To specify a country subdivision, such as state, canton, county, prefecture.
3229
Country subdivision identifier
Conditionalan0..9
To identify a country subdivision, such as state, canton, county, prefecture.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist3228
Country subdivision name
Conditionalan0..70
Name of a country subdivision, such as state, canton, county, prefecture.
3251
POSTAL IDENTIFICATION CODE
Conditionalan0..17
Code specifying the postal zone or address.
3207
COUNTRY IDENTIFIER
Conditionalan0..3
Identification of the name of the country or other geographical entity as defined in ISO 3166-1 and UN/ECE Recommendation 3.
CTACONTACT INFORMATIONC 9
9Conditional A segment to specify a person or department inside the party's organization, to which communication should be directed.
3139
CONTACT FUNCTION CODE
Conditionalan0..3
Code specifying the function of a contact (e.g. department or person).
Show codelistC056
CONTACT DETAILS
Conditional
Code and/or name of a contact such as a department or employee. Code preferred.
3413
Contact identifier
Conditionalan0..17
To identify a contact, such as a department or employee.
3412
Contact name
Conditionalan0..256
Name of a contact, such as a department or employee.
COMCOMMUNICATION CONTACTC 9
9Conditional A segment to indicate communication channel type and number inside the party's organization, to which communication should be directed.
C076
COMMUNICATION CONTACT
Mandatory
Communication number of a department or employee in a specified channel.
3148
Communication address identifier
Mandatoryan0..512
To identify a communication address.
3155
Communication means type code
Mandatoryan0..3
Code specifying the type of communication address.
Show codelist
GRP4 ERC FTX GRP5C 99999
99999Conditional 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.
ERCAPPLICATION ERROR INFORMATIONM 1
1Mandatory 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).
C901
APPLICATION ERROR DETAIL
Mandatory
Code assigned by the recipient of a message to indicate a data validation error condition.
9321
Application error code
Mandatoryan0..8
Code specifying an application error.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelist
FTXFREE TEXTC 1
1Conditional 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.
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
GRP5 RFF FTXC 9
9Conditional 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.
RFFREFERENCEM 1
1Mandatory A segment to provide a reference relating to the acknowledgement type or the specified error (e.g. functional entity reference such as equipment level).
C506
REFERENCE
Mandatory
Identification of a reference.
1154
Reference identifier
Conditionalan0..70
Identifies a reference.
1156
Document line identifier
Conditionalan0..6
To identify a line of a document.
1056
Version identifier
Conditionalan0..9
To identify a version.
1060
Revision identifier
Conditionalan0..6
To identify a revision.
FTXFREE TEXTC 9
9Conditional 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).
C107
TEXT REFERENCE
Conditional
Coded reference to a standard text and its source.
4441
Free text description code
Mandatoryan0..17
Code specifying free form text.
1131
Code list identification code
Conditionalan0..17
Code identifying a user or association maintained code list.
3055
Code list responsible agency code
Conditionalan0..3
Code specifying the agency responsible for a code list.
Show codelistC108
TEXT LITERAL
Conditional
Free text; one to five lines.
4440
Free text
Mandatoryan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
4440
Free text
Conditionalan0..512
Free form text.
3453
LANGUAGE NAME CODE
Conditionalan0..3
Code specifying the language name.
UNTMESSAGE TRAILERM 1
1Mandatory 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.
0074
NUMBER OF SEGMENTS IN A MESSAGE
Mandatoryn0..10
The number of segments in a message body, plus the message header segment and message trailer segment.
0062
MESSAGE REFERENCE NUMBER
Mandatoryan0..14
Unique message reference assigned by the sender.