Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,

Application advice canonical guidelines

The Application Advice transaction provides structured, actionable feedback about the outcome of business-level validation for previously received EDI transactions such as invoices, purchase orders, shipment notifications, and sales reports. It is a key tool in ensuring clarity, accountability, and alignment between trading partners.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
Canonical Element - JSon object type/root element. - - -
  controlFileHeader - Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages. - - -
  canonicalApplicationAdviceHeader - Header details for the canonical Application Advice message. - BGN -
    processingFunctionTypeCode string

Processing function, transaction set purpose code. Required for X12, optional for Idoc and EDIFACT.

Valid values include RESPONSE.

 - BGN01 = 11 (RESPONSE) BGM030 = 11 (RESPONSE)
    acknowledgementCode string

Application acknowledgment code. Identifies processing status of the original transaction in the system that sent.

Valid values include:

  • ACCEPTED - Transaction set accepted

  • ACCEPTEDWITHERRORS - Transaction set accepted with errors

  • REJECTED - Transaction set rejected

 - -

BGM040 =

  • ACCEPTED (AP) Or

  • REJECTED (RE)
    transactionReferenceIdentifierList (1) - Unique transaction identifier and its date. - segment BGN segment BGM
      b2bTransactionIdentifierType string

Referenced document type.

Valid value APPLICATIONADVICE (required).

 - - Set BGM010-010 to 305 (Application Advice) where b2bTransactionIdentifierType = APPLICATIONADVICE
      b2bTransactionIdentifierValue string Transaction identifier for application advice. - BGN02 (Mandatory) where b2bTransactionIdentifierType = APPLICATIONADVICE BGM020-010 where b2bTransactionIdentifierType = APPLICATIONADVICE
      transactionDate string Date transaction created. - BGN03(Mandatory) + BGN04 (If exists) DTM020 when DTM010-010 = 137
      epochTransactionDate integer Date transaction created in epoch integer date format. - - -
      lineItemNumber string Line item number in customer purchase order. Line item level only. - - -
    transactionReferenceIdentifierList (2) array Place holder to provide the necessary identification information about the document being acknowledged. Practically application advice can be sent for any business transaction. - - segment group DOC loop
      b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • SHIPPINGINSTRUCTION - Shipping instruction

  • CREDITMEMO - Credit memo

  • DEBITMEMO - Debit memo

  • PAYMENT - Payment advice

 - -

DOC010-010 =

  • 304 (SHIPPINGINSTRUCTION) or

  • 381 (CREDITMEMO) or

  • 383 (DEBITMEMO) or

  • 450 (PAYMENT)
      b2bTransactionIdentifierValue string Transaction identifier of original transaction. - - DOC020-010
      transactionDate string Original transaction date. - - DOC/DTM02 where DTM010 = 137 (Doc issue date)
      epochTransactionDate integer Date transaction created in epoch integer date format. - - -
      lineItemNumber string Line item number. Used in Line item level only. - - -
    transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF, L11 and N9 and EDIFACT RFF for information other than transaction documents. - - RFF Loop
      transactionReferenceType string

Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

  • ORIGINALMESSAGEREFERENCE - Message Reference Number (CL 0062, UNH010) to previous message

  • PREVIOUSMESSAGEREFERENCE - Document identifier (CL 1004, BGM020-010) to previous message

 - - RFF010-010
      transactionReferenceIdentifier string Transaction reference identifier value. - - RFF010-020
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - - -
      transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
      mpcDates array Dates relevant for referenced document. - - RFF Loop/ DTM Loop
        dateType string

Date type at header level for Application Advices in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values DOCUMENT - Document date.

 - - DTM010-010 = 137 (DOCUMENT)
        dateValue string Date defined by referenced date type in date format YYYY-MM-DD. - - DTM010-020
        epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
        dateTimePeriodFormat string

