For technical assistance: xCBL Team at Commerce One, Inc.
Content: DeliveryDate (Type: datetime)? , ShippedDate (Type: datetime)? , EarliestDeliveryDate (Type: datetime)? , LatestDeliveryDate (Type: datetime)? , CollectionDateOfCargo (Type: datetime)? , ScheduleDeliveryDateAfter (Type: datetime)? , ScheduleDeliveryDateBefore (Type: datetime)? , ListOfDateCoded?
Description: The ASNDates element indicates the pertinent dates for the ASN. These dates are global and apply to the entire ASN, except where overridden by dates provided at the line item or package level .
DeliveryDate indicates the date delivery is requested to arrive at the destination.ShippedDate indicates the date items in ASN must be shipped from the seller.EarliestDeliveryDate indicates the earliest delivery date.LatestDeliveryDate indicates the latest delivery date.CollectionDateOfCargo indicates the date the cargo is requested to be collected.ScheduleDeliveryDateAfter indicates the date that delivery is scheduled for on or after.ScheduleDeliveryDateBefore indicates the date that delivery is scheduled for on or before.ListOfDateCoded is used to communicate any other dates not explicitly stated by another element.Content: ListOfASNItemDetail , ListOfASNPackageDetail?
Description: The ASNDetail element contains line item and package details of the ASN.
ListOfASNItemDetail contains a list of line items for the ASN.ListOfASNPackageDetail contains the details of the packaging of the goods in the ASN.Content: ASNPackageDetail (Type: PackageDetail)+
Description: The ListOfASNPackageDetail element contains the details of the packaging of the goods in the ASN.
ASNPackageDetail details the packaging of the goods described in the line items.Content: ASNNumber (Type: Reference) , ASNIssueDate (Type: datetime) , ASNOrderNumber+ , ASNReferences? , ASNPurpose , ASNType? , ASNStatus? , ASNCurrency (Type: Currency)? , ASNLanguage (Type: Language)? , ASNDates , ASNParty (Type: OrderParty) , ListOfTransportRouting? , ASNTermsOfDelivery (Type: TermsOfDelivery)? , ASNPaymentInstructions (Type: PaymentInstructions)? , ASNAllowancesOrCharges (Type: ListOfAllowOrCharge)? , ASNHeaderNote (Type: string)? , ListOfStructuredNote? , ASNHeaderAttachments (Type: ListOfAttachment)?
Description: The ASNHeader element contains the header information of the ASN.
ASNNumber is the unique number that uniquely identifies the ASN, typically according to the system that generated the ASN.ASNIssueDate holds a digital time stamp provided by the application that created the ASN document.ASNOrderNumber indicates the unique number assigned to identify a purchase order that the ASN is referencing.ASNReferences defines the references for the ASN.ASNPurpose defines the purpose of the ASN.ASNType identifies the type of ASN being transmitted.ASNStatus identifies the status of the order/orders that the ASN is referencing and transmitting.ASNCurrency identifies the default currency of the ASN, which when used at the header level may be overwritten at a lower level within the structure (line item level).ASNLanguage identifies the language of the ASN.ASNDates indicates the pertinent dates for the ASN. These dates are global and apply to the entire ASN, except where overridden by dates provided at the line item or package level .ASNParty holds information on the parties to the ASN, including unique ID's and address information.ListOfTransportRouting defines the information on the movement of the goods, including the carrier, equipment, locations and dates contained in the ASN.ASNTermsOfDelivery describes the terms of delivery for the shipment described by the ASN.ASNPaymentInstructions describes the payment instructions for the ASN, this can include cost of the goods and the cost of transport.ASNAllowancesOrCharges defines the allowances or charges for the ASN, this can include cost of the goods and the cost of transport.ASNHeaderNote contains any free-form text pertinent to the entire shipment described by the ASN or to the ASN message itself. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.ListOfStructuredNote contains one or more structured notes that allow you to provide notes that are more than a simple free-text field. such notes may include the message text, or this text may be referenced with an external identifier or a URL. An agency may be specified, and is needed in the case where an ID has been provided for a note that is either included in-line or referenced. This field is often used to include references to centrally stored clauses in contracts that are required to appear within business documents.ASNHeaderAttachments contains a list of attachments applicable to the entire ASN. The information is not specific to a information is not specific to a particular line item or package, unless specifically noted.Content: ASNBaseItemDetail , ASNLineItemListOfAllowOrCharge (Type: ListOfAllowOrCharge)? , LineItemNote (Type: string)? , ListOfStructuredNote? , LineItemAttachment (Type: ListOfAttachment)?
Description: The ASNItemDetail element contains the item detail information for the ASN.
ASNBaseItemDetail contains the identifying and descriptive information for the line items in the ASN.ASNLineItemListOfAllowOrCharge contains the line item allowance and charge information for the ASN.LineItemNote describes any free form text pertinent to the line item. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.ListOfStructuredNote contains one or more structured notes that allow you to provide notes that are more than a simple free-text field. such notes may include the message text, or this text may be referenced with an external identifier or a URL. An agency may be specified, and is needed in the case where an ID has been provided for a note that is either included in-line or referenced. This field is often used to include references to centrally stored clauses in contracts that are required to appear within business documents.LineItemAttachment contains a list of attachments applicable to the specified line item of the ASN. The information is not specific to a particular line item or package, unless specifically noted.Content: ASNItemDetail+
Description: The ListOfASNItemDetail element contains a list of line items for the ASN.
ASNItemDetail contains the item detail information for the ASN.Extends: BaseItemDetail
Description: The ASNBaseItemDetail element contains the identifying and descriptive information for the line items in the ASN.
LineItemOrderReference identifies the purchase order number at the line item level.ASNLineItemReferences describes the references at the line item level if different than the header level.ExceptionQuantities informs why the invoiced quantity is different to the ordered.ListOfDestinationRef holds a list of all the destinations for the line item.ReferenceToPackage identifies which package the line item is in.ItemShipToParty specifies the ship to address of the line item.ItemShipFromParty specifies the ship from address of the line item.Content: RouteID (Type: int) , LocationID (Type: int)
Description: The DestinationRef element holds the references for the destinations to the line item.
RouteID references the route ID in TransportRouting.LocationID holds the unique number referenced internally from line item package and detail.Content: DestinationRef+
Description: The ListOfDestinationRef element holds a list of all the destinations for the line item.
DestinationRef holds the references for the destinations to the line item.Extends: OrderNumber
Description: The ASNOrderNumber element indicates the unique number assigned to identify a purchase order.
ASNPartialOrder indicates the status of the shipment with respect to the purchase order referenced.Content: ASNPartialOrderCoded (Type: ASNPartialOrderCode) , ASNPartialOrderCodedOther (Type: string)?
Description: The ASNPartialOrder element indicates the status of the shipment with respect to the purchase order referenced.
ASNPartialOrderCoded indicates the status of the shipment with respect to the purchase order.ASNPartialOrderCodedOther is used to provide a non-standard ASNPartialOrderCode. This element is mandatory if the value of ASNPartialOrderCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the status of the shipment for the ASN message.
Value: Enumeration, including:
PurchaseOrderPurchaseOrderContent: ASNPurposeCoded (Type: ASNPurposeCode) , ASNPurposeCodedOther (Type: string)?
Description: The ASNPurpose element defines the purpose of the ASN.
ASNPurposeCoded indicates the purpose of the document.ASNPurposeCodedOther is used to provide a non-standard ASNPurposeCode. This element is mandatory if the value of ASNPurposeCoded is'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the purpose of the ASN message. This is a subset codelist derived from EDIFACT 1225 (Message Function, Coded) and X12 353 (Transaction Set Purpose Code) and 587 (Acknowledgement Type Code)
Value: Enumeration, including:
Content: ShipmentIdentifier (Type: Reference)? , PackingListNumber (Type: Reference)? , ContractNumber (Type: Reference)? , BillOfLadingNumber (Type: Reference)? , AirWaybillNumber (Type: Reference)? , ImportLicenceNumber (Type: Reference)? , ExportLicenceNumber (Type: Reference)? , LetterOfCreditNumber (Type: Reference)? , URL (Type: URI)? , TrackingInformation? , ListOfCarrierReference? , OtherASNReferences (Type: ListOfReferenceCoded)?
Description: The ASNReferences element defines the references for the ASN.
ShipmentIdentifier contains the shipper's unique identification number for identifying the shipment.PackingListNumber contains the number of the packing list for this ASN.ContractNumber contains the number of the contract.BillOfLadingNumber holds the bill of lading number for the invoice.AirWaybillNumber contains the reference to the air waybill.ImportLicenceNumber contains the reference to the import license number.ExportLicenceNumber contains the reference to the export license number.LetterOfCreditNumber contains the reference to a Letter of Credit.URL contains the reference to a URL.TrackingInformation contains the information to allow tracking of the ASN.ListOfCarrierReference contains a list of references issued by the carrier.OtherASNReferences contains all other references for the ASN not explicitly stated as the content of other elements.Content: CarrierReference+
Description: The ListOfCarrierReference element contains a list of references issued by the carrier.
CarrierReference contains the carrier reference number.Content: CarrierReferenceNumber (Type: Reference) , TransportRouteID (Type: int)
Description: The CarrierReference element contains the carrier reference number.
CarrierReferenceNumber contains the reference number issued by the carrier.TransportRouteID holds a unique identifier for this route of transport to be referenced. Intended to be use as an internal reference for the document.Content: ASNStatusCoded (Type: ASNStatusCode) , ASNStatusCodedOther (Type: string)?
Description: The ASNStatus element identifies the status of the Order/Orders that the ASN is referencing and transmitting.
ASNStatusCoded indicates the status of the Order/Orders covered by the ASN.ASNStatusCodedOther is used to provide a non-standard ASNStatusCode. This element is mandatory if the value of ASNStatusCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the status of the orders covered by the ASN message.
Value: Enumeration, including:
Content: NumberOfLines (Type: int)? , TransportPackagingTotals? , SummaryNote (Type: string)?
Description: The ASNSummary element contains the summary information of the ASN, typically totals of numerical fields.
NumberOfLines identifies the number of line items.TransportPackagingTotals summarizes the transport and packaging information if included in the ASN.SummaryNote describes any free-form text pertinent to the summary described by the ASN. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.Content: ASNTypeCoded (Type: ASNTypeCode) , ASNTypeCodedOther (Type: string)?
Description: The ASNType element identifies the type of ASN being transmitted.
ASNTypeCoded indicates the type of the ASN.ASNTypeCodedOther is used to provide a non-standard ASNTypeCode. This element is mandatory if the value of ASNTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of the ASN message.
Value: Enumeration, including:
Content: AvailabilityToPromiseResponseCoded (Type: AvailabilityToPromiseResponseCode) , AvailabilityToPromiseResponseCodedOther (Type: string)?
Description: The ATPResponse element is a container for the AvailabilityToPromise response type.
AvailabilityToPromiseResponseCoded indicates the type of response been sent in respect to the AvailabilityToPromise document.AvailabilityToPromiseResponseCodedOther is used to provide a non-standard AvailabilityToPromiseResponseCode. This element is mandatory if the value of AvailabilityToPromiseResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of response sent for the AvailabilityToPromise message.This is a subset codelist derived from EDIFACT 1229 (Action request/notification description code) and X12 670 (Change or Response Type Code)
Value: Enumeration, including:
Content: ActualPayment+
Description: The ListOfActualPayment element contains a list of information relating to payment(s) made on the invoice at the time the invoice was produced.
ActualPayment contains information relating to a payment.Content: PaymentAmount , PaymentDate (Type: datetime) , PaymentMean , PaymentRecord? , OtherPaymentInfo (Type: string)*
Description: The ActualPayment element contains detailed information on amounts, date, mean, method, card information and references relating to the ActualPayment.
PaymentAmount contains information relating to a payment.PaymentDate holds the date the payment was made.PaymentMean contains information about a particular payment method that is used.PaymentRecord contains a record of the type of payment instrument or other method used to make the payment.OtherPaymentInfo contains any free form text pertinent to the payment information. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information, holds additional information or reference information about the actual payment made.Content: InvoiceCurrencyAmt (Type: MonetaryValue) , ForeignCurrencyPayment (Type: MonetaryValue)
Description: The PaymentAmount element contains detailed information on amounts, date, mean, method, card information and references relating to the ActualPayment.
InvoiceCurrencyAmt holds the amount in the invoice currency, for this payment.ForeignCurrencyPayment holds the currency and amount if the payment was not made in the invoice currency. This element is mandatory if the payment was not made in the invoice currency.Content: PaymentMeanCoded (Type: PaymentMeanCode) , PaymentCodedMeanOther (Type: string)?
Description: The PaymentMean element contains information about a particular payment method that is used.
PaymentMeanCoded contains a valid means of extinguishing the debt to which it relates.PaymentMeanCodedOther is used to provide a non-standard PaymentMeanCode. This element is mandatory if the value of PaymentMeanCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: PaymentRef (Type: Reference)? , (CardInfo? | FITransfer?)
Description: The PaymentRecord element contains a record of the type of payment instrument or other method used to make the payment.
PaymentRef contains a reference or other code provided by the financial institution that authorizes or settled the payment that may be used to identify the payment record.CardInfo contains details of the credit or debit card that is being used for the payment.FITransfer contains details about the transfer from one financial institution to another.Content: FromFITransfer (Type: FIAccount)? , ToFITransfer (Type: FIAccount) , PaymentRecordOther (Type: string)?
Description: The FITransfer element contains details about the transfer from one financial institution to another.
FromFITransfer identifies the account and financial institution from which the transfer is to originate.ToFITransfer identifies the account and financial institution to which the transfer it to be made.PaymentRecordOther contains any free form text description or record of the payment.This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information, holds additional information or reference information about the actual payment made.Description:
This code identifies the type of card used for payment.
Value: Enumeration, including:
Content: CardNum (Type: string) , CardAuthCode (Type: string)? , CardRefNum (Type: string)? , CardExpirationDate (Type: datetime)? , CardType (Type: CardTypeCode)? , CardTypeOther (Type: string)? , CardHolderName (Type: string)?
Description: The CardInfo element contains details of the credit or debit card that is being used for the payment.
CardNum contains the identifying number of the credit or debit card.CardAuthCode contains the authorization number of the card.CardRefNum contains the customer reference number. This is used to enable transmission of customer specific information with the card.CardExpirationDate contains the date up to which the card is valid .CardType holds information on the issuer of the credit or debit card.CardTypeOther is used to provide a non-standard CardTypeCode. This element is mandatory if the value of CardType is 'Other'. These codes should not contain white space unless absolutely necessary.CardHolderName contains the name of the holder of the card.Content: ActualPaymentStatusCoded (Type: ActualPaymentStatusCode)? , ActualPaymentStatusCodedOther (Type: string)?
Description: The ActualPaymentStatus element contains information relating to the payment status of the line item.
ActualPaymentStatusCoded is a code specifying the actual status of a payment.ActualPaymentStatusCodedOther is used to provide a non-standard ActualPaymentStatusCode. This element is mandatory if the value of ActualPaymentStatusCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the actual status of a payment.
Value: Enumeration, including:
Content: AddressTypeCoded (Type: AddressTypeCode) , AddressTypeCodedOther (Type: string)?
Description: The AddressType element is the container used to specify the function of an address.
AddressTypeCoded specifies the function of the address using a standard codelist.AddressTypeCodedOther is used to provide a non-standard AddressTypeCode. This element is mandatory if the value of AddressTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of address. This codelist is derived from EDIFACT 3035 (Party Function Code Qualifier)
Value: Enumeration, including:
Content: LineItemReference (Type: int)? , AdjustmentReasonCoded (Type: AdjustmentReasonCode) , AdjustmentReasonCodedOther (Type: string)? , AdjustmentDate (Type: datetime)? , ExpectedAmount (Type: MonetaryValue)? , AdjustmentAmount (Type: MonetaryValue)? , AdjustmentPercent (Type: Decimal18_3)? , ActualAmount (Type: MonetaryValue) , AdjustmentNote (Type: string)?
Description: The Adjustment element contains the information relevant to making monetary adjustments.
LineItemReference is a reference to the line item number of the payment document from which the adjustment was made.AdjustmentReasonCoded is a reason code for adjustment.AdjustmentReasonCodedOther is used to provide a non-standard AdjustmentReasonCode. This element is mandatory if the value of AdjustmentReasonCoded is 'Other'. These codes should not contain white space unless absolutely necessary.AdjustmentDate is the date on which the adjustment was made.ExpectedAmount specifies an amount of payment expected as stated on payment document.AdjustmentAmount contains a monetary amount of adjustment.AdjustmentPercent contains a percent of adjustment.ActualAmount specifies the actual amount to be paid to the payee after adjustment.AdjustmentNote describes any free-form text pertinent to the Adjustment. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.Content: Adjustment+
Description: The ListOfAdjustments element contains a set of one or more adjustment details.
Adjustment contains the information relevant to making monetary adjustments.Description:
This code identifies the reason for adjustment. This codelist is derived from EDIFACT 4465 (Adjustment reason description code)
Value: Enumeration, including:
Content: ASNHeader , ASNDetail? , ASNSummary?
Description: The AdvanceShipmentNotice element (ASN) comprises the notification by a supplier to the buyer of a shipment. The shipment can be for planning or serve as a notice of a shipment in progress. Therefore it is not necessary for a supplier to provide a preliminary notice of shipment, nor is it necessary for a supplier to send an actual note of shipment. Actual tracking of freight will initially be handled by the shipper directly and not via the ASN. Buyers can respond to the ASN with an ASN Error document that will be created at a later date.
ASNHeader contains the header information of the ASN..ASNDetail contains line item and package details of the ASN.ASNSummary contains the summary information of the ASN, typically totals of numerical fields.Content: AgencyCoded (Type: AgencyCode) , AgencyCodedOther (Type: string)? , AgencyDescription (Type: string)? , CodeListIdentifierCoded (Type: CodeListIdentifierCode)? , CodeListIdentifierCodedOther (Type: string)?
Description: The Agency element identifies the organization and if necessary the codelist from which the identifier is assigned.
AgencyCoded specifies the agency, company or organization responsible for issuing the codelist or identifiers.AgencyCodedOther is used to provide a non-standard AgencyCode. This element is mandatory if the value of AgencyCoded is 'Other'. These codes should not contain white space unless absolutely necessary.AgencyDescription describes additional information needed to clarify the identification of the agency.CodeListIdentifierCoded contains a code qualifying the type of code list used.CodeListIdentifierCodedOther is used to provide a non-standard CodeListIdentifierCode. This element is mandatory if the value of CodeListIdentifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Agency+
Description: The ListOfAgency element contains the details on one or more agencies.
Agency identifies the organization and if necessary the codelist from which the identifier is assigned.Description:
This code identifies the agency responsible for a codelist. This codelist is derived from EDIFACT 3055 (Code list responsible agency code) and X12 559 (Agency Qualifier Code)
Value: Enumeration, including:
Content: IndicatorCoded (Type: IndicatorCode) , IndicatorCodedOther (Type: string)? , BasisCoded (Type: BasisCode)? , BasisCodedOther (Type: string)? , MethodOfHandlingCoded (Type: MethodOfHandlingCode) , MethodOfHandlingCodedOther (Type: string)? , AllowanceOrChargeDescription (Type: AllowOrChgDesc) , ValidityDates? , (BasisQuantityRange (Type: Quantity) | BasisMonetaryRange)? , TypeOfAllowanceOrCharge , Tax*
Attribute: Name: SeqNo - Data Type: int - Default Value: "1"Description: The AllowOrCharge element requests or identifies a service, promotion, allowance, or charge and specifies the amount or percentage for the service, promotion, allowance, or charge.
IndicatorCoded identifies whether an allowance or a charge applies using a standard codelist. Allowances are considered to be discounts.IndicatorCodedOther is used to provide a non-standard IndicatorCode. This element is mandatory if the value of IndicatorCoded is 'Other'. These codes should not contain white space unless absolutely necessary.BasisCoded defines on what basis the allowance or charge is calculated using a standard codelist.BasisCodedOther is used to specify a non-standard BasisCode. This element is mandatory when the value of BasisCoded is 'Other'. These codes should not contain white space unless absolutely necessary.MethodOfHandlingCoded identifies how the allowance or charge will be settled using a standard codelist.MethodOfHandlingCodedOther is used to specify a non-standard MethodOfHandlingCode. This element is mandatory if the value of MethodOfHandlingCoded is 'Other'. These codes should not contain white space unless absolutely necessary.AllowanceOrChargeDescription describes the allowance or charge using references or free text.ValidityDates contains the dates between which the allowance or charge takes effect.BasisQuantityRange is the quantity range over which the allowance or charge applies.BasisMonetaryRange is the monetary range over which the allowance or charge applies.TypeOfAllowanceOrCharge is a container for the information on the type of Allowance or Charge. Only one method of calculating the allowance or charge can be specified.Tax is a container for tax levies on the allowance or charge if applicable.SeqNo is the calculations sequence indicator and is used when multiple allowances and/or charges are applicable. If various allowances and/or charges percentages, quantities, monetary amounts or rates are applicable to the same base price, then the calculation sequence indicator will always equal one. If the various allowances and/or charges are applied against a fluctuating price (constantly changing because of the application of other allowances and/or charges) then the sequence of calculation is indicated using this data element. Note that several allowances or charges may have the same sequence number, indicating they are applied to the same quantity.Description:
This code specifies the basis the allowance or charge is calculated.
Value: Enumeration, including:
Content: PercentQualifier , Percent (Type: Decimal10_4) , PercentageMonetaryValue (Type: MonetaryValue)?
Description: The PercentageAllowanceOrCharge element specifies the allowance or charge based on a percentage.
PercentQualifier contains information on how the percentage is calculated.Percent is the percentage of the charge.PercentageMonetaryValue is the value of the percentage allowance or charge.Content: PercentQualifierCoded (Type: PercentQualifierCode) , PercentQualifierCodedOther (Type: string)?
Description: The PercentQualifier element contains information on how the percentage is calculated.
PercentQualifierCoded defines what the percentage is calculated against using a standard codelist.PercentQualifierCodedOther is used to provide a non-standard PercentQualifierCode This element is mandatory when the value of PercentQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies how a percentage is calculated. This code list is derived from X12 378 (Allowance or Charge Percent Qualifier)
Value: Enumeration, including:
Content: Quantity , Rate , QuantityMonetaryValue (Type: MonetaryValue)?
Description: The QuantityAllowanceOrCharge element specifies the allowance or charge where the calculation is based on quantity.
Quantity is the quantity of the allowance or charge.Rate specifies the rate that the allowance or charge is calculated on.QuantityMonetaryValue is the monetary amount of the allowance or charge.Content: RatePerUnit (Type: UnitPrice) , UnitPriceBasis (Type: Decimal18_3) , UnitOfMeasurement?
Description: The Rate element specifies the rate that the allowance or charge is calculated on.
RatePerUnit identifies the monetary value of the rate.UnitPriceBasis identifies the basis on which the price/rate applies.UnitOfMeasurement specifies the unit of measure of rate.Content: AllowOrCharge+
Description: The ListOfAllowOrCharge element contains one or more services, promotions, allowances or charges.
AllowOrCharge requests or identifies a service, promotion, allowance, or charge and specifies the amount or percentage for the service, promotion, allowance, or charge.Content: QuantityAllowanceOrCharge | PercentageAllowanceOrCharge | MonetaryValue
Description: The TypeOfAllowanceOrCharge element is a container for the information on the type of allowance or charge. Only one method of calculating the allowance or charge can be specified.
QuantityAllowanceOrCharge specifies the allowance or charge where the calculation is based on quantity.PercentageAllowanceOrCharge specifies the allowance or charge based on a percentage.MonetaryValue is the monetary amount of the allowance or charge when charged as a lump sum.Content: AllowOrChargeTreatmentCoded (Type: AllowOrChargeTreatmentCode)? , AllowOrChargeTreatmentCodedOther (Type: string)?
Description: The AllowOrChargeTreatment element contains information relating to the treatment of the allowance or charge.
AllowOrChargeTreatmentCoded is a code specifying the basis of the line item-level AllowOrCharge, and whether the amounts are net or gross of AllowOrCharge.AllowOrChargeTreatmentCodedOther is used to provide a non-standard AllowOrChargeTreatmentCode. This element is mandatory if the value of AllowOrChargeTreatmentCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the basis for the calculation of the allowance or charge at line item level.
Value: Enumeration, including:
Content: RefID (Type: string)? , ListOfDescription? , ServiceCoded (Type: ServiceCode) , ServiceCodedOther (Type: string)?
Description: The AllowOrChgDesc element describes the allowance or charge using references or free text.
RefID is a code number known to the supplier that identifies the charge or allowance.ListOfDescription is Description of the reference or charge.ServiceCoded identifies a type of service using a standard codelist.ServiceCodedOther is used to provide a non-standard ServiceCode This element is mandatory when the value of ServiceCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: AttachmentPurpose (Type: string) , FileName (Type: string)? , AttachmentTitle (Type: string)? , AttachmentDescription (Type: string)? , Language? , MIMEType (Type: string)? , ReplacementFile (Type: boolean)? , AttachmentLocation (Type: URI)
Description: The Attachment element is a container for specifying the attachments to a document.
AttachmentPurpose explains the reason or purpose for attaching the message to the document or its intended use.FileName provides name of the attached file.AttachmentTitle displays the title of the attached document.AttachmentDescription describes the attachment.Language denotes the language the attachment is written in.MIMEType describes the format of the attachment.ReplacementFile indicates whether it is a replacement attachment or not. If value is not supplied than it is assumed this value is original.AttachmentLocation identifies the location of the attachment to the document.Content: Attachment+
Description: The ListOfAttachment element is container that holds one or more Attachment elements.
Attachment is a container for specifying the attachments to a document.Content: EnumeratedValue (Type: string)*
Attribute: Name: ScalarType - Data Type: ScalarTypeCode - Default Value: "String"Description: The AttributeType element provides the data type of the category's attribute. Has ScalarType enumerated attribute that indicates whether this data value is a String, an Integer, a Numeric value (such as a floating point number), a Currency (an ISO Currency Code), a Date, or an Enumeration. If an Enumeration, AttributeType has a set of subelements called EnumeratedValue which list the values of the enumeration. Also optionally has MaxSize attribute which indicates the maximum length of the string in characters.
EnumeratedValue provides a single, allowable value in an enumeration of such values.ScalarType identifies the datatype of the value. If not present, applications should default to the "String" value.MaxSize indicates the maximum length of the string in characters.Description:
This code identifies a datatype.
Value: Enumeration, including:
Content: AuctionCategoryName (Type: string) , AuctionCategoryLevel (Type: int)
Description: The AuctionCategory element is used to further classify the category of the item to be auctioned. This is predefined by the environment integrator. At least two category levels are required.
AuctionCategoryName identifies the name of the category.AuctionCategoryLevel identifies the sub-category level of the category.Content: AuctionCategory2,*
Description: The ListOfAuctionCategory element contains a 2 or more auction categories used to define and further classify the object to be auctioned. This structure requires that at least a single category and one sub-category is defined.
EXAMPLE:
AuctionName = MyComputerAuction
CategoryName = Computer
CategoryLevel = 1
CategoryName = ACME Computer
CategoryLevel = 2
AuctionCategory is used to further classify the category of the item to be auctioned. This is predefined by the environment integrator. At least two category levels are required.Content: AuctionCreateHeader , ListOfAuctionCreateDetail , AuctionCreateSummary
Description: The AuctionCreate element is used when the user wants to create a new auction. It contains all the header, detail and summary level information.
AuctionCreateHeader contains the auction create header-level information. This element occurs once within the document.ListOfAuctionCreateDetail contains the line level detail information for the AuctionCreate document.AuctionCreateSummary summarizes the AuctionCreate document.Content: AuctionCreateDetail+
Description: The ListOfAuctionCreateDetail element contains the line level detail information for the AuctionCreate document.
AuctionCreateDetail contains all details relevant to an auction item. This can be used to describe a single item to be auctioned or an aggregate part which is composed of sub-items to be detailed in the ListOfAuctionItemComponents structure.This extends AuctionDetail with ListOfAuctionItemComponents.
Content: AuctionItem , ListOfMVBVariables? , AuctionPricingDetail? , AuctionItemDates (Type: OrderDates)? , AuctionDeliveryDetail (Type: DeliveryDetail)? , ListOfAttachment? , ComponentAuctionIndicator (Type: boolean)
Description: The AuctionDetail element contains all details relevant to an auction item. This can be used to describe a single item to be auctioned or an aggregate part which is composed of sub-items to be detailed in the ListOfAuctionItemComponents structure.
AuctionItem contains all details relevant to the auction item. This includes the ID, name description as well as the part number and quantity data. The required elements include the AuctionItemID, ListOfAuctionCategory, and Quantity information.ListOfMVBVariables contains a list of MVBVariable values which are the user defined parameters in a manually determined auction. This element exists in the document only if the MVBTemplate value has been previously set up by the auction originator. The BidRule must be selected as MVBForward or MVBReverse and an MVBTemplate must be given.AuctionPricingDetail identifies details of the pricing associated with the auction.AuctionItemDates contains a list of the pertinent dates for the Auction Result dates include validity dates, RequestedShipDate, RequestedDelivery, CancelByDates, etc.AuctionDeliveryDetail is the delivery information for the line item; includes scheduling, transport, delivery terms and basic packaging information for the line item. Note: Transport and delivery terms are only used if they differ from the information provided in the header.ListOfAttachment holds a list of attachments to a document that contain information relating to the document.ComponentAuctionIndicator indicates whether or not the components of the auction item are to be bid upon separately.True: participants can bid on the components separately
False: participants can not bid on the components separately
Extends: AuctionDetail
Description: The AuctionCreateDetail element contains all details relevant to an auction item. This can be used to describe a single item to be auctioned or an aggregate part which is composed of sub-items to be detailed in the ListOfAuctionItemComponents structure.
This extends AuctionDetail with ListOfAuctionItemComponents.
ListOfAuctionItemComponents contains a list of components that are associated with the auction item.Content: AuctionItemComponent (Type: AuctionCreateDetail)+
Description: The ListOfAuctionItemComponents element contains a list of components that are associated with the auction item.
AuctionItemComponent contains all details relevant to the components within an auction item. This can be used to describe a single item to be auctioned or an aggregate part which is composed of sub-items to be described in the ListOfAuctionItemComponents structure.This is a recursive definition within the AuctionCreateDetail structure.
Content: AuctionCreatePurpose (Type: Purpose) , AuctionCreateIssueDate (Type: datetime) , AuctionCreateID (Type: AlphaNum40) , FowardAuctionIndicator (Type: boolean) , AuctionValidityDates (Type: ValidityDates) , DecisionDate (Type: datetime)? , RulesProfile , AuctionCurrency? , AuctionParticipants , ListOfReferenceCoded? , Language , AuctionCreateGeneralNotes (Type: string)? , AuctionCreatListOfAttachment (Type: ListOfAttachment)? , AuctionSpecifications?
Description: The AuctionCreateHeader element contains the auction create header-level information. This element occurs once within the document.
AuctionCreatePurpose indicates the intended use of the AuctionCreate document.If the purpose is to cancel or end an AuctionCreate, then only the header is sent.
AuctionCreateIssueDate indicates the date the AuctionCreate document is transmitted.AuctionCreateID contains the external GUID or unique value to identify the document.FowardAuctionIndicator indicates the direction of the auction.AuctionValidityDates defines the validity period of the AuctionCreate. This element contains a StartDate and an EndDate. Both fields are mandatory and of type datetime.DecisionDate indicates the date by when a decision will be made. This is always later than the end date. This will not be supported in the early version of the bid process.RulesProfile contains all the rules associated with the auction.AuctionCurrency contains all currency details relevant to the auction.AuctionParticipants contains detailed information on all parties participating or involved in the auction.ListOfReferenceCoded contains one or more elements containing information that can be used to find further information elsewhere that are not explicitly stated in another element.Language denotes the language the attachment is written in.AuctionCreateGeneralNotes contains general notes and instructions for the AuctionCreate document.AuctionCreatListOfAttachments contains the list of attachments for the AuctionCreate document.AuctionSpecifications contains specifications to define the AuctionCreate document. This includes the AuctionCreateName, AuctionType, AuctionStatus, and PartialBidIndicator.Content: AuctionCreateResponseHeader , ListOfAuctionCreateResponseDetail? , AuctionCreateResponseSummary (Type: AuctionCreateSummary)
Description: The AuctionCreateResponse element provides information and status related to the request to create an auction via the AuctionCreate message.
AuctionCreateResponseHeader contains the header level information of the AuctionCreateResponse. This element occurs once within the document.ListOfAuctionCreateResponseDetail contains a list a list of AuctionCreateResponseDetail data. This is element optional.AuctionCreateResponseSummary contains summary level information pertinent to the AuctionCreateResponse document.Content: AuctionItemID (Type: AlphaNum40) , AuctionItemName (Type: AlphaNum50) , AuctionItemDescription (Type: string)? , AuctionItemHierarchyLevel (Type: int) , AuctionLineItemNum (Type: int)? , AuctionItemResponseCoded (Type: AuctionItemResponseCode) , AuctionItemResponseCodedOther (Type: string)? , ChangedAuctionCreateDetail (Type: AuctionDetail)? , ListOfAuctionItemComponentResponse?
Description: The AuctionCreateResponseDetail element contains a detail level relevant data for the AuctionCreateResponse document.
AuctionItemID contains the external GUID to identify the AuctionItem in the case that multiple auctions are defined within this document.AuctionItemName contains a user defined name of the item to be auctioned.AuctionItemDescription contains a text description to further describe the auction item.AuctionItemHierarchyLevel contains the level or sub-level counter to identify the component hierarchy level. For example, a computer is being auctioned. The CPU is a component of the computer. A hard-drive is a component of the CPU. Thus, the AuctionItemHierarchyLevel values are defined as follows: computer = level 1; CPU = level 2;hard drive = level 3.AuctionLineItemNum contains the line item number of the item to be auctioned.AuctionItemResponseCoded contains the error codes for the individual line of the AuctionCreate details.AuctionItemResponseCodedOther is a non-standard or user defined response code.ChangedAuctionCreateDetail contains the AuctionDetail structure to allow the sender of the response document to echo back the original structure or send a copy with the appropriate changes to the detail structure.ListOfAuctionItemComponentResponse contains the response details for the components of the auction item. This is a recursive structure.Content: AuctionCreateResponseDetail+
Description: The ListOfAuctionCreateResponseDetail element contains a list a list of AuctionCreateResponseDetail data. This is element optional.
AuctionCreateResponseDetail contains a detail level relevant data for the AuctionCreateResponse document.Content: AuctionItemComponentResponse (Type: AuctionCreateResponseDetail)+
Description: The ListOfAuctionItemComponentResponse element contains the response details for the components of the auction item. This is a recursive structure.
AuctionItemComponentResponse contains detail level relevant data for communicating response information AuctionCreateResponse document.Content: AuctionCreateResponsePurpose (Type: Purpose) , AuctionCreateResponseIssueDate (Type: datetime) , AuctionCreateResponseID (Type: AlphaNum40) , AuctionCreateReference (Type: Reference) , AuctionResponseCoded (Type: BasicResponseCode) , AuctionResponseCodedOther (Type: string)? , ChangedAuctionCreateHeader (Type: AuctionCreateHeader)? , Language , AuctionCreateResponseNote (Type: string)?
Description: The AuctionCreateResponseHeader element contains the header level information of the AuctionCreateResponse. This element occurs once within the document.
AuctionCreateResponsePurpose indicates the intended use of the AuctionCreateResponse document.AuctionCreateResponseIssueDate indicates the date the AuctionCreate document is transmitted.AuctionCreateResponseID contains a GUID or unique identifier to for the AuctionCreateResponse document.AuctionCreateReference contains a reference to the original AuctionCreate document. This is the GUID or unique value used to identify the AuctionCreate document.AuctionResponseCoded contains the header level acknowledgment code to be sent in response to the AuctionCreate document.AuctionResponseCodedOther is a non-standard AuctionCreateErrorCode.ChangedAuctionCreateHeader contains the AuctionCreateHeader structure to allow the sender of the response document to echo back the original structure or else send a copy with the appropriate changes to the header structure.Language denotes the language the attachment is written in.AuctionCreateResponseNote contains any free-form text pertinent to the entire AuctionCreateResponseHeader. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.Content: TotalNumberOfAuctionItems (Type: int)? , TotalNumberOfParticipants (Type: int)?
Description: The AuctionCreateSummary element summarizes the AuctionCreate document.
TotalNumberOfAuctionItems contains the total number of line items for message.TotalNumberOfParticipants contains the total number of auction participants.Content: BaseCurrency (Type: Currency) , ListOfValidBidCurrency?
Description: The AuctionCurrency element contains all currency details relevant to the auction.
BaseCurrency indicates the currency of the initiator of the auction.ListOfValidBidCurrency lists all the valid currencies in which an auction partner can use to bid in this auction.Content: ValidBidCurrency+
Description: The ListOfValidBidCurrency element lists all the valid currencies in which an auction partner can use to bid in this auction.
ValidBidCurrency describes a valid bid currency in terms of a currency code and a FX rate.Content: BidCurrency (Type: Currency) , RateOfExchangeDetail?
Description: The ValidBidCurrency element describes a valid bid currency in terms of a currency code and a FX rate.
BidCurrency contains the bid currency. This is an ISO currency code list.RateOfExchangeDetail contains the detail of the exchange rate between two currencies.Content: AuctionItemID (Type: AlphaNum40) , AuctionItemName (Type: AlphaNum50) , AuctionItemDescription (Type: string)? , ListOfAuctionCategory , ListOfAuctionItemAttribute? , AuctionItemHierarchyLevel (Type: int) , AuctionLineItemNum (Type: int)? , AuctionQuantity (Type: Quantity) , PartialBidIndicator (Type: boolean)? , PartNumbers?
Description: The AuctionItem element contains all details relevant to the auction item. This includes the ID, name description as well as the part number and quantity data. The required elements include the AuctionItemID, ListOfAuctionCategory, and Quantity information.
AuctionItemID contains the external GUID to identify the AuctionItem in the case that multiple auctions are defined within this document.AuctionItemName contains a user defined name of the item to be auctioned.AuctionItemDescription contains a text description to further describe the auction item.ListOfAuctionCategory contains a list of AuctionCategories used to define and further classify the object to be auctioned. This structure requires that at least a single category and one sub-category is defined.EXAMPLE:
AuctionName = MyComputerAuction
CategoryName = Computer
CategoryLevel = 1
CategoryName = ACME Computer
CategoryLevel = 2
ListOfAuctionItemAttribute contains a list of user defined attributes that can be used to further describe or categorize the auction item.AuctionItemHierarchyLevel contains the level or sub-level counter to identify the component hierarchy level. For example, a computer is being auctioned. The CPU is a component of the computer. A hard-drive is a component of the CPU. Thus, the AuctionItemHierarchyLevel values are defined as follows.computer = level 1
CPU = level 2
hard drive = level 3
AuctionLineItemNum contains the line item number of the item to be auctioned.AuctionQuantity contains the total quantity of items to be auctioned.PartialBidIndicator indicates whether or not the initiator of the auction will accept partial quantity bids for the auctioned item. The assumption is made that the default value is true if the PartialBidIndicator is not provided.True: partial quantity bids accepted
False: partial quantity bids are not accepted
PartNumbers identifies all identification numbers for the item.Content: AuctionAttributeName (Type: string) , AuctionAttributeDescription (Type: string)? , AuctionAttributeDataTypeCoded (Type: DataTypeCode) , AuctionAttributeDataTypeCodedOther (Type: string)? , ListOfValues? , AuctionAttributeFieldSize (Type: int)? , RequiredIndicator (Type: boolean) , AuctionAttributeDefaultValue (Type: string)?
Description: The AuctionItemAttribute element contains a user defined attribute that is used to further describe or categorize the auction item.
AuctionAttributeName contains the name of the auction item attribute.AuctionAttributeDescription contains a description of the auction item attribute.AuctionAttributeDataTypeCoded contains a coded list specifying the data type of the auction item attribute.AuctionAttributeDataTypeCodedOther is used to provide a non-standard AuctionAttributeDataTypeCode. This element is mandatory if the value of AuctionAttributeDataTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfValues contains a list of name value pairs to be specified if the data type is ListOfValues.AuctionAttributeFieldSize specifies the field size for the auction attribute.RequiredIndicator specifies if the attribute value is required.True: Attribute is required
False: Attribute is optional
AuctionAttributeDefaultValue contains the default value of the auction attribute.Content: AuctionItemAttribute+
Description: The ListOfAuctionItemAttribute element contains a list of user defined attributes that can be used to further describe or categorize the auction item.
AuctionItemAttribute contains a user defined attribute that is used to further describe or categorize the auction item.Content: NameValuePair+
Description: The ListOfValues element contains a list of name value pairs to be specified if the data type is ListOfValues.
NameValuePair contains a generic name and value.Description:
This code identifies errors for the individual line of the ActionCreateDetail.
Value: Enumeration, including:
Content: InitiatingParty (Type: Party) , CommunityID (Type: string)? , ListToInform (Type: ListOfParty)? , ListOfAuctionPartners
Description: The AuctionParticipants element contains detailed information on all parties participating or involved in the auction.
InitiatingParty contains detailed information on the partner or user initiating the AuctionCreate document.CommunityID contains a community identifier. The community identifier is used to describe a set of trading partners.ListToInform contains the list of trading partners to be informed of various activities associated with the auction.ListOfAuctionPartners contains the list of trading partners participating in the auction.Content: AuctionPartners+
Description: The ListOfAuctionPartners element contains the list of trading partners participating in the auction.
AuctionPartners contains information to identify the trading partners participating in the auction.Extends: Party
Description: The AuctionPartners element contains information to identify the trading partners participating in the auction.
GroupIndicator indicates whether or not the auction partner listed is an individual or a group.True: auction partner is a group
False: auction partner is an individual
ListOfKeyVal is a container for specifying key word and value pairs.Content: OpenPrice (Type: Decimal18_3) , ReservePrice (Type: Decimal18_3)? , BidIncrement (Type: Decimal18_3)? , ListOfPrice?
Description: The AuctionPricingDetail element identifies details of the pricing associated with the auction.
OpenPrice contains the minimal bid price for the auction.ReservePrice contains the minimal bid price for which the initiator of the auction is willing to accept a winner.BidIncrement contains the minimum valid bid increment for auction participants.ListOfPrice contains one or more pricing schemes.Content: AuctionResultHeader , ListOfAuctionResultDetail , AuctionResultSummary
Description: The AuctionResult element is used to call for the results of the auction. This element occurs once within the document.
AuctionResultHeader contains all the auction result header-level information. This element occurs once within the document.ListOfAuctionResultDetail contains a list of AuctionReponseDetail which includes the results from the auction.AuctionResultSummary contains summary information pertinent to the AuctionResult.Content: AuctionResultItemID (Type: Reference) , WinningBidIndicator (Type: boolean) , AuctionResultParty (Type: OrderParty) , AuctionResultDates (Type: OrderDates)? , AuctionResultCurrency (Type: Currency)? , ListOfAuctionResultItem , AuctionResultDetailNotes (Type: string)? , ListOfAuctionResultDetailAttachment (Type: ListOfAttachment)?
Description: The AuctionResultDetail element contains the results from the auction. The AuctionResultDetail includes details of the winning bids from auction participants.
AuctionResultItemID contains a unique identifier assigned by the auction participant to reference their auction result document (bid).WinningBidIndicator indicates whether the specified auction result is a winning bid.True: Winning bid
False: Not a winning bid
AuctionResultParty specifies all parties relevant for an order/invoice document. The BuyerParty and SellerParty are required in this structure. All other parties specified are optional. In a forward auction, the SellerParty is the originator of the auction while the BuyerParty is a participant in the auction. In a reverse auction, the roles are switched.AuctionResultDates contains a list of dates which are pertinent to processing an order transaction. The values include validity dates, RequestedShipDate, CancelByDates, etc.AuctionResultCurrency contains the currency of the auction result.ListOfAuctionResultItem contains a list of auction line item details.AuctionResultDetailNotes contains a general note field to store information relevant to an AuctionResult.ListOfAuctionResultDetailAttachment contains a list of attachments relevant to the AuctionResult.Content: AuctionResultDetail+
Description: The ListOfAuctionResultDetail element contains a list of AuctionReponseDetail which includes the results from the auction.
AuctionResultDetail contains the results from the auction. The AuctionResultDetail includes details of the winning bids from auction participants.Content: AuctionResultItem+
Description: The ListOfAuctionResultItem element contains a list of auction line item details.
AuctionResultItem contains all the line item details for the auction result document from a given auction participant. This extends ItemDetails with ListMVBVariable.Extends: ItemDetail
Description: The AuctionResultItem element contains all the line item details for the auction result document from a given auction participant. This extends ItemDetails with ListMVBVariable.
ListOfMVBVariables contains a list of MVBVariable values which are the user defined parameters in a manually determined auction. This element exists in the document only if the MVBTemplate value has been previously set up by the auction originator. The RulesProfiles must reflect that fact that the auction is an MVBForward or MVBReverse and an MVBTemplate value must be given.Content: AuctionResultPurpose (Type: Purpose) , AuctionResultIssueDate (Type: datetime) , AuctionResultID (Type: Reference) , AuctionCreateReference (Type: Reference) , ForwardAuctionIndicator (Type: boolean) , InitiatingParty (Type: Party)? , Language , ListOfReferenceCoded? , AuctionResultListOfAttachment (Type: ListOfAttachment)? , AuctionResultGeneralNote (Type: string)?
Description: The AuctionResultHeader element contains all the auction result header-level information.
AuctionResultPurpose indicates the intended use of the AuctionResult document.AuctionResultIssueDate indicate the date the AuctionResult document is created.AuctionResultID Contains a GUID or unique identifier for the AuctionResult document.AuctionCreateReference contains the external GUID to identify the process. This correlates to the original AuctionCreateID.ForwardAuctionIndicator is the boolean indicator to identify whether the original auction create was a forward or reverse auction.True: forward
False: reverse
InitiatingParty contains detailed information on the partner or user initiating the AuctionCreate.Language denotes the language the attachment is written in.ListOfReferenceCoded contains one or more elements containing information that can be used to find further information elsewhere that are not explicitly stated in another element.AuctionResultListOfAttachment contains a list of attachments for the AuctionResult.AuctionResultGeneralNote contains general notes and instructions for the AuctionCreate document.Content: AuctionResultResponseHeader
Description: The AuctionResultResponse element is used to respond to a document calling for the result of the auction. The auction initiator can send the AuctionResultResponse to communicate status of the AuctionResult receipt.
AuctionResultResponseHeader contains all the auction result response header-level information. This element occurs once within the document.Description:
This code identifies the returned response from the AuctionResult message.
Value: Enumeration, including:
Content: AuctionResultResponsePurpose (Type: Purpose) , AuctionResultResponseIssueDate (Type: datetime) , AuctionResultResponseID (Type: string) , AuctionCreateReference (Type: Reference) , AuctionResultReference (Type: Reference)? , AuctionResultResponseCoded (Type: AuctionResultResponseCode) , AuctionResultResponseCodedOther (Type: string)? , Language , GeneralNote (Type: string)?
Description: The AuctionResultResponseHeader element contains all the auction result response header-level information. This element occurs once within the document.
AuctionResultResponsePurpose indicates the intended use of the AuctionResultResponse.AuctionResultResponseIssueDate indicates the date the AuctionResult document is transmitted.AuctionResultResponseID contains a unique identifier to for the AuctionResult Response document.AuctionCreateReference contains a reference to the original.AuctionResultReference contains a reference to the original AuctionResult document.AuctionResultResponseCoded contains the returned response code from the AuctionResult document.AuctionResultResponseCodedOther is non-standard or user defined AuctionResultResponseCode.Language denotes the language the attachment is written in.GeneralNote is used to provide a note in text form if desired.Content: TotalNumAuctionResults (Type: int)? , TotalNumWinningBids (Type: int)? , TotalNumParticipants (Type: int)?
Description: The AuctionResultSummary element contains summary information pertinent to the AuctionResult.
TotalNumAuctionResults contains the total number of auction results. This is the total number of bids that are returned to the initiator of the auction.TotalNumWinningBids contains the total number of winning bids sent.TotalNumParticipants contains the total number of participants actively bidding in the auction.Content: AuctionCreateName (Type: string)? , AuctionType (Type: string)? , AuctionStatus (Type: string)? , PartialBidIndicator (Type: boolean)?
Description: The AuctionSpecifications element contains specifications to define the AuctionCreate document. This includes the AuctionCreateName, AuctionType, AuctionStatus, and PartialBidIndicator.
AuctionCreateName contains the name of the AuctionCreate. This name can be the same as the AuctionItemName if the auction contains only a single item.AuctionType contains an optional string field to further describe the AuctionCreate by specifying a type.AuctionStatus indicates the current status of the auction. Values for this field can include Open, Active, Closed, etc.PartialBidIndicator indicates whether or not the initiator of the auction will accept partial quantity bids for the auctioned item. The assumption is made that the default value is true if the PartialBidIndicator is not provided.True: partial quantity bids accepted
False: partial quantity bids are not accepted
If the PartialBidIndicator is specified at the header level, then it applies to the entire auction. Line level PartialBidIndicator declarations will override the values specified at the header level.
Content: AvailabilityCheckRequestHeader , AvailabilityCheckRequestDetail? , AvailabilityCheckRequestSummary?
Description: The AvailabilityCheckRequest element contains a request to check the availability of a specified list of items. All items in the list are offered by a single supplier to a single buyer account.
AvailabilityCheckRequestHeader holds reference dates, supplier and buyer information, and any special notes associated with the AvailabilityCheckRequest. This element occurs once within the document.AvailabilityCheckRequestDetail contains the line item detail information for the AvailabilityCheckRequest.AvailabilityCheckRequestSummary contains summary information of the AvailabilityCheckRequest, typically totals of numerical fields.Content: ListOfAvailabilityCheckRequestItemDetail
Description: The AvailabilityCheckRequestDetail element contains the line item detail information for the AvailabilityCheckRequest.
ListOfAvailabilityCheckRequestItemDetail contains a list of the line items for the AvailabilityCheckRequest.Extends: BaseItemDetail
Description: The AvailabilityCheckRequestBaseItemDetail element contains the identifying and descriptive information for the line items in AvailabilityCheckRequest.
AvailabilityCheckRequestTransport contains transport information for the line item.Content: AvailabilityCheckRequestID (Type: Reference) , AvailabilityCheckRequestIssueDate (Type: datetime) , SupplierParty (Type: Party) , SupplierIDReferenceDate (Type: datetime)? , BuyerParty (Type: Party) , BuyerIDReferenceDate (Type: datetime)? , AvailabilityShipToParty (Type: Party) , AvailabilityCheckRequestLanguage (Type: Language)? , AvailabilityCheckRequestNote (Type: string)? , RequestListOfAttachment (Type: ListOfAttachment)?
Description: The AvailabilityCheckRequestHeader element holds reference dates, supplier and buyer information, and any special notes associated with the AvailabilityCheckRequest. This element occurs once within the document.
AvailabilityCheckRequestID contains a reference number to identify the AvailabilityCheckRequest document.AvailabilityCheckRequestIssueDate indicates the date the AvailabilityCheckRequest is transmitted.SupplierParty holds information relating to the supplier who is the receiver of the AvailabilityCheckRequest.SupplierIDReferenceDate holds the date of the supplier ID reference.BuyerParty holds information relating to the buyer who is the initiator of the AvailabilityCheckRequest. This includes unique ID's and address information.BuyerIDReferenceDate holds the date of the buyer ID reference.AvailabilityShipToParty holds the address details of the delivery party. If different delivery parties are involved in this request then they will be specified at the line item level within the detail section of the AvailabilityCheckRequest.AvailabilityCheckRequestLanguage identifies the language for the AvailabilityCheckRequest.AvailabilityCheckRequestNote contains any free-form text pertinent to the entire AvailabilityCheckRequest. This element may contain notes or any other similar information that is not contained explicitly in another structure. It should not be assume that the receiving application is capable of doing more than storing and/or displaying this information.RequestListOfAttachment contains a list of attachments applicable to the entire AvailabilityCheckRequest. The information is not specific to a particular line item unless specifically noted.Content: AvailabilityCheckRequestBaseItemDetail , GeneralLineItemNote (Type: string)? , LineItemAttachment (Type: ListOfAttachment)?
Description: The AvailabilityCheckRequestItemDetail element contains the item detail for the AvailabilityCheckRequest.
AvailabilityCheckRequestBaseItemDetail contains the identifying and descriptive information for the line items in AvailabilityCheckRequest.GeneralLineItemNote describes any free-form text pertinent to the line item described by the AvailabilityCheckRequest. This element may contain notes or any other information that is not contained explicitly in another structure. It should not be assumed that the receiving application is capable of doing any more than storing and/or displaying this information.LineItemAttachment contains details of the attachments for the line item.Content: AvailabilityCheckRequestItemDetail+
Description: The ListOfAvailabilityCheckRequestItemDetail element contains a list of the line items for the AvailalbilityCheckRequest.
AvailabilityCheckRequestItemDetail contains the item detail for the AvailabilityCheckRequest.Content: TotalNumberOfLineItem (Type: int)?
Description: The AvailabilityCheckRequestSummary element contains summary information of the AvailabilityCheckRequest, typically totals of numerical fields.
TotalNumberOfLineItem contains the total number of line items in the AvailabilityCheckRequest.Content: AvailabilityCheckResultHeader , AvailabilityCheckResultDetail? , AvailabilityCheckResultSummary?
Description: The AvailabilityCheckResult element is the element containing the resulting response to an AvailabilityCheckRequest for specific supplier items.
AvailabilityCheckResultHeader holds reference dates, supplier and buyer information, and any special notes associated with the AvailabilityCheckResult. This element occurs once within the document.AvailabilityCheckResultDetail contains the line item detail information for the AvailabilityCheckResult.AvailabilityCheckResultSummary contains summary information of the AvailabilityCheckResult including total number of line items.Content: ListOfAvailabilityCheckResultItemDetail
Description: The AvailabilityCheckResultDetail element contains the line item detail information for the AvailabilityCheckResult.
ListOfAvailabilityCheckResultItemDetail contains a list of line items for the AvailabilityCheckResult.Content: AvailabilityCheckResultID (Type: Reference) , AvailabilityCheckResultIssueDate (Type: datetime) , SupplierParty (Type: Party) , SupplierIDReferenceDate (Type: datetime)? , BuyerParty (Type: Party) , BuyerIDReferenceDate (Type: datetime)? , AvailabilityShipToParty (Type: Party) , AvailabilityCheckResultLanguage (Type: Language)? , AvailabilityCheckResultNote (Type: string)? , ResultListOfAttachment (Type: ListOfAttachment)?
Description: The AvailabilityCheckResultHeader element holds reference dates, supplier and buyer information, and any special notes associated with the AvailabilityCheckResult. This element occurs once within the document.
AvailabilityCheckResultID contains a reference number to identify the AvailabilityCheckResult document.AvailabilityCheckResultIssueDate indicates the date the AvailabilityCheckResult is transmitted.SupplierParty holds information relating to the supplier who is the initiator of the AvailabilityCheckResult. This includes unique ID's and address information.SupplierIDReferenceDate holds the date of the supplier ID reference.BuyerParty holds information relating to the buyer who is the receiver of the AvailabilityCheckResult. This includes unique ID's and address information.BuyerIDReferenceDate holds the date of the buyer ID reference.AvailabilityShipToParty holds the address details of the delivery party. If different delivery parties are involved in this request then they will be specified at the line item level.AvailabilityCheckResultLanguage identifies the language for the AvailabilityCheckResult.AvailabilityCheckResultNote contains any free-form text pertinent to the entire AvailabilityCheckResult. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.ResultListOfAttachment contains details of the attachments for the AvailabilityCheckResult.Content: QuotedItem , AvailableQuantity (Type: Quantity) , AvailabilityErrorInfo (Type: ErrorInfo)? , GeneralLineItemNote (Type: string)? , LineItemAttachment (Type: ListOfAttachment)?
Description: The AvailabilityCheckResultItemDetail element contains the item detail information in response to the AvailabilityCheckRequest line item information.
QuotedItem is a container for holding the original item detail from the AvailabilityCheckRequest.AvailableQuantity contains the available quantity of the item.AvailabilityErrorInfo contains the completion codes and messages, severity codes, and other error information.GeneralLineItemNote describes any free-form text pertinent to the line item described by the AvailabilityCheckResult. This element may contain notes or any other similar information that is not contained explicitly in another structure. It should not be assumed that the receiving application is capable of doing more than storing and/or displaying this information.LineItemAttachment contains details of the attachments for the line item.Content: AvailabilityCheckResultItemDetail+
Description: The ListOfAvailabilityCheckResultItemDetail element contains a list of line items for the AvailabilityCheckResult.
AvailabilityCheckResultItemDetail contains the item detail information in response to the AvailabilityCheckRequest line item information.Content: AvailabilityItemErrors (Type: int) , SummaryErrorInfo (Type: ErrorInfo)? , TotalNumberOfLineItem (Type: int)?
Description: The AvailabilityCheckResultSummary element contains summary information of the AvailabilityCheckResult including total number of line items.
AvailabilityItemErrors contains the number of items that returned errors.SummaryErrorInfo contains the completion codes and messages, severity codes, and other error information.TotalNumberOfLineItem contains the total number of line items.Content: AvailabilityDeliveryOptionCoded (Type: AvailabilityDeliveryOptionCode) , AvailabilityDeliveryOptionCodedOther (Type: string)?
Description: The AvailabilityDeliveryOption element contains the type of delivery for the AvailabilityToPromise document.
AvailabilityDeliveryOptionCoded indicates the type of the AvailabilityToPromise document.AvailabilityDeliveryOptionCodedOther is used to provide a non-standard AvailabilityDeliveryOptionCode. This element is mandatory if the value of AvailabilityDeliveryOptionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of the AvailabilityToPromise.
Value: Enumeration, including:
Content: AvailabilityToPromiseHeader , AvailabilityToPromiseDetail? , AvailabilityToPromiseSummary?
Description: The AvailabilityToPromise element consists of the request for availability to be sent from a buyer to a supplier or a number of suppliers. The request for availability can also be received from an outside source by a supplier. The request is used to determine when, where and how many of the requested goods the supplier(s) can supply, in many cases the request will be sent to existing suppliers only.
AvailabilityToPromiseHeader holds all AvailabilitytoPromise header-level information. This element occurs once within the document.AvailabilityToPromiseDetail contains line item details of the AvaiabilityToPromise.AvailabilityToPromiseSummary contains the summary information of the AvailabilityToPromise. This includes the total number of line items.Content: ListOfAvailabilityToPromiseItemDetail?
Description: The AvailabilityToPromiseDetail element is the container for the AvailabilityToPromise information.
ListOfAvailabilityToPromiseItemDetail is the container for the list of line items for the AvailabilityToPromise.Content: AvailabilityToPromiseItemDetail+
Description: The ListOfAvailabilityToPromiseItemDetail element is the container for the list of line items.
AvailabilityToPromiseItemDetail contains the line item detail information for AvailabilityToPromise.Content: AvailabilityToPromiseBaseItemDetail (Type: BaseItemDetail) , AvailabilityToPromiseDeliveryDetail (Type: DeliveryDetail)? , AvailabilityToPromiseTransportDetail (Type: Transport)? , AvailabilityToPromiseItemListOfAttachment (Type: ListOfAttachment)? , GeneralNote (Type: string)?
Description: The AvailabilityToPromiseItemDetail element contains the line item detail information.
AvailabilityToPromiseBaseItemDetail contains the identifying and descriptive information in the AvailabilityToPromise.AvailabilityToPromiseDeliveryDetail identifies the delivery details for the line item in the AvailabilityToPromise.AvailabilityToPromiseTransportDetail identifies the transport details for the line item in the AvailabilityToPromise.AvailabilityToPromiseItemListOfAttachment contains attachments for the line item.GeneralNote contains any free-form text pertinent to the line item in AvailabilityToPromise. This element may contain notes or any other similar information that is not contained explicitly in another structure. it should not be assumed that the receiving application is capable of doing more than storing and/or displaying this information.Content: AvailabilityID (Type: Reference) , AvailabilityIssueDate (Type: datetime) , ListOfReferenceCoded? , AvailabilityToPromisePurpose , AvailabilityDeliveryOption , InitiatingParty (Type: Party) , AvailabilityShipToParty (Type: Party)? , AvailabilityToPromiseHeaderTransport (Type: TransportRouting)? , GeneralNote (Type: string)? , AvailabilityToPromiseListOfAttachment (Type: ListOfAttachment)?
Description: The AvailabilityToPromiseHeader element holds all AvailabilitytoPromise header-level information. This element occurs once within the document.
AvailabilityID contains a reference number to identify the AvailabilityToPromise document.AvailabilityIssueDate indicates the date the AvailabilitytoPromise request is transmitted.ListOfReferenceCoded contains one or more elements containing information that can be used to find further information elsewhere that are not explicitly stated in another element.AvailabilityToPromisePurpose is a container for the AvailabilitytoPromise purpose details.AvailabilityDeliveryOption contains the type of delivery for the AvailabilityToPromise document.InitiatingParty holds the initiator of the AvailabilityToPromise document.AvailabilityShipToParty holds the address details of the delivery party. If different delivery parties are involved in this request then they will be specified at the line item level.AvailabilityToPromiseHeaderTransport identifies the transport details that apply to the entire AvailabilityToPromise document.GeneralNote is used to provide a note in text form if desired.AvailabilityToPromiseListOfAttachment contains attachments for the AvailabilityToPromise.Content: AvailabilityToPromisePurposeCoded (Type: AvailabilityToPromisePurposeCode) , AvailabilityToPromisePurposeCodedOther (Type: string)?
Description: The AvailabilityToPromisePurpose element is a container for the AvailabilitytoPromise purpose details.
AvailabilityToPromisePurposeCoded indicates the intended use of the AvailabilitytoPromise request.AvailabilityToPromisePurposeCodedOther used to provide a non-standard AvailabilityToPromisePurposeCode. This element is mandatory if the value of AvailabilityToPromisePurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the purpose of the AvailabilityToPromise message. This is a subset codelist derived from EDIFACT 1225 (Message Function, Coded) and X12 353 (Transaction Set Purpose Code) and 587 (Acknowledgement Type Code)
Value: Enumeration, including:
Content: AvailabilityToPromiseResponseHeader , AvailabilityToPromiseResponseDetail? , AvailabilityToPromiseResponseSummary?
Description: The AvailabilityToPromiseResponse element is used to respond to an AvailabilityToPromise document. This element occurs once within the document.
AvailabilityToPromiseResponseHeader holds all AvailabilityToPromiseResponse header-level information. This element occurs once within the document.AvailabilityToPromiseResponseDetail contains the line item and package details for AvailabilityToPromiseResponse.AvailabilityToPromiseResponseSummary contains the summary information for the AvailabilityToPromise. This includes the total number of line items.Content: ListOfAvailabilityToPromiseResponseItemDetail?
Description: The AvailabilityToPromiseResponseDetail element is the container for the AvailabilityToPromiseResponse document.
ListOfAvailabilityToPromiseResponseItemDetail is the container for the list of line items for AvailabilityToPromiseResponse.Content: AvailabilityToPromiseResponseItemDetail+
Description: The ListOfAvailabilityToPromiseResponseItemDetail element is the container for the list of line items.
AvailabilityToPromiseResponseItemDetail contains the item detail information for AvaialabilityToPromiseResponse.Content: AvailabilityToPromiseItemResponse (Type: AvailabilityToPromisePurpose)? , AvailabilityToPromiseResponseBaseItemDetail (Type: BaseItemDetail) , AvailabilityToPromiseResponseDeliveryDetail (Type: DeliveryDetail)? , AvailabilityToPromiseResponseTransportDetail (Type: Transport)? , AvailabilityToPromiseResponseItemListOfAttachment (Type: ListOfAttachment)? , GeneralNote (Type: string)?
Description: The AvailabilityToPromiseResponseItemDetail element is the container for the list of line items.
AvailabilityToPromiseItemResponse .AvailabilityToPromiseResponseBaseItemDetail contains the identifying and descriptive information for AvailabilityToPromiseResponse.AvailabilityToPromiseResponseDeliveryDetail identifies the delivery details for the line item in the AvailabilityToPromiseResponse document.AvailabilityToPromiseResponseTransportDetail identifies the transport details for the line item in the AvailabilityToPromiseResponse document.AvailabilityToPromiseResponseItemListOfAttachment contains attachments for the line item.GeneralNote contains any free-form text pertinent to the line item in AvailabilityToPromiseResponse. This element may contain notes or any other similar information that is not contained explicitly in another structure. it should not be assumed that the receiving application is capable of doing more than storing and/or displaying this information.Content: AvailabilityResponseID (Type: Reference) , AvailabilityResponseIssueDate (Type: datetime) , AvailabilityToPromiseID (Type: Reference) , ATPResponse , ListOfReferenceCoded? , AvailabilityResponseDeliveryOption (Type: AvailabilityDeliveryOption) , InitiatingParty (Type: Party) , AvailabilityShipToParty (Type: Party)? , AvailabilityResponseHeaderTransport (Type: TransportRouting)? , GeneralNote (Type: string)? , AvailabilityResponseListOfAttachment (Type: ListOfAttachment)?
Description: The AvailabilityToPromiseResponseHeader element holds all AvailabilityToPromiseResponse header-level information. This element occurs once within the document.
AvailabilityResponseID contains a reference number to identify the Availability Request Response document.AvailabilityResponseIssueDate indicates the date the AvailabilityToPromiseResponse is transmitted.AvailabilityToPromiseID contains the reference to the original AvailabilityToPromise request.ATPResponse is a container for the AvailabilityToPromiseResponse type.ListOfReferenceCoded contains one or more elements containing information that can be used to find further information elsewhere that are not explicitly stated in another element.AvailabilityResponseDeliveryOption indicates the type of delivery for the AvailabilityToPromiseResponse document.InitiatingParty contains the initiator of the AvailabilityToPromiseResponse document.AvailabilityShipToParty holds the address details of the delivery party. If different delivery parties are involved in this request then they will be specified at the line item level.AvailabilityResponseHeaderTransport identifies the transport details that apply to the entire AvailabilityToPromiseResponse document.GeneralNote contains any free-form text pertinent to the entire AvailabilityToPromiseResponse. This element may contain notes or any other similar information that is not contained explicitly in another structure. It should not be assumed that the receiving application is capable of doing more than storing and/or displaying this information.AvailabilityResponseListOfAttachment contains attachments for the AvailabilityToPromiseResponse document.Content: TotalNumberOfLineItems (Type: int)?
Description: The AvailabilityToPromiseResponseSummary element details summarizing the AvailabilityToPromiseResponse document.
TotalNumberOfLineItems holds the total number of line items for message.Content: TotalNumberOfLineItems (Type: int)?
Description: The AvailabilityToPromiseSummary element contains details summarizing the AvailabilityToPromise document.
TotalNumberOfLineItems holds total number of line items for message.Content: BankCountry (Type: Country) , BankKey (Type: string)? , SWIFTCode (Type: string)? , BankAccountNumber (Type: string) , InternationalBankAccountNumber (Type: string)? , TradingPartnerAccountHolder (Type: string)? , BankAccountControlKey (Type: string)? , BankReference (Type: string)?
Description: The BankDetail element provides detailed bank information for the organization.
BankCountry holds the ISO-Code of the country.BankKey is the national bank key.SWIFTCode holds the SWIFT Bank ID.BankAccountNumber contains the Account number for the organization.InternationalBankAccountNumber contains the IBAN (International Bank Account Number) for the organization.TradingPartnerAccountHolder contains the account holder for the organization.BankAccountControlKey contains the control key for the bank account.BankReference contains bank detail reference information for this account.Content: BankDetail
Description: The ListOfBankDetail element provides a list of one or more bank details for the organization.
BankDetail provides detailed bank information for the organization.Content: LocationAttributeID (Type: string) , LocationAttributeName (Type: Identifier)* , LocationAttributeDescription (Type: string)? , Location? , LocationNotes (Type: string)? , OtherLocationAttribute (Type: CharacteristicAttribute)?
Description: The BaseCharacteristicLocation element contains the details describing a location. It also includes a generic characteristic field to allow for user specific location related data.
LocationAttributeID contains a unique identifier which serves as the technical description or primary key of the location with respect to the originating system.LocationAttributeName contains the human readable value to identify the location. The LocationAttributeName will contain the attributes Agency and AgencyCoded which can be used to qualify the value of the LocationName.LocationAttributeDescription is used to describe the location. This is a language dependent text field.Location contains details relevant to describing the location. This includes name, address, and contact information.LocationNotes gives specifications relating to the location description.OtherLocationAttribute is additional user-specific characteristics related to the location.Content: ProductAttributeID (Type: string) , ProductAttributeName (Type: Identifier)* , ProductAttributeDescription (Type: string)? , ListOfDimension? , ProductNotes (Type: string)? , OtherProductAttribute (Type: CharacteristicAttribute)?
Description: The BaseCharacteristicProduct element contains the details describing a characteristic product. It also includes a generic characteristic field to allow for user-specific product related data.
ProductAttributeID contains a unique identifier which serves as the technical description or primary key of the product with respect to the originating system.ProductAttributeName contains the human readable value to identify the product.The ProductAttributeName is of datatype 'Identifier'. An Identifier consists of an Agency and a string value. The string will hold the ProductAttributeName value. The Agency is used to identify the origins of the ProductAttributeName value.
EX: AttributeName value = Product name
Agency = EAN
ProductAttributeDescription is used to describe the product. This is a language dependent text field.ListOfDimension is used to further describe the product.ProductNotes gives specifications relating to the product.OtherProductAttribute is additional user-specific characteristics related to the product.Content: LineItemNum , LineItemType? , ParentItemNumber (Type: LineItemNumberReference)? , ItemIdentifiers? , ListOfDimension? , TotalQuantity (Type: Quantity)? , MaxBackOrderQuantity (Type: Quantity)? , OffCatalogFlag (Type: boolean)? , ListOfItemReferences (Type: ListOfReferenceCoded)? , CountryOfOrigin (Type: Country)? , CountryOfDestination (Type: Country)? , FinalRecipient (Type: Party)? , ConditionsOfSale? , HazardousMaterials (Type: Hazardous)?
Description: The BaseItemDetail element identifies the line item for the document. This contains the description, specific identifiers, weights, measures and other information associated with the product.
LineItemNum is a set of numbers uniquely identifying the line item for the number. In the case where the seller's system splits a line item number into 2 line items, the buyer item number will remain the same for both line items, but the seller item number will be different.LineItemType contains information on whether the line item is part of a component group.ParentItemNumber identifies the line item that groups this and other line items. This is done using LineItemNumberReference, which specifies the number of the parent line item and whether this reference is the Buyer or Seller's number. LineItemNumberReference is a string content model of datatype integer that contains an attribute to specify whether the ParentItemNumber is a Seller or Buyer number, with the default being Buyer. This value references the parent item represented a group.ItemIdentifiers details all of the part numbers assigned to the item.ListOfDimension lists one or more quantitative measurements of the item.TotalQuantity contains the total amount of the line item pertaining to the document.MaxBackOrderQuantity specifies the maximum quantity of an item that a customer will allow to be back ordered.OffCatalogFlag is a flag to denote whether the item was ordered from a catalog.ListOfItemReferences lists one or more references relating to the line item.CountryOfOrigin specifies the country code for the country in which the line item was manufactured.CountryOfDestination specifies the country code for the country in which the delivery is finally received.FinalRecipient identifies the person or organization who will ultimately receive the item or items.ConditionsOfSale details the conditions of sale for the item.HazardousMaterials contains the hazardous information for the line item.Content: BuyerLineItemNum (Type: int) , SellerLineItemNum (Type: int)?
Description: The LineItemNum element a set of numbers uniquely identifying the line item for the number. In the case where the seller's system. splits a line item number into 2 line items, the buyer item number will remain the same for both line items, but the seller item number will be different.
BuyerLineItemNum buyer's assigned line item number.SellerLineItemNum seller's assigned line item number.Content: LineItemTypeCoded (Type: LineItemTypeCode) , LineItemTypeCodedOther (Type: string)?
Description: The LineItemType element contains information on whether the line item is part of a component group.
LineItemTypeCoded is used to indicate whether the line item is a single or component line item.LineItemTypeCodedOther is used to provide a non-standard LineItemTypeCode. This element is mandatory if the value of LineItemTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: int
Attribute: Name: LineItemNumTypeCoded - Data Type: LineItemNumTypeCode - Default Value: "Buyer"Description: The LineItemNumberReference element identifies a line item number and whether that number was assigned by the buyer or the seller. This is a string content model.
LineItemNumTypeCoded identifies whether the line item number was assigned by the buyer or seller using a standard codelist.Description:
This code identifies whether the line item is a single or component line item.
Value: Enumeration, including:
Description:
This code identifies the party that assigned the line item number.
Value: Enumeration, including:
Content: ItemCharacteristicCoded (Type: ItemCharacteristicCode)? , ItemCharacteristicCodedOther (Type: string)? , SurfaceLayerPositionCoded (Type: SurfaceLayerPositionCode)? , SurfaceLayerPositionCodedOther (Type: string)? , ItemCharacteristicValue (Type: string) , UnitOfMeasurement?
Description: The ItemCharacteristic element is a container element that contains the physical attributes other than dimensions of an item.
ItemCharacteristicCoded identifies the characteristic being described by the ItemCharacteristic element using a standard codelist.ItemCharacteristicCodedOther is used to provide a non-standard ItemCharacteristicCode. This element is mandatory if the value of ItemCharacteristicCoded is 'Other'. These codes should not contain white space unless absolutely necessary.SurfaceLayerPositionCoded identifies the surface layer or the position of the item being described by the ItemCharacteristic element using a standard codelist.SurfaceLayerPositionCodedOther is used to provide a non-standard SurfaceLayerPositionCode This element is mandatory if the value of SurfaceLayerPositionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ItemCharacteristicValue is the value of the characteristic being described by the ItemCharacteristic element.UnitOfMeasurement is the unit of measure for the value of the characteristic.Content: ItemCharacteristic+
Description: The ListOfItemCharacteristic element is a collection of one or more characteristics that describe the item such as surface finishes.
ItemCharacteristic is a container element that contains the characteristics of an item.Extends: BaseItemDetail
Description: The BasePlanningDetail element extends BaseItemDetail to include item schedule reference, release frequency and item quantities.
RecordKeepingYear is the record keeping or model year for the buyer.ItemScheduleReference identifies reference and possible release information for the planning schedule. The assumption is made that there will be only one reference document (i.e., contract, blanket order, etc) for the PlanningSchedule. If additional references exist, then these will be given here at the line item level. The reference value here will override the reference value given at the header level.ForecastFrequencyCoded identifies the release frequency of the line item.ForecastFrequencyCodedOther is used to provide a non-standard ForecastFrequencyCode. This element is mandatory if the value of ForecastFrequencyCode is 'Other'. These codes should not contain white space unless absolutely necessary.ItemQuantities lists quantities associated with the planning of this line item.ItemReleaseStatusCoded indicates the status of the part being ordered or forecast with respect to this material release or planning document.ItemReleaseStatusCodedOther is used to provide a non-standard ItemReleaseStatusCode. This element is mandatory if the value of ItemReleaseStatusCode is 'Other'. These codes should not contain white space unless absolutely necessary.Extends: BaseItemDetail
Description: The BaseShippingDetail element extends BaseItemDetail to include item schedule reference, release frequency and item quantities.
RecordKeepingYear is the record keeping or model year for the buyer.ItemScheduleReference identifies references and possible release information for the ShippingSchedule document. The assumption is made that there will be only one reference document (i.e., contract, blanket order, etc) for the planning schedule. If additional references exist, then these will be given here at the line item level. The reference value here will override the reference value given at the header level.ForecastFrequencyCoded identifies the release frequency of the line item.ForecastFrequencyCodedOther is used to provide a non-standard ForecastFrequencyTypeCode. This element is mandatory if the value of ScheduleTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ItemQuantities is a list of quantities associated with the planning of this line item.ItemReleaseStatusCoded indicates the status of the part being ordered or forecast with respect to this material release or planning document.ItemReleaseStatusCodedOther is used to provide a non-standard ItemReleaseStatusCode. This element is mandatory if the value of ScheduleTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ItemPackagingReference identifies which package the line item is in.Description:
This code identifies the header level acknowledgement to be sent in response to the AuctionCreate message.
Value: Enumeration, including:
Content: Variable String, Maxlength: 3
Description: The AlphaNum3 datatype is a string with a maximum length of 3.
Content: Variable String, Maxlength: 6
Description: The AlphaNum6 datatype is a string with a maximum length of 6.
Content: Variable String, Maxlength: 9
Description: The AlphaNum9 datatype is a string with a maximum length of 9.
Content: Variable String, Maxlength: 14
Description: The AlphaNum14 datatype is a string with a maximum length of 14.
Content: Variable String, Maxlength: 17
Description: The AlphaNum17 datatype is a string with a maximum length of 17.
Content: Variable String, Maxlength: 20
Description: The AlphaNum20 datatype is a string with a maximum length of 20.
Content: Variable String, Maxlength: 35
Description: The AlphaNum35 datatype is a string with a maximum length of 35.
Content: Variable String, Maxlength: 40
Description: The AlphaNum40 datatype is a string with a maximum length of 40.
Content: Variable String, Maxlength: 50
Description: The AlphaNum50 datatype is a string with a maximum length of 50.
Content: Variable String, Maxlength: 70
Description: The AlphaNum70 datatype is a string with a maximum length of 70.
Content: Variable String, Maxlength: 80
Description: The AlphaNum80 datatype is a string with a maximum length of 80.
Content: Variable String, Maxlength: 256
Description:
Used for free-form notes
Content: Variable String, Maxlength: 512
Description: The AlphaNum512 datatype is a string with a maximum length of 512.
Content: Scalar, Datatype: number, Digits: 2, Decimals: 0
Description:
numeric datatypes
Content: Scalar, Datatype: number, Digits: 6, Decimals: 0
Description: The Decimal6_0 datatype a Decimal6_0 double is intended to hold a decimal double with up to 6 digits of precision, including up to 6 digits to the left of the decimal sign and 0 digits to the right.
Content: Scalar, Datatype: number, Digits: 12, Decimals: 3
Description:
A Decimal15_3 double is intended to hold a decimal double with up to 15 digits of precision, including up to 15 digits to the left of the decimal sign and 3 digits to the right.
Content: Scalar, Datatype: number, Digits: 11, Decimals: 4
Description: The Decimal15_4 datatype a Decimal15_4 double is intended to hold a decimal double with up to 15 digits of precision, including up to 11 digits to the left of the decimal sign and 4 digits to the right.
Content: Scalar, Datatype: number, Digits: 15, Decimals: 3
Description:
A Decimal18_3 double is intended to hold a decimal double with up to 18 digits of precision, including up to 15 digits to the left of the decimal sign and 3 digits to the right.
Content: Scalar, Datatype: number, Digits: 6, Decimals: 2
Description:
A Decimal8_2 double is intended to hold a decimal double with up to 8 digits of precision, including up to 6 digits to the left of the decimal sign and 2 digits to the right.
Content: Scalar, Datatype: number, Digits: 6, Decimals: 4
Description: The Decimal10_4 datatype a Decimal10_4 double is intended to hold a decimal double with up to 10 digits of precision, including up to 6 digits to the left of the decimal sign and 4 digits to the right.
Content: Scalar, Datatype: number, Digits: 15, Decimals: 6
Description: The Decimal21_6 datatype a Decimal21_6 double is intended to hold a decimal double with up to 21 digits of precision, including up to 15 digits to the left of the decimal sign and 6 digits to the right.
Content: Scalar, Datatype: number, Digits: 10, Decimals: 9
Description: The Decimal19_9 datatype a Decimal19_9 double is intended to hold a decimal double with up to 19 digits of precision, including up to 10 digits to the left of the decimal sign and 9 digits to the right.
Content: Scalar, Datatype: int, Digits: 6, Decimals: 0
Description:
A PosInt_6 double is intended to hold an positive integer comprised of up to 6 base 10 characters
Content: Variable String, Maxlength: 60
Description: The AlphaNum60 datatype is a string with a maximum length of 60.
Content: Variable String, Maxlength: 30
Description: The AlphaNum30 datatype is a string with a maximum length of 30.
Content: Variable String, Maxlength: 10
Description: The AlphaNum10 datatype is a string with a maximum length of 10.
Content: Scalar, Datatype: float, Digits: 16
Description: The Float_16 datatype a floating point value with a maximum number of 16 digits.
Description:
This code identifies the bidding requirements for the AuctionResultResponse message.
Value: Enumeration, including:
Description:
This code identifies the role of a trading partner, or otherwise qualifies a piece of data that could come from more than one source within the trading relationship.
Value: Enumeration, including:
Content: CatalogContractID (Type: string) , CatalogContractItemID (Type: string)
Attribute: Name: Type - Data Type: BuyerSupplierCode - Default Value: "Buyer"Description: The CatalogContract element contains information to identify the buyer's or supplier's contract, and the item identification in terms of that contract.
CatalogContractID holds the reference to the contract, typically as a contract number.CatalogContractItemID holds the contract's reference to the item, also typically a number.Type identifies whether the contract information refers to a buyer's contract, a supplier's contract, or some other contract. "Other" is not used here to refer to a custom value (that is, there is no string field to contain a custom value. If needed, this additional information should form part of the contract number information supplied in CatalogContractID.Content: Product*
Description: The CatalogData element is a container for instances of products described in the ProductCatalog.
Product contains all attributes associated with a product.Content: CatalogID (Type: string) , CatalogDate (Type: date)? , CatalogProvider? , ListOfPartners? , ValidFrom (Type: date)? , ValidUntil (Type: date)? , CatalogVersion (Type: number)? , DefaultLanguage? , DefaultCurrency (Type: Currency)? , IsReplacement? , IsPriceUpdate? , IsMultiVendor? , ShortDescription* , LongDescription* , ObjectAttribute*
Description: The CatalogHeader element provides administrative information about the catalog including its provider, and suppliers and other trading partners present in the catalog.
CatalogID holds a required unique identifier for catalog. Must be unique within the set of catalogs provided by a particular catalog provider.CatalogDate is the date that this catalog information was created.CatalogProvider specifies the providing party of this catalog. Contains an optional Party subelement. Has optional attribute of ProviderID whose ID overrides the ID present on a Party element. Either a ProviderID attribute or a Party subelement must be present.ListOfPartners identifies suppliers, manufacturers used by this catalog, and, potentially, buyers for whom this catalog is targeted.ValidFrom gives the date that products and price in this catalog begin to be available.ValidUntil gives the date on which the information in this catalog is no longer applicable.CatalogVersion holds the version number of catalog specified as a single integer. Shouldbe specified as a higher number than any previous catalog updates that have been sent.DefaultLanguage contains the attribute xml:lang indicating the language that should be assumed for the catalog, when it is not specified explicitly on a particular element. The value for xml:lang must be a valid RFC 1766 language code, and as such is not restricted to the coded values typically used for this purpose in xCBL (although these are RFC 1766-compliant).DefaultCurrency holds an ISO currency code indicating the currency that should be assumed for the catalog.IsReplacement is an element that, when present in the document, indicates that this is a complete replacement for an existing catalog.IsPriceUpdate is an element that, when present in the document, indicates that the catalog is only being used to update prices.IsMultiVendor is an element that, when present in the document, indicates that the catalog is a multivendor catalog. If a product is multivendor, price should only appear under ProductVendorData.ShortDescription gives a short description of the catalog. Has xml:lang attribute so there can be more than one ShortDescription in multiple languages. xml:lang must contain valid RFC 1766 language code.LongDescription gives a long description of the catalog. Has xml:lang attribute for multilanguage support. xml:lang must contain valid RFC 1766 language code. If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English." DescriptionPurpose is an attribute that attempts to describe what the description is for. Examples of valid values are "sales" and "internal use only".ObjectAttribute provides other data items for the overall catalog or catalog administration that are not in elements that already exist in the CatalogHeader.Content: EMPTY
Attribute: Name: lang - Data Type: xmllang - Default Value: "en"Description: The DefaultLanguage element contains the attribute xml:lang indicating the language that should be assumed for the catalog, When it is not specified explicitly on a particular element. The value for xml:lang must be a valid RFC 1766 language code, and as such is not restricted to the coded values typically used for this purpose in xCBL (although these are RFC 1766-compliant).
lang language for the text description.Content: EMPTY
Description: The IsReplacement element is an element whose presence in the catalog indicates that this is a complete replacement for an existing catalog.
Content: EMPTY
Description: The IsPriceUpdate element is an element whose presence indicates that the catalog is only being used to update prices.
Content: EMPTY
Description: The IsMultiVendor element is an element whose presence indicates that the catalog is a multivendor catalog. If a product is multivendor, price should only appear under ProductVendorData.
Content: Party? , CatalogSystem?
Attribute: Name: ProviderID - Data Type: string - Default Value: #IMPLIEDDescription: The CatalogProvider element specifies the providing party of this catalog. Contains an optional Party subelement.
Party identifies an entity doing business and the relevant information pertaining to it.CatalogSystem allows the provider to identify the location and type of the system that created the catalog.ProviderID specifies an identifier for the provider of the catalog. Must be specified if there is no Party element.Content: SystemAddress (Type: string) , SystemType (Type: string)
Description: The CatalogSystem element specifies the system address and type of system of this catalog. Contains 2 mandatory subelements.
SystemAddress supplies a system address supplied by the provider's catalog system.SystemType gives a description of the type of system used by the provider to create the catalog.Content: SchemaName (Type: string) , SchemaVersion (Type: number)? , SchemaStandard (Type: string)? , SchemaSource (Type: URI)? , ValidateAttributes? , ShortDescription* , LongDescription* , SchemaCategory*
Attribute: Name: Type - Data Type: BuyerSupplierCode - Default Value: "Supplier"Description: The CatalogSchema element holds optional, creator-configured information about the structure of products in the catalog.
SchemaName The CatalogSchema is a set of categories used for products in this catalog. The schema was created by a buyer, a supplier or "other" (such as a marketplace or manufacturer): this is the name assigned to that schema by its creator.SchemaVersion is the version number for the catalog schema used for products in this catalog.SchemaStandard is the taxonomy standard that this catalog may be based upon or is a subset of, e.g. UNSPSC or eClass.SchemaSource is a URL to an external schema. This external schema should either be a ProductCatalog document containing a schema or a CatalogSchema document. Use of an external SchemaSource is necessary to validate Product instances when ExternalCategory is used on a Product in lieu of a SchemaCategoryRef on Product. Note that if this element is present in the CatalogSchema, no SchemaCategory element(s) should be present in the CatalogSchema, and SchemaCategoryRef should not be used on any of the Products in the document. This element is useful when a supplier or other catalog provider is providing data that needs to be validated against someone else's (such as the net market maker's) schema.ValidateAttributes The presence of this element indicates that the category attributes should be validated.ShortDescription This is a short description of the schema. There may be more than one ShortDescription element to allow for internationalized content, which is effected by use of the xml:lang attribute. xml:lang must contain a value that is a valid RFC 1766 language code. If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English".LongDescription This is a long description of the schema. There may be more than one LongDescription element to allow for internationalized content, which is effected by use of the xml:lang attribute. xml:lang must contain a value that is a valid RFC 1766 language code.If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English" .SchemaCategory is a list of categories. Should not be present if there is a SchemaSource element supplied to identify an external schema.Type Code to identify the type of the schema:Supplier,Buyer, or Other (the last is the default).Content: EMPTY
Description: The ValidateAttributes element is an element whose presence indicates that the category attributes should be validated.
Content: AttributeID (Type: string) , AttributeName* , AttributeType , IsRequired?
Description: The CategoryAttribute element holds a list of the category's attribute definitions, as described in its child elements.
AttributeID identifies the category's attribute. It must be unique among attributes present in this particular SchemaCategory. If a child SchemaCategory has the same AttributeID as a parent SchemaCategory, the suggested behavior of an xCBL 3.0 catalog processor is to report this as an error.AttributeName contains the name of the attribute. Multilanguage support is provided by potentially having multiple AttributeName elements, each of which has an xml:lang attribute. xml:lang must contain a value that is a valid RFC 1766 language code. If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English.".AttributeType provides the data type of the category's attribute. Has ScalarType enumerated attribute that indicates whether this data value is a String, an Integer, a Numeric value (such as a floating point number), a Currency (an ISO Currency Code), a Date, or an Enumeration. If an Enumeration, AttributeType has a set of subelements called EnumeratedValue which list the values of the enumeration. Also optionally has MaxSize attribute which indicates the maximum length of the string in characters.IsRequired indicates, by its presence in the message, that the attribute is required. This should be reflected by the validation behavior of the processing application.Description: The AttributeName element contains the name of the attribute. Multilanguage support is provided by potentially having multiple AttributeName elements, each of which has an xml:lang attribute. xml:lang must contain a value that is a valid RFC 1766 language code. If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English.".
lang language for the text description.Content: EMPTY
Description: The IsRequired element indicates, by its presence in the message, that the attribute is required. This should be reflected by the validation behavior of the processing application.
Content: ChangeOrderHeader , ChangeOrderDetail? , ChangeOrderSummary?
Description: The ChangeOrder element ChangeOrder allows a requisitioner or buyer to initiate a change to an already existing order. A seller uses the OrderResponse document to accept or reject an order or a changed order.
ChangeOrderHeader contains the header information of the OrderChange.ChangeOrderDetail is an optional section providing a list of line items. This list can only include those which were changed, the entire line item list, or no line items at all. This should be used in accordance with the OrderHeaderPurpose selected in the ChangeOrderHeader.ChangeOrderSummary is the summary section for the ChangeOrder. This contains the same information as the OrderSummary.Content: ListOfChangeOrderItemDetail? , ListOfChangeOrderPackageDetail?
Description: The ChangeOrderDetail element is an optional section providing a list of line items. This list can only include those which were changed, the entire line item list, or no line items at all. This should be used in accordance with the OrderHeaderPurpose selected in the ChangeOrderHeader.
ListOfChangeOrderItemDetail holds change information for the item detail information.ListOfChangeOrderPackageDetail holds change information for the package detail information.Content: ChangeOrderNumber , ChangeOrderSequence (Type: string) , ChangeOrderIssueDate (Type: datetime) , OrderReference (Type: Reference) , SellerParty (Type: Party) , BuyerParty (Type: Party) , ListOfReferenceCoded? , Purpose , RequestedResponse? , ChangeType , OrderType? , OriginalOrderHeader (Type: OrderHeader)? , OrderHeaderChanges (Type: OrderHeader)? , ChangeOrderHeaderNote (Type: string)? , ListOfStructuredNote?
Description: The ChangeOrderHeader element contains the header information of the OrderChange.
ChangeOrderNumber indicates the unique number assigned to the ChangeOrder, typically according to the system that generated the ChangeOrderNumber.ChangeOrderSequence is a number to identify the change or revision against an order. The first change submitted for an order would have a value of 1, the second 2, and so on.ChangeOrderIssueDate holds a time stamp provided by the application that created the OrderChange document.OrderReference holds the number and the issue date for the purchase order being changed.SellerParty identifies the party selling the goods.BuyerParty identifies the party buying the goods.ListOfReferenceCoded contains all other references for the ChangeOrder not explicitly stated as the contents of other elements.Purpose is used to communicate the purpose of the ChangeOrder document.RequestedResponse specifies the type of acknowledgment requested by the buyer from the seller.ChangeType identifies the type of change in the ChangeOrder.OrderType identifies the type of purchase order the ChangeOrder is referencing.OriginalOrderHeader is a place to insert a copy of the original OrderHeader for comparison against changes. This is useful for comparison reasons but will seldom be used.OrderHeaderChanges holds any changes to the original OrderHeader. Note: If there are changes to the header, the entire header section should be repeated with the changes.ChangeOrderHeaderNote contains any free-form text pertinent to the entire ChangeOrder. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information. This element can be used to explicitly state the changes that were made to the header section.ListOfStructuredNote contains one or more structured notes that allow you to provide notes that are more than a simple free-text field. such notes may include the message text, or this text may be referenced with an external identifier or a URL. An agency may be specified, and is needed in the case where an ID has been provided for a note that is either included in-line or referenced. This field is often used to include references to centrally stored clauses in contracts that are required to appear within business documents.Content: BuyerChangeOrderNumber (Type: string) , SellerChangeOrderNumber (Type: string)? , ListOfMessageID?
Description: The ChangeOrderNumber element indicates the unique number assigned to the ChangeOrder, typically according to the system that generated the ChangeOrderNumber.
BuyerChangeOrderNumber is the unique number assigned by the buyer to this ChangeOrder.SellerChangeOrderNumber is the unique number assigned by the seller to this ChangeOrder.ListOfMessageID contains one or more identifiers for a message.Content: ItemDetailChangeCoded (Type: DetailChangeCode) , ItemDetailChangeCodedOther (Type: string)? , ListOfReferenceCoded? , OriginalItemDetail (Type: ItemDetail)? , ItemDetailChanges (Type: ItemDetail)? , LineItemNote (Type: string)? , ListOfStructuredNote?
Description: The ChangeOrderItemDetail element contains a qualifier for the type of change made to the line item, the line item itself, and note field for any additional information to be provided.
ItemDetailChangeCoded identifies the type of change to the line item.ItemDetailChangeCodedOther is used to provide a non-standard ItemDetailChangeCode. This element is mandatory if the value of ItemDetailChangeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfReferenceCoded contains all other references for the ChangeOrder, not explicitly stated as the content of other elements.OriginalItemDetail is used to send the original information for the line item. This is useful for comparisons, but will rarely be used.ItemDetailChanges identifies the line to be added/deleted or to identify the changes to an existing line item.LineItemNote describes any free form text pertinent to the line item. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.ListOfStructuredNote contains one or more structured notes that allow you to provide notes that are more than a simple free-text field. such notes may include the message text, or this text may be referenced with an external identifier or a URL. An agency may be specified, and is needed in the case where an ID has been provided for a note that is either included in-line or referenced. This field is often used to include references to centrally stored clauses in contracts that are required to appear within business documents.Content: ChangeOrderItemDetail+
Description: The ListOfChangeOrderItemDetail element holds change information for the item detail information.
ChangeOrderItemDetail contains a qualifier for the type of change made to the line item, the line item itself, and note field for any additional information to be provided.Content: PackageDetailChangeCoded (Type: DetailChangeCode) , PackageDetailChangeCodedOther (Type: string)? , OriginalPackageDetail (Type: PackageDetail)? , PackageDetailChanges (Type: PackageDetail)? , PackageDetailNote (Type: string)?
Description: The ChangeOrderPackageDetail element holds a change information for the package detail.
PackageDetailChangeCoded identifies the type of change to the PackageDetail.PackageDetailChangeCodedOther is used to provide a non-standard PackageDetailChangeCode. This element is mandatory if the value of PackageDetailChangeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OriginalPackageDetail is used to send the original PackageDetail. This is useful for comparisons, but will rarely be used.PackageDetailChanges identifies the PackageDetail to be added/deleted or to identify the changes to an existing PackageDetail.PackageDetailNote describes any free-form text pertinent to the PackageDetail described by the ChangeOrder. This element may contain notes or any other similar information that is not contained explicitly in another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.This can be used to give any additional information concerning the changes made to the PackageDetail.Content: ChangeOrderPackageDetail+
Description: The ListOfChangeOrderPackageDetail element holds change information for the package detail information.
ChangeOrderPackageDetail holds a change information for the package detail.Content: OriginalOrderSummary (Type: OrderSummary)? , RevisedOrderSummary (Type: OrderSummary)?
Description: The ChangeOrderSummary element is the summary section for the ChangeOrder. This contains the same information as the OrderSummary.
OriginalOrderSummary is used to show the old OrderSummary for comparison purposes, if needed.RevisedOrderSummary is the summary section that reflects any changes made to the Order.Content: ChangeTypeCoded (Type: ChangeTypeCode) , ChangeTypeCodedOther (Type: string)?
Description: The ChangeType element identifies the type of change in the ChangeOrder.
ChangeTypeCoded signifies the type of change initiated by this ChangeOrder.ChangeTypeCodedOther is used to provide a non-standard ChangeTypeCode. This element is mandatory if the value of ChangeTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of change initiated by the ChangeOrder message. This code list is derived from EDIFACT 1225 (Message function code)and 1229 (Action request/notification description code) and X12 353 (Transaction set purpose code) and 670(Change or response type code)
Value: Enumeration, including:
Content: CharacteristicName (Type: string) , CharacteristicAttributeID (Type: string) , CharacteristicAttributeName (Type: Identifier)* , CharacteristicAttributeDescription (Type: string)? , ListOfDimension? , CharacteristicAttributeNote (Type: string)? , OtherCharacteristicAttribute (Type: CharacteristicAttribute)*
Description: The CharacteristicAttribute element contains the details relevant to describing a characteristic. It also includes a generic characteristic field to allow for user-defined data.
CharacteristicName identifies the characteristic being described. Examples of CharacteristicName are product and location.CharacteristicAttributeID identifies the ID for the characteristic being described.CharacteristicAttributeName contains the human readable value to identify the characteristic. The identifier element consists of an agency and a string value. The string will hold the CharacteristicAttributeName value. The agency will be used to identify the origins of the CharacteristicAttributeName value.CharacteristicAttributeDescription provides a description of the characteristic.ListOfDimension is used to further describe theCharacteristicAttribute.CharacteristicAttributeNote provides additional information about the characteristic.OtherCharacteristicAttribute is additional user-specific characteristics related to the CharacteristicAttribute.Content: CharacteristicCombinationPurposeCoded (Type: TimeSeriesPurposeCode)? , CharacteristicCombinationPurposeCodedOther (Type: string)? , CharacteristicCombinationResponseCoded (Type: TimeSeriesErrorCode)? , CharacteristicCombinationResponseCodedOther (Type: string)? , CharacteristicCombinationID (Type: string) , CharacteristicProduct? , CharacteristicLocation? , CharacteristicProductGroup? , CharacteristicOther*
Description: The CharacteristicCombination element defines a single characteristic combination for the time series.
CharacteristicCombinationPurposeCoded is used to indicate the function of the characteristic combination in the transmission of this document. The application can use this code to process the characteristic combinations appropriately.CharacteristicCombinationPurposeCodedOther is used to provide a non-standard CharacteristicCombinationPurposeCode. This element is mandatory if the value of CharacteristicCombinationPurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.CharacteristicCombinationResponseCoded indicates whether there is an error in the characteristic combination data. This code is sent in response to a TimeSeriesRequest.CharacteristicCombinationResponseCodedOther is used to provide a non-standard CharacteristicCombinationResponseCode. This element is mandatory if the value of CharacteristicCombinationResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.CharacteristicCombinationID is the key to uniquely identify a characteristic combination.CharacteristicProduct contains the basic elements used to describe a characteristic product with respect to the source and target systems.CharacteristicLocation contains the basic elements used to describe a characteristic location with respect to the source and target systems.CharacteristicProductGroup contains the basic elements used to describe a characteristic product group with respect to the source and target systems.CharacteristicOther is a generic configurable characteristic element that can be used to describe various characteristics of a time series. This element is given with respect to the source and target systems.Content: CharacteristicCombination+
Description: The ListOfCharacteristicCombinations element contains a list of all the characteristic combinations for the time series. This element can be sent in a separate transmission from the time series document (without the key figure and time series value information) to serve as an initial setup/configuration process.
CharacteristicCombination defines a single characteristic combination for the time series.Content: SourceLocation (Type: BaseCharacteristicLocation)? , TargetLocation (Type: BaseCharacteristicLocation)?
Description: The CharacteristicLocation element contains the basic elements used to describe a characteristic location with respect to the source and target systems.
SourceLocation is the location description with respect to the source system.TargetLocation is the location description with respect to the target system.Content: SourceCharacteristicsOther (Type: CharacteristicAttribute)? , TargetCharacteristicsOther (Type: CharacteristicAttribute)?
Description: The CharacteristicOther element is a generic configurable characteristic element that can be used to describe various characteristics of a time series. This element is given with respect to the source and target systems.
SourceCharacteristicsOther is other characteristics described with respect to the source system.TargetCharacteristicsOther is other characteristics described with respect to the target system.Content: SourceProduct (Type: BaseCharacteristicProduct)? , TargetProduct (Type: BaseCharacteristicProduct)?
Description: The CharacteristicProduct element contains the basic elements used to describe a characteristic product with respect to the source and target systems.
SourceProduct is the product description with respect to the source system.TargetProduct is the product description with respect to the target system.Content: SourceProductGroup (Type: BaseCharacteristicProduct)? , TargetProductGroup (Type: BaseCharacteristicProduct)?
Description: The CharacteristicProductGroup element contains the basic elements used to describe a characteristic product group with respect to the source and target systems.
SourceProductGroup is the product group description with respect to the source system.TargetProductGroup is the product group description with respect to the target system.Description:
This code identifies the party responsible for the payment of fees.
Value: Enumeration, including:
Description:
This code identifies the code list used. This code list is derived from EDIFACT 1131 (Code list identification code) and X12 1270 (Code list identifier code)
Value: Enumeration, including:
Description:
This code identifies the commitment level for the forecast. This code list is derived from EDIFACT 4017 (Delivery plan commitment level code) and X12 680 (Forecast Qualifier)
Value: Enumeration, including:
Content: CommunicationDetailDescription (Type: string)? , PersonCommunicationType , CommunicationValue (Type: string) , DefaultCommunication (Type: boolean)?
Description: The CommunicationDetail element is the information of the communication detail for the person.
CommunicationDetailDescription contains a description of the communication detail for the person, e.g. telephone number.PersonCommunicationType contains the information on the communication method.CommunicationValue contains the communication number or identifier.DefaultCommunication is a flag to provide information on whether this is the default communication method.Content: CommunicationDetail+
Description: The ListOfCommunicationDetail element is a container that holds one or more CommunicationDetail elements.
CommunicationDetail contains the information regarding the communication details for the person.Content: PersonCommunicationTypeCoded (Type: PersonCommunicationTypeCode) , PersonCommunicationTypeCodedOther (Type: string)
Description: The PersonCommunicationType element is container to hold the coded list of the communication method of the person.
PersonCommunicationTypeCoded is a coded list of the communication method of the person.PersonCommunicationTypeCodedOther is used to provide a non-standard PersonCommunicationTypeCode. This element is mandatory if the value of PersonCommunicationTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the communication type of the person involved.
Value: Enumeration, including:
Extends: Party
Description: The Company element contains information pertinent to identifying a company. This element extends the Party definition with an Industry sector code.
IndustrySectorCoded identifies the industry sector for a given company.IndustrySectorCodedOther is used to provide a non-standard IndustrySectorCode. This element is mandatory if the value of IndustrySectorCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the conditions that apply to a measurement value. This code list is derived from X12 935 (Measurement significance code)
Value: Enumeration, including:
Content: SalesRequirement+ , SalesActionCoded (Type: SalesActionCode)? , SalesActionCodedOther (Type: string)? , SalesActionValue (Type: string)?
Description: The ConditionsOfSale element details the conditions of sale for the item.
SalesRequirement outlines any specific sales information relating to the item.SalesActionCoded code indicating what action should be undertaken in specific circumstances.SalesActionCodedOther is used to provide a non-standard SalesActionCode. This element is mandatory if the value of SalesActionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.SalesActionValue is the value associated with the action code.Description:
This code indicates the type of sales action. This code list is derived from X12 306 (Action code)
Value: Enumeration, including:
Content: ContactID (Type: Identifier)? , ContactName (Type: string) , ContactFunction? , ContactDescription (Type: string)? , ListOfContactNumber?
Description: The Contact element contains the means for contacting a person or department.
ContactID holds the identifier of the department or employee.ContactName identifies the department or employee name.ContactFunction describes the purpose of the contact.ContactDescription is a free form description field to further explain the purpose of the contact.ListOfContactNumber lists one or more communication points.Content: ContactNumberValue (Type: string) , ContactNumberTypeCoded (Type: ContactNumberTypeCode) , ContactNumberTypeCodedOther (Type: string)?
Description: The ContactNumber element contains the channel and value of a communication point.
ContactNumberValue displays the value of the communication point.ContactNumberTypeCoded identifies the channel of communication using a standard codelist.ContactNumberTypeCodedOther is used to provide a non-standard ContactNumberTypeCode This element is mandatory if the value of ContactNumberTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: ContactFunctionCoded (Type: ContactFunctionCode) , ContactFunctionCodedOther (Type: string)?
Description: The ContactFunction element describes the purpose of the contact.
ContactFunctionCoded identifies the purpose of a contact using a standard codelist.ContactFunctionCodedOther is used to provide a non-standard ContactFuctionCode This element is mandatory if the value of ContactFunctionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
Identifies the channel of communication. This code list is derived from EDIFACT 3155 (Communication number code qualifier) and X12 365 (Communication number qualifier)
Value: Enumeration, including:
Content: Contact+
Description: The ListOfContact element lists the information on one or more contacts for an entity.
Contact is a container for the contact details.Content: ContactNumber+
Description: The ListOfContactNumber element lists one or more communication points.
ContactNumber contains the channel and value of a communication point.Description:
This code identifies the major duty or responsibility of the person or department for contact purposes. This code list is derived from EDIFACT 3139 (Contact function code) and X12 366 (Contact function code)
Value: Enumeration, including:
Content: ContactRelationTypeCoded (Type: ContactRelationTypeCode) , ContactRelationTypeCodedOther (Type: string)?
Description: The ContactRelationType element defines the contact relation type of a contact as primarily always being a 'contact person' to the trading partner organization he/she is assigned to. In addition to that a relationship describes the function of a contact role to the trading partner.
ContactRelationTypeCoded contains coded list to of the types of contact relations.ContactRelationTypeCodedOther is used to provide a non-standard ContactRelationTypeCode. This element is mandatory if the value of ContactRelationTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of the contact relation.
Value: Enumeration, including:
Content: ContractID (Type: Identifier) , ContractType? , ValidityDates?
Description: The Contract element provides the details of an agreement between trading partners.
ContractID is a unique identifier assigned to the contract.ContractType identifies the type of contract.ValidityDates specifies the dates for which the contract is effective.Content: ContractTypeCoded (Type: ContractTypeCode) , ContractTypeCodedOther (Type: string)?
Description: The ContractType element identifies the type of contract.
ContractTypeCoded identifies the type of contract through a standard codelist.ContractTypeCodedOther is used to provide a non-standard ContractTypeCode. This element is mandatory if the value of ContractTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Contract+
Description: The ListOfContract element lists the information on one or more contracts. This includes the identifier and the type of contract.
Contract provides the details of the contract.Description:
This code identifies the type of the contract. This code list is derived from X12 1166 (Contract type code)
Value: Enumeration, including:
Content: CountryCoded (Type: CountryCode) , CountryCodedOther (Type: string)?
Description: The Country element identifies a country.
CountryCoded identifies a country according to ISO standards.CountryCodedOther is used to provide a non-standard CountryCode. This element is mandatory if the value of CountryCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies a country. This code list is derived from ISO 3166-1997
Value: Enumeration, including:
Content: CurrencyCoded (Type: CurrencyCode) , CurrencyCodedOther (Type: string)?
Description: The Currency element identifies a currency.
CurrencyCoded identifies a currency using ISO standards.CurrencyCodedOther is used to provide a non-standard CurrencyCode. This element is mandatory if the value of CurrencyCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of currency being used. This codelist is derived from ISO recommendation no.9
Value: Enumeration, including:
Description:
This code identifies the data type of the AuctionItemAttribute.
Value: Enumeration, including:
Content: Date (Type: datetime) , DateQualifier
Description: The DateCoded element is a container for a date that has its function indicated with a qualifier.
Date contains the actual date.DateQualifier is a container for the code qualifying a date.Content: DateQualifierCoded (Type: DateQualifierCode) , DateQualifierCodedOther (Type: string)?
Description: The DateQualifier element is a container for the code qualifying a date.
DateQualifierCoded identifies the function of a date using a standard codelist.DateQualifierCodedOther is used to provide a non-standard DateQualifierCode. This element is mandatory if the value of DateQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: DateCoded+
Description: The ListOfDateCoded element lists one or more dates that are qualified with a function.
DateCoded is a container for a date that has its function indicated with a qualifier.Content: DateFormatCoded (Type: DateFormatCode) , DateFormatCodedOther (Type: string)?
Description: The DateFormat element supplies the preferred date format that an application should use when displaying this value to the user. It does not describe the format in which the date is sent in the document.
DateFormatCoded supplies a code describing the date format.DateFormatCodedOther is used to provide a non-standard DateFormatCode. This element is mandatory if the value of DateFormatCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Value: Enumeration, including:
Description:
This code identifies the function of a date, time or period. This code list is derived from EDIFACT 2005 (Date or time or period function code qualifier) and X12 374 (Date/Time qualifier)
Value: Enumeration, including:
Description:
This code references to a point in time. This code list is derived from EDIFACT 2475 (Payment time reference code) and X12 333 (Term basis date code)
Value: Enumeration, including:
Content: ShipToLocation (Type: Location)? , ShipFromLocation (Type: Location)? , ListOfScheduleLine? , ItemPackagingReference? , SimplePackageNote (Type: string)? , TermsOfDelivery? , CargoClassification?
Description: The DeliveryDetail element is used to specify the scheduling information for a distinct set of ship from party, ship to party, and transport information for the line item.
ShipToLocation is the location to which the shipments are to be delivered.ShipFromLocation identifies the party from which the item is to be shipped from. This is only used if the ShipFromParty differs from that identified in the header.ListOfScheduleLine is all of the schedule information relevant to the line item for the shipping parties. This may indicate several shipments to the same location over a period of time.ItemPackagingReference contains reference information when detailed packaging information contained in list of package detail is to be associated with the line item.SimplePackageNote is free form text relating to the packaging.TermsOfDelivery includes the information related to delivery including shipment method payment and transport.CargoClassification contains different conventions for the classification and description of the goods being transported.Content: NatureOfGoods (Type: Identifier)? , OperationalTypeCoded (Type: OperationalTypeCode)? , OperationalTypeCodedOther (Type: string)? , TypeOfCargo (Type: string)?
Description: The CargoClassification element contains different conventions for the classification and description of the goods being transported.
NatureOfGoods is the high level nature of goods code issued by a specific maintenance agency. It is generally the first two digits of the HS code. This also defines the maintenance agency for the codelist (usually WCO World Customs Organization).OperationalTypeCoded identifies the classification of the cargo using a standard codelist.OperationalTypeCodedOther is used to provide a non-standard OperationalTypeCode. This element is mandatory if the value of OperationalTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TypeOfCargo is the commodity code that identifies at a high level what the items are. Set of understood description of goods. UN/ECE Rec 21 single digit type of cargo coded. Note; UN/ECE rec 21 is under revision and will need to update to recommendation 29.Description:
This code identifies the classification type of the cargo. This code list is derived from EDIFACT 7085 (Cargo type classification code)
Value: Enumeration, including:
Content: DescriptionText (Type: string) , Language
Description: The Description element is used to provide a free form description with the Language which it is written in.
DescriptionText contains the descriptions in free form text.Language identifies the type of language used to compose the description.Content: Description+
Description: The ListOfDescription element contains a list of descriptions.
Description contains the descriptions in free form text.Description:
This code identifies the type of change to the line item. This code list is derived from EDIFACT 1229 and X12 668 and 670
Value: Enumeration, including:
Description:
This code identifies the response for the line item detail. This code list is derived from EDIFACT 1225 (Message function code), 1229 (Action request/notification description code), and 4343 (Response type code) and X12 353 (Transaction set purpose code), 587 (Acknowledgment type), and 670 (Change or response type code)
Value: Enumeration, including: