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,

Price sales catalog canonical guidelines

Price catalogs allow suppliers to exchange data with buyers about their product prices, discounts, promotions, and terms of sale on their current product offerings. Communicating about product pricing helps suppliers ensure their buyers are kept up to date on changes in pricing as well as any promotions or discounts the supplier is offering.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
data - 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. - - -
  messageBody - Payload for canonical forecast plan response message - - -
    canonicalPriceSalesCatalogHeader - - Segment E1PRPRO - -
      processingFunctionTypeCode string

Processing function, transaction set purpose code.

Valid values include:

  • CREATE
  • CHANGE
  • CANCEL
  • ORIGINAL
  • REPLACE
  • INFORMATION
-

BCT10

  • 00 - ORIGINAL
  • 02 - CREATE (Add)
  • 04 - CHANGE
  • 05 - REPLACE

BGM030

  • ORIGINAL - 9
  • CHANGE - 4
  • CREATE - 2 (Addition)
  • REPLACE - 5
  • CANCEL - 1
  • INFORMATION - 14 (Advance Notification)
      messageTypeIdentifierCode string Code identifying purpose of EDI message -

BCT01

 BGM010-010
      requirementsProfile string Price catalog requirements profile. PROFIL - -
      plantIdentifier string Plant identifier for material data determination. WERKS - -
      salesDocumentType string Sales document type. AUART - -
      vatConditionType string Determines which condition type is used for VAT tax. MWST_KZ - -
      vatTaxDeterminationType1 string VAT tax determination type 1. Population determined by value in vat Condition Type above. STEUER_1 - -
      vatTaxDeterminationType2 string VAT tax determination type 2. Population determined by value in vatConditionType above. STEUER_2 - -
      vatTaxDeterminationType3 string VAT tax determination type 3. Population determined by value in vatConditionType above. STEUER_3 - -
      grossPriceDeterminationConditionType string Condition type used for gross price determination BRUTTO_KA - -
      netPriceDeterminationConditionType string Condition type used for net price determination NETTO_KA - -
      retailPriceDeterminationConditionType string Condition type used for retail price determination VKP_KA - -
      catalogDescription string Descriptive information of catalog to display - - -
      priceSalesCatalogType string

Type of catalog.

Valid values:

  • PRICINGDATA

  • MASTERDATA

  • PRODUCTSHORTFORM

  • WEE

- - -
      transactionReferenceIdentifierList array Transaction references for inventory adjustment at header level that affects the entire message. Segment E1EDK02 - -
        b2bTransactionIdentifierType string

Referenced document type. Valid values:

  • PRICESALESCATALOG (required from all formats IB)

  • VERSION

  • CONTRACT

b2bTransactionIdentifierType = "PRICESALESCATALOG" b2bTransactionIdentifierType = "PRICESALESCATALOG" and "VERSION" and "CONTRACT" REF01 = "CT" (CONTRACT) b2bTransactionIdentifierType = "PRICESALESCATALOG" and "VERSION" and "CONTRACT" RFF010-010 = "CT"
        b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. BELNR where b2bTransactionIdentifierType = "PRICESALESCATALOG" required value BCT02 wheretransactionReferenceIdentifierType = "PRICESALESCATALOG" Required: Define custom error message if not present. BCT03 where if transactionReferenceIdentifierType = "VERSION" REF02 where REF01 = "CT" BGM020 wheretransactionReferenceIdentifierType = "PRICESALESCATALOG" Required: Define custom error message if not present. BGM020-020 wheretransactionReferenceIdentifierType = "VERSION" RFF010-020 where RFF010-010 ="CT"
        transactionDate string Date transaction created DATUM - -
        epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. - - -
        lineItemNumber string Line item number in customer purchase order. 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 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.

The valid values include: - FUNCTIONALCATEGORY - Functional category

 - REF01 = 87 (FUNCTIONALCATEGORY) -
        transactionReferenceIdentifier string Transaction reference identifier value. - REF02 -
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - 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. - - -
      mpcDates array Dates relevant for inventory adjustment header. - - Example: DTM+137:20061229:102'
        dateType string

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