Code specifying representation of date or time or format presented in date value, Valid values include:

  • CCYYMMDD - Date format century year month day, 2 characters each

  • CCYYMMDDHHMM - Date format century year month day hour minutes, 2 characters each

 - - DTM010-030
        timeZone string Time zone for referenced dates. - - -
    mpcDates array Dates relevant for Application Advices at header. - - DTM
      dateType string

Date type at header level for Application Advices in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values DOCUMENT - Document date

 - - DTM010-010 = 137 (DOCUMENT)
      dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. - - DTM010-020
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
      dateTimePeriodFormat string

Code specifying representation of date or time or format presented in date value,

Valid values include:

  • CCYYMMDD - Date format century year month day, 2 characters each

  • CCYYMMDDHHMM - Date format century year month day hour minutes, 2 characters each

 - - DTM010-030
      timeZone string Time zone for referenced dates. - - -
    partnerBusinessInformation array Party company identifiers and address information. - N1 Loop NAD Loop
      businessPartyInformation - Business Parties identifiers and address information. - N1 -
        partnerEntityType string

Denotes type of the entity involved in this business transaction.

valid values include:

  • SENDER - Message sender

  • RECEIVER - Message receiver

 - N101 NAD01
        businessName string Business name for partner or location. - N102 NAD040-010
        additionalBusinessName string Additional Business name for partner or location. - N201 -
        companyLocationPartnerName string Additional Location of same Business partner. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Company identifier type for business partner. - N103

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92
          companyIdentifierValue string Company identifier value for business partner. - N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
        address - Party address information. - N3, N4,  
          address1 string Main street address. - N301 NAD050-010
          address2 string Supplemental street address. - N302 NAD050-020
          city string City - N401 NAD060
          district string District -    
          state string State or region code - N402 NAD070-010
          postalCode string Postal code - N403 NAD080
          country string Country code - N404 NAD090
          telephone string Telephone number - - -
          fax string Fax number - - -
          url string Website URL - - -
          buildingNumber string Building number - - -
          plantNumber string Plant number - - -
          floorNumber string Floor number in building - - -
          lscAddressIdentifier string LSC address identifier - - -
          village string Village name - - -
          houseNumber string House number - - -
          township string Township - - -
          premisesCode string Premises code - - -
        companyLocationContactInformation - - - N1-PER CTA
          contactType string

Contact type.

Valid values include:

  • INFORMATION - Information contact

  • PRIMARY - Primary contact

  • RESPONSIBLE - Responsible person

 - PER01 = IC (INFORMATION) CTA010 = IC (INFORMATION)
          contactName string Contact name. - PER02 CTA020-020
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
          contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          orderType string Order Type. - - -
          address3 string Additional address information that is not included in addressTypeDefinition. - N202 -
          address4 string Additional address information that is not included in addressTypeDefinition. - - -
          postalArea string Postal Area. - - -
          timeZone string Time zone for referenced dates. - - -
          telephone string Telephone Number. - - -
          emailAddress string Email Address. - - -
          vatRegistrationNumber string Vat Registration Number. - - -
          taxExemptCode string Tax exempt Code. - - -
          locationType string Business Partner Location Type. - N405 -
          locationIdentifier string Business Partner location Identifier. - N406 -
          countrySubDivisionCode string Describes the country subdivision. - N407 -
      transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. - loop REF -
        transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include INTERNALVENDORNUMBER - Internal vendor number

 - REF01 = IA (INTERNALVENDORNUMBER) -
        transactionReferenceIdentifier string Transaction reference identifier value. - REF02 -
        description string

Identifier or description defined by qualifier code in transactionReferenceIdentifier.

HAD usage description: This element can contain any optional notes or comments pertaining to an original or resubmitted line on a chargeback.

 - REF03 -
        transactionReferenceDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
        epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    freeTextNote array Free form instructions ( Some of EDIFACT customers using free text for sending error information as well.) - - FTX
      textReferenceCode string Text reference or subject code. - - FTX01
      textFunctionCode string Text function code. - - FTX02
      language string Language of free text. - - FTX05
      textFormatCode string Format code for free text. - - FTX06
      freeFormText string Free test string. - - FTX04
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalApplicationAdviceItemDetails array Line item details for canonical Application Advice message. - OTI Loop (Mandatory) ERC Loop
    lineItemNumber string Transaction set line number. - - -
    acknowledgementCode string

