Tracelink University ## Breadcrumb 1. [Home](/) 2. [Resources](/resources/resource-center) 3. [TraceLink University](/resources/tracelink-university) # Forecast plan response canonical guidelines - [Download PDF](/node/632356/pdf) - [Share](#) - [ LinkedIn ](https://www.linkedin.com/shareArticle?mini=true&url=https://www.tracelink.com/resources/tracelink-university/forecast-plan-response-canonical-guidelines-0&title=Forecast plan response canonical guidelines&summary=The Forecast Plan IDoc message sends advanced notice to a supplier about the buyer's anticipated product quantity needs for an upcoming period of time.&source=TraceLink "LinkedIn") - [ Facebook ](https://www.facebook.com/share.php?u=https://www.tracelink.com/resources/tracelink-university/forecast-plan-response-canonical-guidelines-0&t=Forecast plan response canonical guidelines "Facebook") - [ Mail ](mailto:?subject=Forecast plan response canonical guidelines+|+TraceLink&body=https://www.tracelink.com/resources/tracelink-university/forecast-plan-response-canonical-guidelines-0 "Mail") - [ Twitter ](https://twitter.com/intent/tweet?text=Forecast plan response canonical guidelines https://www.tracelink.com/resources/tracelink-university/forecast-plan-response-canonical-guidelines-0&via=TraceLink "Twitter") #### Table of contents The Forecast Plan IDoc message sends advanced notice to a supplier about the buyer's anticipated product quantity needs for an upcoming period of time. [![Closed](/sites/default/files/tech_comms/mpl-canonical/Skins/Default/Stylesheets/Images/transparent.gif)Canonical guidelines](#) | 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 canonicalf sales forecast. | - | - | - | | | | canonicalForecastPlanHeader | - | Forecast plan message header. | - | - | - | | | | | processingFunctionTypeCode | string | Processing function, transaction set purpose code. Valid values: - `CREATE` - `CHANGE` - `CANCEL` - `ORIGINAL` - `REPLACE` - `STATUS` - `INFORMATION` - `RESPONSE` - `PROPOSED` | - | BFR01 | BGM030 | | | | | forecastScheduleType | string | Forecast schedule type. Required value for X12 only. Valid values: - `AUTHORIZEDDELIVERY` - `AUTHORIZEDSHIPMENT` - `CUSTOMERPRODUCTION` - `DELIVERYBASED` - `BUYERPRODUCTION` - `KANBAN` - `NONRECURRINGDEMAND` - `PLANNEDDELIVERY` - `PLANNEDREQUIREMENT` - `PLANNEDSHIPMENT` - `RECURRINGDEMAND` - `SHIPMENTBASED` - `CUSTOM` | - | BFR04 | - | | | | | forecastScheduleQuantityType | string | Forecast schedule quantity type. Required value. Pass through. Valid values: - `DISCRETE` - `CUMULATIVE` - `NETCHANGE` - `REPLACEMENT` | - | BFR05 | - | | | | | customerIdentifier | string | Customer number for forecast. | E1EDK09/ABNRA | - | - | | | | | usageIndicator | string | Usage indicator. | E1EDK09/ABRVW | - | - | | | | | plantIdentifer | string | Plant identifier. | For manufacturing plant: - E1EDK09/USER01 - MANUFACTURINGPLANT - E1EDK09/USER02 - \[plantIdentifier value\] | - | - | | | | | description | string | Descriptive information about forecast plan id. | - | - | - | | | | | forecastPeriod | string | Sales forecast period. Valid values: - `DAY` (default) - `WEEK` - `MONTH` - `INTERVAL` - `YEARLY (X12)` - `TWICEYEARLY (X12)` - `DELIVERY (X12)` - `DISCRETE (X12)` - `QUARTER (X12)` - `FOURWEEK` - `CUSTOM` | - | - | - | | | | | messageLocationType | string | Type of the entity forecast applies, such as it is defined at customer, supplier, bill to, ship to etc and not a location. | - | - | - | | | | | messageLocationIdentifierValue | string | Forecast plan entity id. | - | - | - | | | | | locationName | string | Name of the entity for forecast receiving. | - | - | - | | | | | transactionReferenceIdentifierList | array | Transaction references for inventory balance report. | - | - | - | | | | | | b2bTransactionIdentifierType | string | Referenced document type. Valid values: - `FORECASTPLAN` - `PURCHASEORDER` - `CONTRACT` - `REFERENCE` - `RELEASE` | - b2bTransactionIdentifierType = FORECASTPLAN - b2bTransactionIdentifierType = CONTRACT - b2bTransactionIdentifierType = REFERENCE | - b2bTransactionIdentifierType = FORECASTPLAN - b2bTransactionIdentifierType = RELEASE - b2bTransactionIdentifierType = CONTRACT - b2bTransactionIdentifierType = PURCHASEORDER | - b2bTransactionIdentifierType = FORECASTPLAN - b2bTransactionIdentifierType = RELEASE - b2bTransactionIdentifierType = CONTRACT | | | | | | b2bTransactionIdentifierValue | string | Purchase order number for lotAttributes. | - FORECASTPLAN map to: E1EDK09/LABNK - CONTRACT map to: E1EDK09/VTRNR - REFERENCE map to: E1EDK09/VZEICH | - FORECASTPLAN map to BFR02 - RELEASE map to BFR03 - CONTRACT map to BFR10 - PURCHASEORDER map to BFR11 - Purchase order may also be mapped to XPO01. | - FORECASTPLAN map to BGM020-010 - RELEASE map to RFF-020 with REF-010 = RE\\n - CONTRACT map to RFF-020 with REF-010 = CT | | | | | | transactionDate | string | Date transaction created. | - | FORECASTPLAN map to BFR06. If date missing, map from dateType = REFERENCE If date missing, map from ISA09 | - | | | | | | epochTransactionDate | integer | Date transaction created in epoch integer date format. | - | - | - | | | | | | lineItemNumber | string | Line item number in customer purchase order. Line item level only. | - | - | - | | | | | mpcDates | array | Dates relevant for the batch master. | - | - | - | | | | | | dateType | string | Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values: - `PURCHASEORDER` - `SCHEDULEDDELIVERY` - `DELIVERYSCHEDULE` - `DOCUMENT` - `STARTDATE` | - dateType = PURCHASEORDER - dateType = DELIVERYSCHEDULE | - dateType = PURCHASEORDER = DTM01 = 004 - dateType = SCHEDULEDDELIVERY = DTM01 = 067 - dateType = DOCUMENT = DTM01 = 166 - dateType = STARTDATE = DTM01 = 196 | PURCHASEORDER = DTM010-010 = 4 SCHEDULEDDELIVERY = DTM010-010 = 67 | | | | | | dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Dates will be populated with string of 0's if no date found for any of these date types. | - PURCHASEORDER map to E1EDK09/BSTDK - DELIVERYSCHEDULE map to E1EDK09/ABNRD | - DTM02 (date) - DTM03 (time) - If dateType = DOCUMENT, map to BFR08 | DTM010-020 | | | | | | epochDateValue | integer | Date defined by referenced date type in epoch integer date format. | - | - | - | | | | | | timeZone | string | Time zone for referenced dates. | - | - | - | | | | | customerBusinessInformation | - | Customer party company identifiers and address information. | E1EDKA1 where PARVW = "AG" | N101 = "BY" | NAD010 = "BY" | | | | | | businessName | string | Business name for partner or location. | E1EDKA1/NAME1 | N102 | NAD030-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 | | | | | | | companyIdentifierValue | string | Company identifier value for business partner. | E1EDKA1/PARTN | N104 | NAD020-010 | | | | | | | alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | - | - | - | | | | | | address | - | Party address information. | - | - | - | | | | | | | address1 | string | Main street address. | E1EDKA1/STRAS | N301 | NAD050-010 | | | | | | | address2 | string | Supplemental street address. | E1EDKA1/STRAS2 | N302 | NAD050-020 | | | | | | | city | string | City. | E1EDKA1/ORT01 | N401 | NAD060 | | | | | | | district | string | District. | - | - | - | | | | | | | state | string | State or region code. | E1EDKA1/REGIO | N402 | NAD070-010 | | | | | | | postalCode | string | Postal code. | E1EDKA1/PSTLZ | N403 | NAD080 | | | | | | | country | string | Country code. | E1EDKA1/LAND1 | N404 | NAD090 | | | | | | | telephone | string | Telephone number. | E1EDKA1/TELF1 | - | - | | | | | | | fax | string | Fax number. | E1EDKA1/TELFX | - | - | | | | | | | 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. | E1EDKA1 where PARVW = "LF" | N101 = "SU" | NAD010 = "SU" | | | | | | businessName | string | Business name for partner or location. | E1EDKA1/NAME1 | N102 | NAD030-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 | | | | | | | companyIdentifierValue | string | Company identifier value for business partner. | E1EDKA1/PARTN | N104 | NAD020-010 | | | | | | | alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | - | - | - | | | | | | address | - | Party address information. | - | - | - | | | | | | | address1 | string | Main street address. | E1EDKA1/STRAS | N301 | NAD050-010 | | | | | | | address2 | string | Supplemental street address. | E1EDKA1/STRAS2 | N302 | NAD050-020 | | | | | | | city | string | City. | E1EDKA1/ORT01 | N401 | NAD060 | | | | | | | district | string | District. | - | - | - | | | | | | | state | string | State or region code. | E1EDKA1/REGIO | N402 | NAD070-010 | | | | | | | postalCode | string | Postal code. | E1EDKA1/PSTLZ | N403 | NAD080 | | | | | | | country | string | Country code. | E1EDKA1/LAND1 | N404 | NAD090 | | | | | | | telephone | string | Telephone number. | E1EDKA1/TELF1 | - | - | | | | | | | fax | string | Fax number. | E1EDKA1/TELFX | - | - | | | | | | | 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" | | | | | shipToLocationInformation | - | Ship to party company identifiers and address information. | E1EDKA1 where PARVW = "WE" | N101 = "ST" | NAD010 = "ST" | | | | | | businessName | string | Business name for partner or location. | E1EDKA1/NAME1 | N102 | NAD030-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 | | | | | | | companyIdentifierValue | string | Company identifier value for business partner. | E1EDKA1/PARTN | N104 | NAD020-010 | | | | | | | alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | - | - | - | | | | | | address | - | Party address information. | - | - | - | | | | | | | address1 | string | Main street address. | E1EDKA1/STRAS | N301 | NAD050-010 | | | | | | | address2 | string | Supplemental street address. | E1EDKA1/STRAS2 | N302 | NAD050-020 | | | | | | | city | string | City. | E1EDKA1/ORT01 | N401 | NAD060 | | | | | | | district | string | District. | - | - | - | | | | | | | state | string | State or region code. | E1EDKA1/REGIO | N402 | NAD070-010 | | | | | | | postalCode | string | Postal code. | E1EDKA1/PSTLZ | N403 | NAD080 | | | | | | | country | string | Country code. | E1EDKA1/LAND1 | N404 | NAD090 | | | | | | | telephone | string | Telephone number. | E1EDKA1/TELF1 | - | - | | | | | | | fax | string | Fax number. | E1EDKA1/TELFX | - | - | | | | | | | 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 | - | Ship to party company identifiers and address information. | - | N101 = "SF" | NAD010 = "SF" | | | | | | businessName | string | Business name for partner or location. | - | N102 | NAD030-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 | | | | | | | 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. Will map whatever is found. | E1EDK11/TDNAME | - | - | | | | | | textFunctionCode | string | Text function code. Will map whatever is found. | - | - | - | | | | | | language | string | Language of free text. | E1EDK11/SPRAS | - | - | | | | | | textFormatCode | string | Format code for free text. | - | - | - | | | | | | freeText | string | Free test string. | E1EDK11/TXT01 | - | - | | | | | 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. | - | - | - | | | | canonicalForecastPlanItemDetails | array | Message location identifiers and other related information as header attributes for line item details. EDIFACT requirement. Looping group includes line item details for EDIFACT sales report. This is an optional looping attribute group that only maps to the EDIFACT SLSRPT message, which includes line item details as a loop within a mandatory LOC looping group. | - | - | Optional looping group relevant only for EDIFACT SLSRPT message. Required in EDIFACT. Line item level LIN loop a child of required LOC loop. Note: EDIFACT pins item details to location. There could be one or more locations each with one or more item forecastPlanItems. | | | | | messageLocationType | string | Message location type. EDIFACT pass-thru mapping. | - | - | LOC010 | | | | | messageLocationIdentifierValue | string | Message location identifier value. EDIFACT mapping. | - | - | LOC020-010 | | | | | messageLocationTypeStandard | string | Message location type standards body, ie, GS1. EDIFACT pass-thru mapping. | - | - | LOC020-030 | | | | | locationName | string | Name of the entity for forecast receiving. | - | - | - | | | | | endCustomerName | string | Name of the end customer. | - | - | - | | | | | endCustomerIdentifier | string | End customer id. | - | - | - | | | | | forecastPlanItems | array | Forecast plan message line item details. | - | - | - | | | | | | lineItemNumber | string | Line item number for inventory balance report. Also serves as the unique record identifier for sales forecast reports that use a unique record identifier but no line item number. Also serves as the recordIdentifier for Merck's custom XML forecast. | - | LIN01 | LIN010 | | | | | | plantIdentifier | string | Customer plant identifier for sales forecast. | E1EDP10/KWERK | REF02 where REF01 = PE | - LOC020-010 where LOC010 = 19 or - RFF010-020 where RFF010-010 = PE - LOC mapping for EDIFACT is at the messageLocation level parent to the line item details. | | | | | | forecastVersion | string | Sales forecast version. | - | REF02 where REF01 = V0 | - | | | | | | unloadingPoint | string | Unloading point at customer location. | E1EDP10/DFABL | - | - | | | | | | consumptionPoint | string | Consumption point at customer location. | E1EDP10/VBRST | - | - | | | | | | unitOfMeasure | string | Unit or Basis for Measurement Code. Quantity UOM's 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 | E1EDP10/VRKME | UIT01 | - | | | | | | releaseScheduleKey | string | Release schedule key. | E1EDP10/SCREL | - | - | | | | | | lotNumber | string | Lot or batch identifier. | - | - LIN03 or - LIN05 or - LIN07 or - LIN09 or - LIN11 or - LIN13 where LIN02 … LIN012 = B8 (batch) or LT (lot) | - LIN03 or - LIN05 or - LIN07 or - LIN09 or - LIN11 or - LIN13 where LIN02 … LIN012 = NB (batch) or BB (lot) | | | | | | productCodesIdentifiers | array | Internal material identifier in the backend/ERP systems for the product. In the delivery this will be the supplier, although the customer and other identifiers may also be present. | - | - | - | | | | | | | productCodeType | string | Code to qualify product identifier type: - `CUSTOMER` - `SUPPLIER` - `MANUFACTURER` - `GTIN-14` - `NTIN` - `CN-RESCODE` - `VENDORPARTNUM` - `UPC` - `SKU` | - productCodeType = CUSTOMER - productCodeType = SUPPLIER | LIN02 or LIN04 or LIN06 or LIN08 or LIN10 or LIN12 or LIN14 or LIN16 or LIN18 or LIN20 | LIN030-020 Additional product types: - PIA010 = 1 (additional identification) - PIA020-020 - PIA030-020 - PIA040-020 - PIA050-020 - PIA060-020 | | | | | | | productCodeValue | string | Product code identifier value. | CUSTOMER map to E1EDP10/IDNKD SUPPLIER map to E1EDP10/IDNLF | LIN03 or LIN05 or LIN07 or LIN09 or LIN11 or LIN13 or LIN15 or LIN17 or LIN19 or LIN21 | LIN030-010 Additional product codes: PIA020-010 PIA030-010 PIA040-010 PIA050-010 PIA060-010 | | | | | | productItemInformation | array | Product item code information. Only using a subset of all available attributes. | - | - | - | | | | | | | productLanguageCode | string | Language for product description. | - | - | IMD030-040, IMD030-050 | | | | | | | productName | string | Name of product. | E1EDP10/ARKTX | PID05 | IMD030-040, IMD030-060 | | | | | | | genericName | string | Generic name for product. | - | - | - | | | | | | | productDescription | string | Description of the product defined by the current product identifier. | - | - | - | | | | | | itemQuantity | array | Quantity of item scheduled in the forecast. | - | - | - | | | | | | | quantityType | string | Type of quantity recorded. Valid value: - `ORDER` - `RECEIVED` - `OUTSTANDING` | - quantityType = ORDER - quantityType = RECEIVED - quantityType = OUTSTANDING | - quantityType = ONORDER map 45 to QTY01 - quantityType = RECEIVED map 87 to QTY01 - quantityType = OUTSTANDING map VJ to QTY01 | - quantityType = ONORDER map 71 to QTY010-010 - quantityType = RECEIVED map 70 to QTY010-010 - quantityType = OUTSTANDING map 73 to QTY010-010 | | | | | | | quantityValue | number | Quantity of product reported in inventory. | - ORDER map to E1EDP10/AKUBM - RECEIVED map to E1EDP10/AKUEM - OUTSTANDING map to E1EDP10/FZDIF | QTY02 | QTY020 | | | | | | | unitOfMeasure | string | Unit or Basis for Measurement Code. Quantity UOM's 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 | - | QTTY03-01 | QTTY030 | | | | | | mpcDates | array | Dates relevant for sales forecast. | - | - | - | | | | | | | dateType | string | Date type at item detail level for sales forecast. Valid values: - `PURCHASEORDER` - `DELIVERY` - `SCHEDULEDDELIVERY` - `ESTIMATEDDELIVERY` - `SHIPPED` - `RECONCILIATIONDATE` - `VALIDFROM` - `VALIDTO` - `SHIPNOTBEFORE` - `SHIPNOTLATER` | - dateType = PURCHASEORDER - dateType = DELIVERY - dateType = SCHEDULEDDELIVERY - dateType = RECONCILIATIONDATE - dateType = VALIDFROM - dateType = VALIDTO | - dateType = PURCHASEORDER map 004 to DTM01 - dateType = DELIVERY map 035 to DTM01 - dateType = SCHEDULEDDELIVERY map 067 to DMT01 - dateType = ESTIMATEDDELIVERY map 017 to DTM01 - dateType = SHIPPED map 011 to DTM01 - dateType = SHIPNOTBEFORE map 037 to DTM01 - dateType = SHIPNOTLATER map 038 to DTM01 | - dateType = PURCHASEORDER map 4 to DTM010-010 - dateType = DELIVERY map 35 to DTM010-010 - dateType = SCHEDULEDDELIVERY map 67 to DTM010-010 - dateType = ESTIMATEDDELIVERY map 17 to DTM010-010 - dateType = SHIPPED map 11 to DTM010-010 - dateType = SHIPNOTBEFORE map 37 to DTM010-010 - dateType = SHIPNOTLATER map 38 to DTM010-010 | | | | | | | dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD or datetime format YYYY-MM-DDTHH:MM:SS.nnnz. Dates may be populated with string of 0's if no date found for any of these date types. Maps will pass thru whatever it finds in inbound date and time fields. | - PURCHASEORDER map to E1EDP10/BSTDK - DELIVERY map to E1EDP10/LIDTL - DELIVERYSCHEDULE map to E1EDP10/ABNRD - RECONCILIATIONDATE map to E1EDP10/ABDAT - VALIDFROM map to E1EDP10/ABRAB - VALIDTO map to E1EDP10/ABRBI | DTM02 | DTM010-020 | | | | | | | epochDateValue | integer | Date defined by referenced date type in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | - | - | - | | | | | | | timeZone | string | Time zone for referenced dates. | - | - | - | | | | | | transactionReferenceIdentifierList | - | Transaction references for purchase order number used in the custom IDoc segment. | - | This may be used in the REF segment at the line item level by some companies. | This may be used in the REF segment at the line item level by some companies. | | | | | | | b2bTransactionIdentifierType | string | Referenced document type. Valid value: - `DELIVERY` - `CONTRACT` - `FORECASTPLAN` | - b2bTransactionIdentifierType = DELIVERY - b2bTransactionIdentifierType = CONTRACT - b2bTransactionIdentifierType = FORECASTPLAN | - | - | | | | | | | b2bTransactionIdentifierValue | string | Purchase order number for lotAttributes. | - DELIVERY map to E1EDP10/BELNR - CONTRACT map to E1EDP10/VTRNR - FORECASTPLAN map to E1EDP10/LABNK | - | - | | | | | | | transactionDate | string | Date transaction created. | - | - | - | | | | | | | 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. | - | - | - | | | | | | forecastDeliveryScheduleLines | array | Delivery schedule lines for sales forecast. | - | - | - | | | | | | | itemQuantity | array | Released quantity in schedule line. One instance per loop of forecastDeliveryScheduleLines. | - | - | - | | | | | | | | quantityType | string | Type of quantity recorded. Valid value: - `RELEASED` - `CUMULATIVE` - `DISCRETE` | - quantityType = RELEASED - quantityType = CUMULATIVE | - quantityType = DISCRETE map to FST11 = 01 - quantityType = CUMULATIVE map to FST11 = 02 - quantityType = RELEASED map to FST11 = H3 | - quantityType = DISCRETE maps to QT010-010 = 1 - quantityType = CUMULATIVE maps to QT010-010 = 3 - quantityType = ITEM maps to QT010-010 = 21 | | | | | | | | quantityValue | number | Quantity of product reported in inventory. | - RELEASED map to E1EDP16/WMENG - CUMULATIVE map to E1EDP16/FZABR | FST01 | QTY010-020 | | | | | | | | unitOfMeasure | string | Unit or Basis for Measurement Code. Quantity UOM's 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 | - | - | QTY010-030 | | | | | | | scheduleLineType | string | Schedule line type. | E1EDP16/ETTYP | - | - | | | | | | | forecastQualifier | string | Forecast qualifier specifying the sender's confidence level of the forecast data or an action associated with a forecast. Map thru. Relevant for X12. | - | FST02 | - | | | | | | | forecastScheduleType | string | Schedule line type. | - | - | - | | | | | | | forecastPeriod | string | Sales forecast period. Valid values: - `DAY` (default) - `WEEK` - `MONTH` - `INTERVAL` - `YEARLY (X12)` - `TWICEYEARLY (X12)` - `DELIVERY (X12)` - `DISCRETE (X12)` - `QUARTER (X12)` - `FOURWEEK` - `CUSTOM` | E1EDP16/PRGRS If not populated, DAY is assumed includes 10 user defined codes. | FST03 | - | | | | | | | scheduleLineFunction | string | Schedule line distribution function. | E1EDP16/ETVTF | - | - | | | | | | | requirementsStatusKey | string | Requirements status key. | E1EDP16/BSTAS | - | - | | | | | | | reasonForOrder | string | Reason for ordering. | E1EDP16/BSTGRU | - | - | | | | | | | description | string | Description of the means of transport. | E1EDP16/TRANSPDESC | - | - | | | | | | | scheduleLineDates | array | Schedule line start and end dates. | - | - | - | | | | | | | | dateType | string | Date type at item detail level for sales forecast. Valid values: - `SCHEDULELINE` - `GOODSISSUE` - `GOODSRECEIPT` - `STARTDATE` - `ENDDATE` | - dateType = SCHEDULELINE - dateType = GOODSISSUE - dateType = GOODSRECEIPT | dateType = SCHEDULELINE | - dateType = SCHEDULELINE - dateType = STARTDATE - dateType = ENDDATE | | | | | | | | fromDate | string | Begin date for the activity defined by the dateType: schedule line, scheduled goods issue, or planned goods receipt. Date defined by referenced date type in date format YYYY-MM-DD or datetime format YYYY-MM-DDTHH:MM:SS.nnnz. Dates may be populated with string of 0's if no date found for any of these date types. Maps will pass thru whatever it finds in inbound date and time fields. | - dateType = SCHEDULELINE map to E1EDP16/EDATUV (time = EZEIT) - dateType = GOODSISSUE map to E1EDP16/WDATUV (time = WZEIT) - dateType = GOODSRECEIPT map to E1EDP16/LDATUV (time = LZEIT) | dateType = SCHEDULELINE, map to FST04 If source format YYYY-MM-DDTHH:MM:SS.nnnz, map time to FST07. | dateType= STARTDATE then map to LIN/SCC/DTM01.2 | | | | | | | | toDate | string | End date for the activity defined by the dateType: schedule line, scheduled goods issue, or planned goods receipt. Date defined by referenced date type in date format YYYY-MM-DD or datetime format YYYY-MM-DDTHH:MM:SS.nnnz. Dates may be populated with string of 0's if no date found for any of these date types. Maps will pass thru whatever it finds in inbound date and time fields. | - dateType = SCHEDULELINE map to E1EDP16/EDATUB - dateType = GOODSISSUE map to E1EDP16/WDATUB - dateType = GOODSRECEIPT map to E1EDP16/LDATUB | dateType = SCHEDULELINE, map from FST05 If forecastPeriod NOT EQUAL DAY | dateType= ENDDATE then map to LIN/SCC/DTM01.2 | | | | | | | | epochFromDate | integer | Begin date for the activity defined by the dateType: schedule line, scheduled goods issue, or planned goods receipt. in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | - | - | - | | | | | | | | epochToDate | integer | End date for the activity defined by the dateType: schedule line, scheduled goods issue, or planned goods receipt. in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | - | - | - | | | | | | | destinationLocationQuantity | array | Destination location quantity. Maps quantities and UOM to be shipped to one or more locations, such as stores, etc. Mapping only for X12. | - | - | - | | | | | | | | unitOfMeasure | string | Unit or Basis for Measurement Code. Quantity UOM's 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 | - | SDQ01 | - | | | | | | | | companyIdentifierType | string | Company/location identifier type. | - | - | - | | | | | | | | destinationQuantitySequence01 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ03 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ04 | - | | | | | | | | destinationQuantitySequence02 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ05 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ06 | - | | | | | | | | destinationQuantitySequence03 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ07 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ08 | - | | | | | | | | destinationQuantitySequence04 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ09 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ10 | - | | | | | | | | destinationQuantitySequence05 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ11 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ12 | - | | | | | | | | destinationQuantitySequence06 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ13 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ14 | - | | | | | | | | destinationQuantitySequence07 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ15 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ16 | - | | | | | | | | destinationQuantitySequence08 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ17 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ18 | - | | | | | | | | destinationQuantitySequence09 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ19 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ20 | - | | | | | | | | destinationQuantitySequence10 | - | Location quantity group 1 with attributes to match SDQ location/quantity pairs. | - | - | - | | | | | | | | | locationIdentifier | string | Location identifier. | - | SDQ21 | - | | | | | | | | | destinationQuantity | integer | Quantity of product reported for location. | - | SDQ22 | - | | | | | | freeTextNote | array | Ship to party company identifiers and address information. | - | - | - | | | | | | | textReferenceCode | string | Text reference or subject code. | E1EDP15/TDNAME | - | - | | | | | | | textFunctionCode | string | Text function code. | - | - | - | | | | | | | language | string | Language of free text. | E1EDP15/SPRAS | - | - | | | | | | | textFormatCode | string | Format code for free text. | - | - | - | | | | | | | freeText | string | Free test string. | E1EDP15/TXT01 | - | - | | | | | | 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. | - | - | - | | | | canonicalForecastPlanSummary | array | Forecast plan summary segment. | - | - | - | | | | | summaryType | string | Summary type for the sales forecast. The valid value is `NUMBEROFITEMS`. | - | summaryType = NUMBEROFITEMS | - | | | | | summaryValue | string | Summary value. | - | CTT01 | - | | | | | summaryValueUnit | string | Summary value unit of measure. | - | - | LOC020-030 | #### Table of contents ##### Related Content [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-idoc) ##### Forecast plan (IDoc) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-idoc) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-x12) ##### Forecast plan (X12) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-x12) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-response-idoc) ##### Forecast plan response (IDoc) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with downstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-response-idoc) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-response-x12) ##### Forecast plan response (X12) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with downstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-response-x12) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/return-authorization-response-idoc) ##### Return authorization response (IDoc) Return authorization responses allows suppliers to issue messages after processing return authorization requests from buyers. [View More](/resources/tracelink-university/return-authorization-response-idoc) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/chat-bubble-question.svg) ](/resources/tracelink-university/forecast-plan-responses) ##### Forecast plan responses Forecast plans response allow suppliers (e.g. [View More](/resources/tracelink-university/forecast-plan-responses)