Valid values:

  • EFFECTIVE

  • PROCESSING

  • AVAILABILITY

  • EXPIRATION

  • TRANSACTION

  • DOCUMENT

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

-

DTM01 =

  • 007 (EFFECTIVE) or

  • 009 (PROCESSING) or

  • 018 (AVAILABILITY) or

  • 036 (EXPIRATION) or

  • 097 (TRANSACTION) or

  • 999 (DOCUMENT) or

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION)

DTM010-010 =

  • 7 (EFFECTIVE) or

  • 9 (PROCESSING) or

  • 36 (EXPIRATION) or

  • 44 (AVAILABILITY) or

  • 97 (TRANSACTION) or

  • 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. -

DTM02 where DTM01 =

  • 007 or

  • 009 or

  • 018 or

  • 036 or

  • 097 or

  • 999

DTM010-020 where DTM010-010 =

  • 7 or

  • 9 or

  • 36 or

  • 44 or

  • 97 or

  • 137
        epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
        timeZone string Time zone for referenced dates. - - -
      mpCurrency array Currency. Segment E1EDK23 Example:CUR*SE*USD Example: CUX+2:EUR:4
        currencyCode string Currency Code. WAERZ CUR02 CUX010-020
        exchangeRateCurrencyCode string Exchange Rate Currency Code. - - -
        exchangeRate string Exchange Rate. - - -
        validityRate string Validity Date. - - -
        currencyEntityCode string Currency Entity Code. - - -
      customerBusinessInformation - Customer party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "AG" N101 = "BY" NAD010 = "BY"
        businessName string Business name for partner or location. NAME1 N102 NAD040-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Company identifier type for business partner. PARTNER_Q

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID -91

  • COMPANYSITEID - 92
          companyIdentifierValue string Company identifier val. PARTNER_ID companyIdentifierType = "GLN" map companyIdentifierValue to E1ADRE1/EXTEND_D N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
        address - Party address information - - -
          address1 string Main street address STREET1 N301 NAD050-010
          address2 string Supplemental street address STREET2 N302 NAD050-020
          city string City CITY1 N401 NAD060
          district string District - - -
          state string State or region code REGION N402 NAD070-010
          postalCode string Postal code POSTL_COD1 N403 NAD080
          country string Country code COUNTRY1 N404 NAD090
          telephone string Telephone number TELEPHONE1 - -
          fax string Fax number TELEFAX - -
          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 - - - - -
          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"
      supplierBusinessInformation - Supplier party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "LF" N101 = "SU" NAD01 = "SU"
        businessName string Business name for partner or location NAME1 N102 NAD040-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean - - -
          companyIdentifierType string Company identifier type for business partner PARTNER_Q

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID -91

  • COMPANYSITEID - 92
          companyIdentifierValue string Company identifier value for business partner PARTNER_ID companyIdentifierType = "GLN" map companyIdentifierValue to E1ADRE1/EXTEND_D Required value N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
        address - Party address information - - -
          address1 string Main street address STREET1 N301 NAD050-010
          address2 string Supplemental street address STREET2 N302 NAD050-020
          city string City CITY1 N401 NAD060
          district string District - - -
          state string State or region code REGION N402 NAD070-010
          postalCode string Postal code POSTL_COD1 N403 NAD080
          country string Country code COUNTRY1 N404 NAD090
          telephone string Telephone number TELEPHONE1 - -
          fax string Fax number TELEFAX - -
          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 - - - - -
          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"
      shipFromLocationInformation - Supplier party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "OSP" N101 = "SF" NAD01 = "SF"
        businessName string Business name for partner or location NAME1 N102 NAD040-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean - - -
          companyIdentifierType string Company identifier type for business partner PARTNER_Q hard code "OSP"

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID -91

  • COMPANYSITEID - 92
          companyIdentifierValue string Company identifier value for business partner PARTNER_ID N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
        address - Party address information - - -
          address1 string Main street address STREET1 N301 NAD050-010
          address2 string Supplemental street address STREET2 N302 NAD050-020
          city string City CITY1 N401 NAD060
          district string District - - -
          state string State or region code REGION N402 NAD070-010
          postalCode string Postal code POSTL_COD1 N403 NAD080
          country string Country code COUNTRY1 N404 NAD090
          telephone string Telephone number TELEPHONE1 - -
          fax string Fax number TELEFAX - -
          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 - - - - -
          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"
      manufacturerBusinessInformation - Supplier party company identifiers and address information. Segment E1ADRM1 where PARTNER_Q = "MF" N101 = "MF" NAD01 = "MF"
        businessName string Business name for partner or location NAME1 N102 NAD040-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean - - -
          companyIdentifierType string Company identifier type for business partner PARTNER_Q hard code "MF"

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