Application acknowledgment code. Identifies processing status of the original transaction in the system that sent the 824.

Valid values include:

  • TA - Transaction set accepted

  • TE - Transaction set accepted with errors

  • TR - Transaction set rejected

 - OTI01 -
    b2bTransactionIdentifierType string Transaction reference number qualifier. Valid value TN - Transaction Reference Number. - OTI02 -
    b2bTransactionIdentifierValue string Reference Identification defined for a particular Transaction Set. Identifies the transaction within the business application, such as the document number. For example If reporting errors on an 856, this should reference the ASN ship notification document number. - OTI03 -
    groupSenderNumber string Application Sender's Code. Identifies the sender (GS02 sender) of the original transaction that the 824 is reporting on. - OTI04 -
    groupReceiverNumber string Application Receiver's Code. Identifies the sender (GS03 receiver) of the original transaction that the 824 is reporting on. - OTI05 -
    dateValue string Transaction date in format YYYY-MM-DDTHH:MM:SS from the GS04 & GS05 date and time field in the original transaction that the 824 is reporting on. - OTI06 & OTI07 -
    groupControlNumber string Group Control Number from the GS06 field of the original transaction that the 824 is reporting on. - OTI08 -
    transactionSetControlNumber string Transaction Set Control Number from the ST02 field of the original transaction that the 824 is reporting on. - OTI09 -
    transactionCode string X12 transaction set code from the ST02 field of the original transaction that the 824 is reporting on. For example valid value for the ASN: 856. - OTI10 -
    transactionReferenceIdentifierList array List of documents and transactions referencing at the item level of the message. - REF -
      b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • SHIPPINGINSTRUCTION - Shipping instruction

  • CREDITMEMO - Credit memo

  • DEBITMEMO - Debit memo

  • PAYMENT - Payment advice

 -

REF01 =

  • BM (BOL) Or

  • PO (PURCHASEORDER) Or

  • VN (SUPPLIERORDER) Or

  • MB (MASTERBOL)

-
      b2bTransactionIdentifierValue string Transaction reference identifier value. - REF02 -
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - REF04 & 05 -
      epochTransactionDate string Transaction reference date and time, if time available, in epoch date format. - - -
      lineItemNumber integer Transaction reference date and time in EPOCH date time format. - - -
    transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF, L11 and N9 and EDIFACT RFF for information other than transaction documents. - REF -
      transactionReferenceType string

Transaction reference type for X12 segments REF, L11 and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include BOOKINGIDENTIFIER - Booking confirmation number .

 - REF01 -
      transactionReferenceIdentifier string Transaction reference identifier value. - REF02 -
      description string Identifier or description. - REF03 -
      transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - REF04 & 05 -
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    mpcDates array Dates relevant to transaction set to uniquely identify origin transaction / reference transaction set that this Application advice (824) is generating. - DTM -
      dateType string

Date type related to application advice in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

Valid values include DOCUMENT - Document date.

 - DTM01 -
      dateValue string Date defined by referenced date type in date format YYYY-MM-DDTHH-MM-SSZ. - DTM02 & DTM03 -
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
      timeZone string Time zone for referenced dates. - DTM04 -
    referenceTransactionAmount array Original transaction amount for which 824 is being generated Notes: which will be used to uniquely identify original transaction in sender system. - OTI-AMT -
      amountType string

Amount type for application advice item.

Valid values include TOTAL - Total transaction amount.

 - AMT01 -
      pricingAmount string Net or extended price claimed for return including total disbursements, plus interest and minus deductions from claim. - AMT02 -
      isCreditOrDebit boolean

Credit or debit boolean. Only populated if identified.

Valid values:

  • True - Credit

  • False - Debit

Not populated (default)