NAD020-030 EDIFACT supported codes:

  • DUNS - 16

  • DEA - 164

  • HIN - 21

  • COMPANYID -91

  • COMPANYSITEID - 92
          companyIdentifierValue string Company identifier value for business partner PARTNER_ID N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
        address - Party address information - - -
          address1 string Main street address STREET1 N301 NAD050-010
          address2 string Supplemental street address STREET2 N302 NAD050-020
          city string City CITY1 N401 NAD060
          district string District      
          state string State or region code REGION N402 NAD070-010
          postalCode string Postal code POSTL_COD1 N403 NAD080
          country string Country code COUNTRY1 N404 NAD090
          telephone string Telephone number TELEPHONE1 - -
          fax string Fax number TELEFAX - -
          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 - - - - -
          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"
      distributorBusinessInformation - Supplier party company identifiers and address information. - N101 = "DS" NAD01 = "DS"
        businessName string Business name for partner or location - N102 NAD040-010
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean - - -
          companyIdentifierType string Company identifier type for business partner -

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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 - - -
          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 - - - - -
          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"
      sellerBusinessInformation - Seller party company identifiers and address information. - N101 = "SE" NAD01 = "DS"
        businessName string Business name for partner or location - N102 NAD040-010
        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 - - -
          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 - - - - -
          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"
      systemBusinessInformation - System business identifiers and address information. - N101 = "UK" NAD01 = "DS"
        businessName string Business name for partner or location - N102 NAD040-010
        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 - - -
          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 - - - - -
          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"
      freeTextNote array Ship to party company identifiers and address information. - - -
        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. - - -
    canonicalPriceSalesCatalogItemDetails array Price sales catalog product and pricing details. Note: this is the parent for the price catalog details. It includes processing instructions, assortment module (a way of organizing items in SAP), material groups, etc. For each instance of E1WSOHM, there could be one or more instances of E1MARAM. The segment E1MARAM represents the level table (MARA) for the SAP material master record. Each segment below E1MARAM represents either other tables in the material master, Bills of Materials, characteristics of the material, tax classifications, and pricing conditions (which stores the pricing for the item). This is all pulled from SAP master data. Segment E1WSOHM and E1WSOTM segment loop LIN Example: LIN+1+1+4043977029571:EN::9'
      processingFunctionTypeCode string

Processing function code at the line item level.

Valid values include:

  • CHANGE

  • REPLACE

  • ORIGINAL

  • DELETE

  • DONOTIMPORT

  • RESEND

MSGFN

  • 003 - DELETE

  • 004 - CHANGE

  • 005 - REPLACE

  • 009 - ORIGINAL

  • 023 - DONOTIMPORT

  • 018 - RESEND

 - -
      isForDeletion boolean

Deletion indicator for material.

Valid values:

  • True - Material record flagged for deletion

  • False - Do not delete item (default)

 LVORM X = true - -
      lineItemNumber string Line Item Number. - LIN01 LIN01
      assortmentModule string Determines materials to be sent in price catalog. SKOPF - -
      assortmentModuleText string Description of assortment module. E1WSOTM/VTEXT Copy processingFunctionTypeCode to E1WSOTM/MSGFN - -
      assortmentModuleType string Assortment module type. STYPB - -
      assortmentModulePriority string Assortment priority. PFLKN - -
      isActive boolean

Is material assortment active or inactive.

Valid values:

  • True - Active (default)

  • False - Inactive

 STAT1 X = true - -
      isStatusPromotion boolean

Status assignment promotion.

Valid values:

  • True -Yes

  • False - No (default)

 STAT2 X = true - -
      promotionIdentifier string Promotion identifier. AKTIO - -
      materialGroup string Material group for items in price sales catalog. WAGRP - -
      manufacturerName string Manufacturer name at line item level. In some cases catalog may include different products from different manufacturers. - segment loop LIN-N1 N102 segment loop 36 LIN-NAD (segment 52) NAD040-010
      exemptionStatus array This segment is intended to convey DSCSA exemption status of a given product and should only be use/present when the manufacturer/repackager has determined the product is exempt under the statute or has obtained a waiver, exception, or exemption (WEE) from FDA. - YNQ - Yes / No Question -
        statementConfirmation boolean

Field to capture confirms or denies the exemption status.

  • True - statement is confirmed

  • False - statement is denied

 - YNQ02 (true=Y, false=N) -
        dateType string

Exemption Date type format qualifier.

The valid value is DATERANGE.

 - YNQ03 -
        dateValue string Exemption date range in format CCYYMMDD-CCYYMMDD. - YNQ04 -
        description string Notification text that sender describe what DSCSA requirements is excluded from. - YNQ05 -
        exemptionCodeType string

Code type identifiying Industry code.

The valid value is COVERAGECODE.

 - YNQ08 COVERAGECODE = CV -
        exemptionCode string

Code identifiying Industry code.

valid values

  • FDAEXEMPTION - A waiver, exception, or exemption has been granted by FDA for a product

  • STATUTORYEXEMPTION - The product is exempt by statutory definition

  • NOTEXEMPT - Not Exempt

 -

YNG09

  • FDAEXEMPTION - WEE

  • STATUTORYEXEMPTION - SE

  • NOTEXEMPT - NE

 -
      priceSalesCatalogItems array Quantity of item scheduled in the forecast - - -
        processingFunctionTypeCode string

Processing function code at the line item level.

Valid values include:

  • CHANGE

  • REPLACE

  • ORIGINAL

  • DELETE

  • DONOTIMPORT

  • RESEND

MSGFN

  • 003 - DELETE

  • 004 - CHANGE

  • 005 - REPLACE

  • 009 - ORIGINAL

  • 023 - DONOTIMPORT

  • 018 - RESEND

 - -
        isForDeletion boolean

Deletion indicator for material.

Valid values:

  • True - Material record flagged for deletion

  • False - Do not delete item (default)

 E1MARAM/LVORM X = true - -
        createDate string Date material record was created in date format YYYYMMDD. E1MARAM/ERSDA DTM02 where DTM01 = 097 Loop 36 LIN/DTM010-020 where DTM010-010 = 97
        epochCreateDate integer Date material record generated in epoch integer date format. - - -
        dateOfLastChange string Date material record was last changed in date format YYYYMMDD. E1MARAM/LAEDA DTM02 where DTM01 = 328 Loop 36 LIN/DTM010-020 where DTM010-010 = 558
        epochDateOfLastChange - Date material record was last changed in epoch integer date format. - - -
        packingQuantity number Quantity of eaches of item that packs into an inner pack or case.. - PO401 QTY010-020 where QTY010-010 = "52" (qty in pack)
        unitPackSize number Size of supplier units in pack. - PO402 -
        unitOfMeasure string

Base unit of measure or UOM for quantity of item in pack.