- AMT03 -
    referenceTransactionQuantity array Original transaction quantity for which 824 is being generated Notes: which will be used to uniquely identify original transaction in sender system. - OTI-QTY -
      quantityType string

Type of quantity recorded.

Valid values include TOTAL -Total Quantity.

 - QTY01 = TO (TOTAL) -
      quantityValue number Quantity of product required for planning. - QTY02 -
      unitOfMeasure string Unit or Basis for Measurement Code. Unit of entry UOM's include UN - Unit. - QTY03 -
    technicalErrorDetails array Technical Error Description looping segment. Identifies the error in the original transaction being reported on. Child of ErrorReport loop. - TED ERC Loop
      applicationErrorCode string Application error condition code describing the error condition in the original transaction. - TED01 ERC010-010 (Shoud be pass through)
      description string Free-form Message. Short description of the error for the error code in ApplicationErrorCode, and in conjunction with the long description listed in Comments. - TED02 -
      segmentIdentifier string Segment ID Code. Identifies segment in orginal transation that triggered an error. - TED03 -
      segmentPosition string Segment Position in Transaction Set. The numerical count position of this data segment from the start of the transaction set: the transaction set header is count position 1. - TED04 -
      elementPosition string

Position in Segment. Code indicating the relative position of the error data element within a segment, count beginning with 1 for position immediately after the segment ID. Also indicates:

1. Relative position of a repeating structure in error, beginning with 1 for the position immediately after the preceding element separator.

2. Relative position of a component of a composite data structure in error, count beginning with 1 for the position following the preceding element or repetition separator.

 - TED05-01 -
      componentPosition string Component position. - TED05-02 -
      loopIdentifier string Loop identifier. - TED05-03 -
      badDataElement string Copy of the bad data element. Data from the data element that is in error. - TED07 -
      freeTextNote array Free text notes or special instructions. - NTE ERC Loop/ FTX
        textReferenceCode string Text reference or subject code. -   FTX01
        textFunctionCode string Text function code. - NTE01 FTX02
        language string Language of free text. - - FTX05
        textFormatCode string Format code for free text. - - FTX06
        freeFormText string Free test string. - NTE02 (Mandatory) FTX04
      referenceBusinessData array Contains the business data value and classification associated with a validation result or application acknowledgment. This structure identifies the specific field or transaction data element from the originating document that is being referenced due to an error or advisory condition. Used to correlate the application advice message back to the source business content. - RED -
        referenceDataValue string Represents the actual business value or descriptive information, being referenced or cited in connection with a validation message or application result. This value indicates which specific field or transaction content is associated with the reported condition. - RED01 -
        referenceDataTypeCode string Identifies the nature or classification of the business data referenced due to a validation or application edit result. The value corresponds to standardized codes (e.g., PO Number, Unit Price, GTIN, Quantity). Only one code is allowed and at least one must be present when reporting referenced business data. - RED02 -
        agencyCode string Identifies the agency maintaining the code list identified. - RED03 -
        codeListQualifier string Identifies code list used for the value in industryCode. - RED05 -
        industryCode string Code for industry relevant to the specific type of application data mentioned in refrecence data value. - RED06 -
      transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. - - -
        transactionReferenceType string Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. - - -
        transactionReferenceIdentifier string Transaction reference identifier value. - - -
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - - -
        transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
        epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    freeTextNote array Place holder to provide free text information, however in EDIFACT it is being used to send line level supplementary error information, like generic error code and error description. - - -
      textReferenceCode string Text reference or subject code. - - -
      textFunctionCode string Text function code. - - -
      language string Language of free text. - - -
      textFormatCode string Format code for free text. - - -
      freeFormText string Free test string. - - -
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  freeTextNote array Free text, instructions, notes, descriptions and other free text elements. - - -
    textReferenceCode string Text reference or subject code. - - -
    textFunctionCode string Text function code. - - -
    language string Language of free text. - - -
    textFormatCode string Format code for free text. - - -
    freeFormText string Free test string. - - -
  customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level. - - -
    name string Name of mapped field. - - -
    value string Value in named field. - - -

Tag end