Quantity UOMs include:

  • CA - Case

  • CP- Crate

  • CT- Carton

  • DS - Display

  • DZ - Dozen

  • EA - Each

  • PC - Piece

  • PF - Pallet

  • PK - Package

  • T3 - Thousand Pieces

  • TH - Thousand

  • TY - Tray

  • UN - Unit

 E1MARAM/MEINS PO403 -
        materialGroup string Material group for item in price sales catalog. E1MARAM/MATKL - -
        materialTypeGroup string Material type represented by item in catalog, ie, finished product, raw material, component, etc. E1MARAM/MTART - -
        maintenanceStatus string Maintenance status for item in price sales catalog. E1MARAM/PSTAT - -
        industrySector string Industry sector for item. SAP pass thru mapping. E1MARAM/MBRSH - -
        previousProductIdentifier string Previous identifier for product in price sales catalog. E1MARAM/BISMT - -
        lotNumber string Lot or batch identifier (customer). - - -
        expirationDate string Expiration date for lot in string date format YYYYMMDD. - - -
        epochExpirationDate integer Expiration date for lot generated in epoch integer date format. - - -
        itemWeight array Net and/or gross weight mapping. - - -
          weightType string

Weight type.

The valid value is NETWEIGHT - GROSSWEIGHT.

 - - -
          weightValue string Weight value.

If weightType = "NETWEIGHT", map to E1MARAM/NTGEW

If weightType = "GROSSWEIGHT", map to E1MARAM/BRGEW

 - -
          unitOfMeasure string Unit of measure for weights. E1MARAM/GEWEI - -
        plantIdentifier string Plant to which material is assigned. E1MARCM/WERKS REF02 where REF01 = PE (plant) RFF010-020 where RFF010-010 = PE (plant) Loop 36 LIN/RFF
        salesOrganization string Sales organization for product. E1MVKEM/VKORG - -
        distributionChannel string Distribution channel for product. E1MVKEM/VTWEG - -
        isCashDiscount boolean

Cash discount boolean.

Valid values:

  • True - Is eligible for cash discount

  • False - is NOT eligible for cash discount (default)

 E1MVKEM/SKTOF - -
        minOrderQuantity number Minimum quantity of product per order in base unit of measure. E1MVKEM/AUMNG - -
        minDeliveryQuantity number Minimum quantity per delivery in delivery unit of measure. E1MVKEM/LFMNG - -
        minMakeToOrderQuantity number Minimum quantity per order that could be manufactured. E1MVKEM/EFMNG - -
        supplierProductCode - Supplier's product code type and identifier. - - -
          productCodeType string Code to qualify product identifier type. Examples: - SUPPLIER SAP does not support an item type in this IDoc. E1MARAM/MATNR is the internal SAP identifier. For mapping to MATNR, hard code/select "SUPPLIER" for productCodeType LIN02 = "VN" productCodeType = "SUPPLIER" Mapped pairs are: LIN02/03 LIN030.020 = "VN" productCodeType = SUPPLIER
          productCodeValue string Product code identifier value. E1MARAM/MATNR where productCodeType = "SUPPLIER" LIN03 where productCodeType = "SUPPLIER" LIN030.010 where productCodeType = SUPPLIER
        globalProductCode - Global product code type and identifier. - - -
          productCodeType string

Code to qualify product identifier type. Examples:

  • GTIN14

  • EU_EAN13

  • UPC

SAP does not support an item type in this IDoc. E1MARAM/EAN11 maps the GTIN, EAN or UPC identifier. For mapping to EAN11, hard code/select "GTIN14" or "EU_EAN13" or "UPC" for productCodeType LIN04 = "UK" or "UP" productCodeType = "GTIN14" or "UPC" Mapped pairs are: LIN04/05 LIN030.020 = "SRV" or "VN" productCodeType = "GTIN14" or "UPC"
          productCodeValue string Product code identifier value. E1MARAM/EAN11 where productCodeType = "SUPPLIER" LIN05 where productCodeType = "" LIN030.010 where productCodeType = SUPPLIER
        buyerProductCode   Buyer's product code type and identifier. - - -
          productCodeType string Code to qualify product identifier type. Examples: CUSTOMER. - LIN06 = "BP" productCodeType = "CUSTOMER" Mapped pairs are: LIN06/07 PIA020-020 = "BP" productCodeType = "CUSTOMER" Hard code "1" to PIA010 (Additional identification)
          productCodeValue string Product code identifier value. - LIN07 where productCodeType = "CUSTOMER" PIA020-020 where productCodeType = "CUSTOMER"
        productCodesIdentifiers array Product code identifier types and values. Use this array for other then buyer, supplier, global product code types. - - -
          productCodeType string

Code to qualify product identifier type.

Examples:

  • GTIN12 - GTIN12

  • UPC - EAN/UPC Universal Item Number

  • MANUFACTURER - Manufacturer's product number

  • UPN - Universal product number

  • US_NHRIC - US National Health Related Item Code

  • US_NDC442 - US National-Drug-Code-NDC442-with-hyphen-separators

  • US_NDC532 - US National-Drug-Code-NDC532-with-hyphen-separators

  • US_NDC541 - US National-Drug-Code-NDC541-with-hyphen-separators

  • US_NDC542 - US-National-Drug-Code-NDC542-with-hyphen-separators

  • US_NHRIC55 - US National Health Related Item Code with hypen separator with 5 and characters

  • US_NHRIC64 - US National Health Related Item Code with hypen separators with 6 and 4 characters

  • BUYERCATALOG - Buyer Catalog

  • AN2551E - EAN 2-5-5-1

  • CA_DIN - Canada product number

  • BUYERITEM - Buyer's Item Number

  • SKU - Stock Keeping Unit

  • CASEUPC - Case UPC. UPC Case Code (2-5-5). Legacy UPC

  • PACKAGEUPC - UPC Consumer Package Code (1-5-5)

  • VENDORCATALOG - Vendor Catalog Number. Vendor's (Seller's) Catalog Number

  • US_NDC - National Drug Code

   LIN08/ LIN10/ LIN12/ LIN14/ LIN16  
          productCodeValue string Product code identifier value. - LIN09/ LIN11/ LIN13/ LIN15/ LIN17 -
        productImageURL string URL that links to the image of the current product at the price sales catalog item details level. - - -
        productItemInformation array Product item descriptions and information. - - -
          productLanguageCode string Language for product description. - - -
          productName string Name of product. - - -
          genericName string Generic name for product. - - -
          productDescription string Description of the product defined by the current product identifier. - - -
        productItemDescriptions array Supplier's product code Segment E1MAKTM - -
          processingFunctionTypeCode string

Processing function code at the line item level.

Valid values include:

  • CHANGE

  • REPLACE

  • ORIGINAL

  • DELETE

  • DONOTIMPORT

  • RESEND

E1MAKTM/MSGFN

  • 003 - DELETE

  • 004 - CHANGE

  • 005 - REPLACE

  • 009 - ORIGINAL

  • 023 - DONOTIMPORT

  • 018 - RESEND

G5301

  • 001 - CHANGE

  • 002 - DELETE

  • 050 - ORIGINAL

  
          productLanguageCode string ISO language code for product description. Pass thru mapping for IDoc, X12 and EDIFACT, which all use the same ISO language code. E1MAKTM/SPRAS_ISO PID09 IMD030-060
          productDescription string Description of the product defined by the current product identifier. E1MAKTM/MAKTX PID05 IMD030.040
        mpcDates array Dates relevant for inventory adjustment header. - - -
          dateType string

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

Valid values:

  • VALIDITY

  • EFFECTIVE

  • EXPIRATION

  • PROCESSING

  • AVAILABILITY

  • TRANSACTION

  • DOCUMENT

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

 

DTM01 =

  • VLU (VALIDITY) or

  • 007 (EFFECTIVE) or

  • 036 (EXPIRATION) or

  • 009 (PROCESSING) or

  • 018 (AVAILABILITY) or

  • 097 (TRANSACTION) or

  • 999 (DOCUMENT) or

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION)

DTM010-010 =

  • 7 (EFFECTIVE) or

  • 9 (PROCESSING) or

  • 36 (EXPIRATION) or

  • 44 (AVAILABILITY) or

  • 97 (TRANSACTION) or

  • 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. - DTM02

DTM010-020 where DTM010-010 =

  • 7 or

  • 9 or

  • 36 or

  • 44 or

  • 97 or

  • 137
          epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
          timeZone string Time zone for referenced dates. - - -
        transactionReferenceIdentifierList array Transaction references for inventory adjustment at header level that affects the entire message. - - -
          b2bTransactionIdentifierType string Referenced document type. The valid value is: CUSTOMERCONTRACT. - REF01 = BC (CUSTOMERCONTRACT) -
          b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. - REF02 when b2bTransactionIdentifierType = "CUSTOMERCONTRACT" -
          transactionDate string Date transaction created. - - -
          epochTransactionDate integer Date transaction created in epoch integer date format. - - -
          lineItemNumber string Line item number in customer purchase order. 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 and N9 and EDIFACT RFF for information other than transaction documents. - loop LIN/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:

  • CONTRACTREFERENCE - Contract reference number

  • AGENTCONTRACT - Agent contract number

  • ADJUSTMENTCONTROL - Adjustment control number

  • CONTRACTCLASS - Contract class

  • CONTRACT - Contract number

 -

REF01 =

  • KL (CONTRACTREFERENCE) or

  • 6L (AGENTCONTRACT) or

  • BP (ADJUSTMENTCONTROL) or

  • CE (CONTRACTCLASS) or

  • CT (CONTRACT)

-
          transactionReferenceIdentifier string Transaction reference identifier value. - REF02 -
          description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - 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. - - -
        taxes array Tax information and amounts. Header level. Tax amounts reported at header reflect totals for invoice. - - -
          taxType string

Type of tax recorded. List can be extended as required.

Valid value:

  • VAT

  • HARMONIZEDSALES

  • FEDERALEXCISE

  • STATESALES

  • PROVINCIALSALES

  • CITYSALES

  • COUNTYSALES

  • GOODSANDSERVICES

  • CUSTOMSDUTY

  • SURTAX

-

TXI01 = -

  • CS (CITYSALES) Or

  • CT (COUNTYSALES) Or

  • CG (CUSTOMSDUTY) Or

  • FD (FEDERALEXCISE) Or

  • GS (GOODSANDSERVICES) Or

  • BE (HARMONIZEDSALES) Or

  • PG (PROVINCIALSALES) Or

  • ST (STATESALES) Or

  • AB (SURTAX) Or

  • VA (VAT)

 -
          country string Country for which taxes are recorded. - - -
          taxRegistration string Tax registration number. - - -
          taxJurisdictionCode string Tax jurisdiction code. - - -
          taxExemptCode string Tax exempt code. - - -
          taxAmount string Total amount of tax in invoice. - - -
          taxCurrencyCode string Currency for taxes. - - -
          taxPercent string Tax rate in percent. - - -
          taxRate string Amount used for calculation of tax. - - -
          vatIndicator string VAT indicator. - - -
        pricingConditionsHeader array Header group for pricing conditions and pricing. - - -
          conditionType string Condition type. E1PKOMG/KSCHL E1KONP/KSCHL - -
          conditionTable string Condition table identifier. E1PKOMG/KOTABNR - -
          conditionTableUsage string Condition table usage. E1PKOMG/KVEWE - -
          conditionApplication string Application linked to pricing condition. E1PKOMG/KAPPL - -
          conditionKey string Key value identifying pricing condition in conditions database. E1PKOMG/VAKEY - -
          pricingConditionsItems array Pricing conditions item details.   - -
            conditionRecordIdentifier string Pricing condition record identifier. E1KONH/KNUMH - -
            discountLine string Descriptive information on discount condition. - - -
            discountPercent string Discount percent applicable on discount condition. - - -
            discountedQuantity number Discount condition applicable quantify. - - -
            validFromDate string Pricing condition valid from date. E1KONH/DATAB CTP/DTM02 where DTM01 = "007" (effective date) PRI/DTM010-020 where DTM010-010 = "157" (validity start date)
            epochValidFromDate integer Pricing condition valid from date generated in epoch integer date format. - - -
            validToDate string Pricing condition valid to date. E1KONH/DATBI CTP/DTM02 where DTM01 = "VLU" (valid until) PRI/DTM020-020 where DTM010-010 = "799" (validity end date)
            epochValidToDate integer Pricing condition valid to date generated in epoch integer date format. - - -
            pricingType string

Pricing type for price sales catalog.

Valid values include:

  • CATALOG - Catalog price

  • UNIT - Unit price

  • CHANGED - Price change

  • CONTRACT - Contract price

  • DISCOUNT - Discounted price

  • PROMOTION - Promotion price

 -

CTP02 =

  • UCP (unit price) or

  • CAT or

  • CHG or

  • CON or

  • DPR or

  • PRP

PRI010-010 = AAF (catalog price)

PRI010-030 =

  • CA (Catalog) or

  • CT (Contract) or

  • PE (Each, unit)
            pricingAmount number Pricing amount for condition or for pricing type. E1KONP/KBETR CTP03 where CTP02 = "UCP" PRI010.20 where PRI010-010 = "AAF"
            currencyCode string Currency code for the pricing amount. E1KONP/KONWA - -
            unitPriceBasisQuantity string Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12. E1KONP/KPEIN CTP04 PRI010-050
            unitOfMeasure string Unit of measure used for pricing at the price conditions line item details level. E1KONP/KMEIN CTP05 PRI010-060
            altUOMDenominator string

Denominator is used to convert from an alternate unit of measure, ie KG, to a base unit of measure, ie EA.

The denominator is the number of units of the alternative UOM (KG) that corresponds to the number of units of the base UOM (EA).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 5 is the denominator. In most cases, this value will be 1.

 E1KONP/KUMNE - -
            altUOMNumerator string

Numerator is used to convert from an alternate unit of measure, ie, KG to a base unit of measure, ie, EA.

The numerator is the number of units of the base UOM (EA) that corresponds to the number of units of the alternative UOM (KG).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 3 is the numerator. In most cases, this value will be 1.

 E1KONP/KUMZA CTP07 -
            conditionItemIndex string Pricing condition item index. E1KONP/ZAEHK_IND - -
            pricingScaleBaseInformation array Pricing scale base information at the pricing condition item details level. - - -
              scaleType string Pricing condition scale type. E1KONP/STFKZ - -
              scaleBasis string Basis for populating scale tables, ie, quantity. E1KONP/KZBZG - -
              scaleQuantity number Scale quantity at pricing conditions item details level. E1KONP/KSTBM - -
              unitOfMeasure string

Unit of measure for scale quantity.

Quantity UOMs include:

  • CA - Case

  • CP- Crate

  • CT- Carton

  • DS - Display

  • DZ - Dozen

  • EA - Each

  • PC - Piece

  • PF - Pallet

  • PK - Package

  • T3 - Thousand Pieces

  • TH - Thousand

  • TY - Tray

  • UN - Unit

 E1KONP/KONMS - -
              scaleValue number Monetary value of pricing condition scale. E1KONP/KSTBW - -
              scaleCalculationType string Scale calculation type. E1KONP/KRECH - -
        subLineItemDetails array Sub line item details. - SLN -
          subLineItemNumber string sub line item number. - SLN01 -
          subLineItemRelationshipCode string sub line item relationship code. - SLN03 (Mandetory) -
          subLineItemQuantityValue number Sub line item quantity. - SLN04 -
          unitOfMeasure string

Unit of measure for scale quantity.

Quantity UOMs include:

  • CA - Case

  • CP- Crate

  • CT- Carton

  • DS - Display

  • DZ - Dozen

  • EA - Each

  • PC - Piece

  • PF - Pallet

  • PK - Package

  • T3 - Thousand Pieces

  • TH - Thousand

  • TY - Tray

  • UN - Unit

 - SLN05 -
      freeTextNote array Ship to party company identifiers and address information. - - -
        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. - - -
    canonicalPriceSalesCatalogSummary array Summary totals for price sales catalog Segment E1EDS01 CTT -
      summaryType string

Summary type for the payment remittance advice.

The valid value is NUMBEROFITEMS .

 SUMID = "001" CTT01 -
      summaryValue string Summary value. SUMME where SUMID = "001" CTT02 -
      summaryValueUnit string Summary value unit of measure. SUNIT CTT04 -

Tag end